repository

Documentation

Overview

Package repository is the package that defines neuron repositories and it's factories. A repository is a structure that gives an access with well known interfaces to the models databases, data stores. A factory is the structure with unique name that is responsible of creating new repository instances of given type. The package is used to register, get and close (finish) factory.

Index

• Variables
• type Exister
• type HealthChecker
• type HealthResponse
• type HealthStatus
  • func (s HealthStatus) MarshalText() ([]byte, error)
  • func (s HealthStatus) String() string
• type Migrator
• type ModelRegistrar
• type Option
  • func WithDatabase(db string) Option
  • func WithHost(host string) Option
  • func WithMaxTimeout(maxTimeout time.Duration) Option
  • func WithPassword(password string) Option
  • func WithPort(port int) Option
  • func WithProtocol(proto string) Option
  • func WithTLSConfig(tlsConfig *tls.Config) Option
  • func WithURI(uri string) Option
  • func WithUsername(username string) Option
• type Options
• type Repository
• type Runner
• type Savepointer
• type Transactioner
• type Upserter

Variables

var (
	// ErrRepository is the major error repository classification.
	ErrRepository = errors.New("repository")
	// ErrNotImplements is the error classification for the repositories that doesn't implement some interface.
	ErrNotImplements = errors.Wrap(ErrRepository, "not implements")
	// ErrConnection is the error classification related with repository connection.
	ErrConnection = errors.Wrap(ErrRepository, "connection")
	// ErrAuthorization is the error classification related with repository authorization.
	ErrAuthorization = errors.Wrap(ErrRepository, "authorization")
	// ErrReservedName is the error classification related with using reserved name.
	ErrReservedName = errors.Wrap(ErrRepository, "reserved name")
)

Types

type Exister

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

Exister is the interface used to check if given query object exists.

type HealthChecker

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

HealthChecker is the interface used to check the repository health.

type HealthResponse

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

HealthResponse is the response for the health check.

type HealthStatus

type HealthStatus int

HealthStatus is the status of the health check

const (
	// StatusPass defines healthy status
	StatusPass HealthStatus = iota
	// StatusFail defines unhealthy result
	StatusFail
	// StatusWarn defines
	StatusWarn
)

enum values for the health statuses

func (HealthStatus) MarshalText

func (s HealthStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler interface.

func (HealthStatus) String

func (s HealthStatus) String() string

type Migrator

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

Migrator migrates the models into the repository.

type ModelRegistrar

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

ModelRegistrar is the interface used to register the models in the repository.

type Option

type Option func(o *Options)

Option is a function that changes the repository options.

func WithDatabase

func WithDatabase(db string) Option

WithDatabase is an option that sets the Database in the repository options.

func WithHost

func WithHost(host string) Option

WithHost sets the options hostname.

func WithMaxTimeout

func WithMaxTimeout(maxTimeout time.Duration) Option

WithMaxTimeout is an option that sets the MaxTimeout in the repository options.

func WithPassword

func WithPassword(password string) Option

WithPassword is an option that sets the Password in the repository options.

func WithPort

func WithPort(port int) Option

WithPort is an option that sets the Port in the repository options.

func WithProtocol

func WithProtocol(proto string) Option

WithProtocol is an option that sets the Protocol in the repository options.

func WithTLSConfig

func WithTLSConfig(tlsConfig *tls.Config) Option

WithTLSConfig is an option that sets the TLSConfig in the repository options.

func WithURI

func WithURI(uri string) Option

WithURI is an option that sets repository connection URI.

func WithUsername

func WithUsername(username string) Option

WithUsername is an option that sets the Username in the repository options.

type 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
}

Options is the common structure used as the options for the repositories.

type Repository

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)
}

Repository is the interface used to execute the queries.

type Runner

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

Runner is the interface for the services that are runnable.

type Savepointer

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

Savepointer is an interface that allows using transaction savepoints for repositories.

type Transactioner

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
}

Transactioner is the interface used for the transactions.

type Upserter

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

Upserter is the repository interface that inserts or update on integration error given query values.