dbgraph

Documentation

Index

• func Get(ctx context.Context) (db.Provider, error)
• func GetEnity(ctx context.Context, enityName string) (interface{}, error)
• func Registrate(ctx context.Context) (context.Context, error)
• func RegistrateEnity(ctx context.Context, enityName string, options interface{}) (context.Context, error)
• type Config
  • func (c *Config) SetDefault() *Config
• type Enity
  • func GetEnityTypeCast(ctx context.Context, enityName string) (*Enity, error)
  • func NewEnity(ctx context.Context, name string, cfg interface{}) (*Enity, error)
  • func (c *Enity) GetMetrics(prefix string) stats.MapMetricsOptions
  • func (c *Enity) GetReadyHandlers(prefix string) stats.MapCheckFunc
  • func (c *Enity) Shutdown() error
  • func (c *Enity) Start() error
  • func (c *Enity) WaitForEstablishing()
• type Provider
  • func NewProvider(ctx context.Context) *Provider
  • func (p *Provider) CreateEnity(enityName string, options interface{}) error
  • func (p *Provider) GetEnity(connectionName string) (interface{}, error)

Functions

func Get

func Get(ctx context.Context) (db.Provider, error)

func GetEnity

func GetEnity(ctx context.Context, enityName string) (interface{}, error)

func Registrate

func Registrate(ctx context.Context) (context.Context, error)

func RegistrateEnity

func RegistrateEnity(ctx context.Context, enityName string, options interface{}) (context.Context, error)

Types

type Config

type Config struct {
	// DSN is a connection string in form of DSN. Example:
	// host:port.
	// Default: "localhost:9080"
	DSN string `envconfig:"optional"`
	// StartWatcher indicates to connection controller that it should
	// also start asynchronous connection watcher.
	StartWatcher bool `envconfig:"optional"`
	// Timeout is a timeout in seconds for connection checking. Every
	// this count of seconds database connection will be checked for
	// aliveness and, if it dies, attempt to reestablish connection
	// will be made. Default timeout is 10 seconds.
	Timeout time.Duration `envconfig:"optional"`
}

Config represents configuration structure for every connection.

func (*Config) SetDefault

func (c *Config) SetDefault() *Config

SetDefault checks connection config. If required field is empty - it will be filled with some default value. Returns a copy of config.

type Enity

type Enity struct {
	// Metrics
	stats.Service
	// DB connection
	Conn *dgo.Dgraph
	// contains filtered or unexported fields
}

Enity is a connection controlling structure. It controls connection, asynchronous queue and everything that related to specified connection.

func GetEnityTypeCast

func GetEnityTypeCast(ctx context.Context, enityName string) (*Enity, error)

func NewEnity

func NewEnity(ctx context.Context, name string, cfg interface{}) (*Enity, error)

NewEnity create new enity.

func (*Enity) GetMetrics

func (c *Enity) GetMetrics(prefix string) stats.MapMetricsOptions

GetMetrics return map of the metrics from database connection

func (*Enity) GetReadyHandlers

func (c *Enity) GetReadyHandlers(prefix string) stats.MapCheckFunc

GetReadyHandlers return array of the readyHandlers from database connection

func (*Enity) Shutdown

func (c *Enity) Shutdown() error

Shutdown shutdowns queue worker and connection watcher. Later will also close connection to database. This is a blocking call.

func (*Enity) Start

func (c *Enity) Start() error

Start starts connection workers and connection procedure itself.

func (*Enity) WaitForEstablishing

func (c *Enity) WaitForEstablishing()

WaitForEstablishing will block execution until connection will be successfully established and database migrations will be applied (or rolled back).

type Provider

type Provider struct {
	*providerwithmetrics.Provider
}

Provider for database mongo

func NewProvider

func NewProvider(ctx context.Context) *Provider

NewProvider creates new provider.

func (*Provider) CreateEnity

func (p *Provider) CreateEnity(enityName string, options interface{}) error

CreateEnity should create enity using passed parameters.

func (*Provider) GetEnity

func (p *Provider) GetEnity(connectionName string) (interface{}, error)

GetEnity should return pointer to connection structure to caller.