repository

type Closer interface {
	Close(ctx context.Context) error
}

type Dialer interface {
	Dial(ctx context.Context) error
}

type Exister interface {
	Exists(context.Context, *query.Scope) (bool, error)
}

type HealthChecker interface {
	// HealthCheck defines the health status of the repository.
	HealthCheck(ctx context.Context) (*HealthResponse, error)
}

type HealthResponse struct {
	Status HealthStatus
	Output string
	Notes  []string
}

type HealthStatus int

type Migrator interface {
	MigrateModels(ctx context.Context, models ...*mapping.ModelStruct) error
}

type ModelRegistrar interface {
	// RegisterModels registers provided 'models' into Repository specific mappings.
	RegisterModels(models ...*mapping.ModelStruct) error
}

type Option func(o *Options)

type Options struct {
	// URI is the uri with the full connection credentials for the repository.
	URI string
	// Host defines the access hostname or the ip address
	Host string
	// Port is the connection port
	Port uint16
	// Database
	Database string
	// Protocol is the protocol used in the connection
	Protocol string
	// Username is the username used to get connection credential
	Username string
	// Password is the password used to get connection credentials
	Password string
	// MaxTimeout defines the maximum timeout for the given repository connection
	MaxTimeout *time.Duration
	// TLS defines the tls configuration for given repository.
	TLSConfig *tls.Config
}

type Repository interface {
	// ID gets the repository unique identification.
	ID() string
	// Count counts the models for the provided query scope.
	Count(ctx context.Context, s *query.Scope) (int64, error)
	// Insert inserts models provided in the scope with provided field set.
	Insert(ctx context.Context, s *query.Scope) error
	// Find finds the models for provided query scope.
	Find(ctx context.Context, s *query.Scope) error
	// Update updates the query using a single model that  affects multiple database rows/entries.
	Update(ctx context.Context, s *query.Scope) (int64, error)
	// UpdateModels updates the models for provided query scope.
	UpdateModels(ctx context.Context, s *query.Scope) (int64, error)
	// Delete deletes the models defined by provided query scope.
	Delete(ctx context.Context, s *query.Scope) (int64, error)
}

type Runner interface {
	Run(ctx context.Context) error
}

type Savepointer interface {
	Savepoint(ctx context.Context, tx *query.Transaction, name string) error
	RollbackSavepoint(ctx context.Context, tx *query.Transaction, name string) error
}

type Transactioner interface {
	ID() string
	// Begin the scope's transaction.
	Begin(ctx context.Context, tx *query.Transaction) error
	// Commit the scope's transaction.
	Commit(ctx context.Context, tx *query.Transaction) error
	// Rollback the scope's transaction.
	Rollback(ctx context.Context, tx *query.Transaction) error
}

type Upserter interface {
	Upsert(ctx context.Context, s *query.Scope) error
}