db

Documentation

Index

• type FilterType
• type FilteredRetriever
  • func (r FilteredRetriever) Retrieve(ctx context.Context) ([]string, error)
• type Retriever
• type SystemRetriever
  • func NewSystemRetriever(dsn string) (SystemRetriever, error)
  • func (r SystemRetriever) Retrieve(ctx context.Context) ([]string, error)

Types

type FilterType

type FilterType int

FilterType is used as an enum of filter types

const (
	// ExcludeFilterType ...
	ExcludeFilterType FilterType = iota
	// OnlyFilterType ...
	OnlyFilterType
)

type FilteredRetriever

type FilteredRetriever struct {
	R      Retriever
	Filter FilterType
	DBs    []string
}

FilteredRetriever is a retreiever with filters applied

func (FilteredRetriever) Retrieve

func (r FilteredRetriever) Retrieve(ctx context.Context) ([]string, error)

Retrieve is an isntance of a Retreiver with appllied filters

type Retriever

type Retriever interface {
	Retrieve(context.Context) ([]string, error)
}

Retriever is an interface to a Retriever function

type SystemRetriever

type SystemRetriever struct {
	Dsn string
}

SystemRetriever is an instance of a Retreiver

func NewSystemRetriever

func NewSystemRetriever(dsn string) (SystemRetriever, error)

NewSystemRetriever returns a popualted SystemRetriever

func (SystemRetriever) Retrieve

func (r SystemRetriever) Retrieve(ctx context.Context) ([]string, error)

Retrieve retrieves the list of databases from a DB host.