mongo

Documentation

Index

• Constants
• Variables
• func Migrate(ctx context.Context, db string, version string, client *mongo.Client, ...) error
• func NewClient(ctx context.Context, c config.Reader) (*mongo.Client, error)
• func NewDataStoreWithClient(client *mongo.Client, conf ...*Config) store.DataStore
• func SetupDataStore(conf *Config) (store.DataStore, error)
• type Config
  • func NewConfig() *Config
  • func (c *Config) SetAutomigrate(migrate bool) *Config
• type DataStoreMongo
  • func (db *DataStoreMongo) Close() error
  • func (db *DataStoreMongo) GetSettings(ctx context.Context) (model.Settings, error)
  • func (db *DataStoreMongo) Ping(ctx context.Context) error
  • func (db *DataStoreMongo) SetSettings(ctx context.Context, settings model.Settings) error

Constants

const (
	CollNameSettings = "settings"
	KeyTenantID      = "tenant_id"

	ConnectTimeoutSeconds = 10
)

const (
	// DbVersion is the current schema version
	DbVersion = "1.0.0"

	// DbName is the database name
	DbName = "azure_iot_manager"
)

const (
	IndexNameSettingsGet = "settings get"
)

Variables

var (
	ErrFailedToGetSettings = errors.New("Failed to get settings")
)

Functions

func Migrate

func Migrate(ctx context.Context,
	db string,
	version string,
	client *mongo.Client,
	automigrate bool) error

Migrate applies migrations to the database

func NewClient

func NewClient(ctx context.Context, c config.Reader) (*mongo.Client, error)

NewClient returns a mongo client

func NewDataStoreWithClient

func NewDataStoreWithClient(client *mongo.Client, conf ...*Config) store.DataStore

NewDataStoreWithClient initializes a DataStore object

func SetupDataStore

func SetupDataStore(conf *Config) (store.DataStore, error)

SetupDataStore returns the mongo data store and optionally runs migrations

Types

type Config

type Config struct {
	Automigrate *bool
}

func NewConfig

func NewConfig() *Config

func (*Config) SetAutomigrate

func (c *Config) SetAutomigrate(migrate bool) *Config

type DataStoreMongo

type DataStoreMongo struct {
	*Config
	// contains filtered or unexported fields
}

DataStoreMongo is the data storage service

func (*DataStoreMongo) Close

func (db *DataStoreMongo) Close() error

func (*DataStoreMongo) GetSettings

func (db *DataStoreMongo) GetSettings(ctx context.Context) (model.Settings, error)

func (*DataStoreMongo) Ping

func (db *DataStoreMongo) Ping(ctx context.Context) error

Ping verifies the connection to the database

func (*DataStoreMongo) SetSettings

func (db *DataStoreMongo) SetSettings(ctx context.Context, settings model.Settings) error