reader

type ConnOpts struct {
	// DSN is the connection address.
	DSN string
	// Timeout is the timeout for read operations.
	Timeout time.Duration
	// MaxConnLifetime is the maximum amount of time a connection may be reused on the read database.
	MaxConnLifetime time.Duration
	// MaxConns is the maximum number of open connections to the read database.
	MaxConns int
	// MaxIdleConns is the maximum number of connections in the idle connection pool for the read database.
	MaxIdleConns int
}

type Driver interface {
	// IsSupported checks if the driver is supported.
	IsSupported(string) bool
	// NewConnection takes the connection options and returns a new Reader.
	NewConnection(ConnOpts) (Reader, error)
}

type ReadTableOpt struct {
	// Columns contains the (quoted) column of the table
	Columns []string
	// Match is a condition field to dump only certain amount data
	Match string
	// Sort the results
	Sorts map[string]string
	// Limit defines a limit of results to be fetched
	Limit uint64
	// Relationships defines an slice of relationship definitions
	Relationships []*RelationshipOpt
}

type Reader interface {
	// GetStructure returns the SQL used to create the database tables
	GetStructure() (string, error)
	// GetTables returns a list of all databases tables
	GetTables() ([]string, error)
	// GetColumns return a list of all columns for a given table
	GetColumns(string) ([]string, error)
	// FormatColumn returns a escaped table.column string
	FormatColumn(tableName string, columnName string) string
	// ReadTable returns a channel with all database rows
	ReadTable(string, chan<- database.Row, ReadTableOpt, config.Matchers) error
	// Close closes the reader resources and releases them.
	Close() error
}

type RelationshipOpt struct {
	// Table is the table name.
	Table string
	// ForeignKey is the table name foreign key.
	ForeignKey string
	// ReferencedTable is the referenced table name.
	ReferencedTable string
	// ReferencedKey is the referenced table primary key name.
	ReferencedKey string
}