datastore

Apr 5, 2024

Changes in this version

+ func ApplyCustomWhere(client ClientInterface, gdb *gorm.DB, conditions map[string]interface{}, ...) (tx *gorm.DB, err error)

+ func GetColumnName(columnName string, model interface{}, gdb *gorm.DB) (string, bool)

Mar 27, 2024

Changes in this version

+ const JSON

+ const JSONB

+ const Postgres

+ const SortAsc

+ const SortDesc

+ var DateFields = []string

+ var ErrDuplicateKey = errors.New("duplicate key")

+ var ErrNoResults = errors.New("no results found")

+ var ErrNoSourceFound = errors.New("no source database found in all given configurations")

+ var ErrNotImplemented = errors.New("not implemented")

+ var ErrUnknownCollection = errors.New("could not determine collection name from model")

+ var ErrUnknownSQL = errors.New("unknown sql implementation")

+ var ErrUnsupportedDriver = errors.New("sql driver unsupported")

+ var ErrUnsupportedEngine = errors.New("unsupported datastore engine")

+ var SQLDatabases = []Engine

+ func GetModelBoolAttribute(model interface{}, attribute string) *bool

+ func GetModelName(model interface{}) *string

+ func GetModelStringAttribute(model interface{}, attribute string) *string

+ func GetModelTableName(model interface{}) *string

+ func GetModelType(model interface{}) reflect.Type

+ func GetModelUnset(model interface{}) map[string]bool

+ func IsModelSlice(model interface{}) bool

+ func IsSQLEngine(e Engine) bool

+ func MarshalQueryParams(m QueryParams) graphql.Marshaler

+ func StringInSlice(a string, list []string) bool

+ type Client struct

+ func (c *Client) AutoMigrateDatabase(ctx context.Context, models ...interface{}) error

+ func (c *Client) Close(ctx context.Context) error

+ func (c *Client) CreateInBatches(ctx context.Context, models interface{}, batchSize int) error

+ func (c *Client) CreateInBatchesMongo(ctx context.Context, models interface{}, batchSize int) error

+ func (c *Client) CustomWhere(tx CustomWhereInterface, conditions map[string]interface{}, engine Engine) interface{}

+ func (c *Client) Debug(on bool)

+ func (c *Client) DebugLog(ctx context.Context, text string)

+ func (c *Client) Engine() Engine

+ func (c *Client) Execute(query string) *gorm.DB

+ func (c *Client) GetArrayFields() []string

+ func (c *Client) GetDatabaseName() string

+ func (c *Client) GetModel(ctx context.Context, model interface{}, conditions map[string]interface{}, ...) error

+ func (c *Client) GetModelCount(ctx context.Context, model interface{}, conditions map[string]interface{}, ...) (int64, error)

+ func (c *Client) GetModels(ctx context.Context, models interface{}, conditions map[string]interface{}, ...) error

+ func (c *Client) GetModelsAggregate(ctx context.Context, models interface{}, conditions map[string]interface{}, ...) (map[string]interface{}, error)

+ func (c *Client) GetMongoCollection(collectionName string) *mongo.Collection

+ func (c *Client) GetMongoCollectionByTableName(tableName string) *mongo.Collection

+ func (c *Client) GetMongoConditionProcessor() func(conditions *map[string]interface{})

+ func (c *Client) GetMongoIndexer() func() map[string][]mongo.IndexModel

+ func (c *Client) GetObjectFields() []string

+ func (c *Client) GetTableName(modelName string) string

+ func (c *Client) HasMigratedModel(modelType string) bool

+ func (c *Client) IncrementModel(ctx context.Context, model interface{}, fieldName string, increment int64) (newValue int64, err error)

+ func (c *Client) IndexExists(tableName, indexName string) (bool, error)

+ func (c *Client) IndexMetadata(tableName, field string) error

+ func (c *Client) IsAutoMigrate() bool

+ func (c *Client) IsDebug() bool

+ func (c *Client) IsNewRelicEnabled() bool

+ func (c *Client) NewRawTx() (*Transaction, error)

+ func (c *Client) NewTx(ctx context.Context, fn func(*Transaction) error) error

+ func (c *Client) Raw(query string) *gorm.DB

+ func (c *Client) SaveModel(ctx context.Context, model interface{}, tx *Transaction, ...) error

+ type ClientInterface interface

+ Close func(ctx context.Context) error

+ Debug func(on bool)

+ DebugLog func(ctx context.Context, text string)

+ Engine func() Engine

+ IsAutoMigrate func() bool

+ IsDebug func() bool

+ IsNewRelicEnabled func() bool

+ func NewClient(ctx context.Context, opts ...ClientOps) (ClientInterface, error)

+ type ClientOps func(c *clientOptions)

+ func WithAutoMigrate(migrateModels ...interface{}) ClientOps

+ func WithCustomFields(arrayFields []string, objectFields []string) ClientOps

+ func WithCustomMongoConditionProcessor(f func(conditions *map[string]interface{})) ClientOps

+ func WithCustomMongoIndexer(f func() map[string][]mongo.IndexModel) ClientOps

+ func WithDebugging() ClientOps

+ func WithLogger(customLogger zLogger.GormLoggerInterface) ClientOps

+ func WithMongo(config *MongoDBConfig) ClientOps

+ func WithMongoConnection(database *mongo.Database, tablePrefix string) ClientOps

+ func WithNewRelic() ClientOps

+ func WithSQL(engine Engine, configs []*SQLConfig) ClientOps

+ func WithSQLConnection(engine Engine, sqlDB *sql.DB, tablePrefix string) ClientOps

+ func WithSQLite(config *SQLiteConfig) ClientOps

+ type CommonConfig struct

+ Debug bool

+ MaxConnectionIdleTime time.Duration

+ MaxConnectionTime time.Duration

+ MaxIdleConnections int

+ MaxOpenConnections int

+ TablePrefix string

+ type CustomWhereInterface interface

+ Where func(query interface{}, args ...interface{})

+ type DatabaseLogWrapper struct

+ func (d *DatabaseLogWrapper) LogMode(level gLogger.LogLevel) gLogger.Interface

+ type Engine string

+ const Empty

+ const MongoDB

+ const MySQL

+ const PostgreSQL

+ const SQLite

+ func (e Engine) IsEmpty() bool

+ func (e Engine) String() string

+ type GetterInterface interface

+ GetArrayFields func() []string

+ GetDatabaseName func() string

+ GetMongoCollection func(collectionName string) *mongo.Collection

+ GetMongoCollectionByTableName func(tableName string) *mongo.Collection

+ GetMongoConditionProcessor func() func(conditions *map[string]interface{})

+ GetMongoIndexer func() func() map[string][]mongo.IndexModel

+ GetObjectFields func() []string

+ GetTableName func(modelName string) string

+ type MongoDBConfig struct

+ DatabaseName string

+ ExistingConnection *mongo.Database

+ Transactions bool

+ URI string

+ type QueryParams struct

+ OrderByField string

+ Page int

+ PageSize int

+ SortDirection string

+ func UnmarshalQueryParams(v interface{}) (QueryParams, error)

+ type SQLConfig struct

+ Driver string

+ ExistingConnection *sql.DB

+ Host string

+ Name string

+ Password string

+ Port string

+ Replica bool

+ SkipInitializeWithVersion bool

+ SslMode string

+ TimeZone string

+ TxTimeout time.Duration

+ User string

+ type SQLiteConfig struct

+ DatabasePath string

+ ExistingConnection gorm.ConnPool

+ Shared bool

+ type StorageService interface

+ AutoMigrateDatabase func(ctx context.Context, models ...interface{}) error

+ CreateInBatches func(ctx context.Context, models interface{}, batchSize int) error

+ CustomWhere func(tx CustomWhereInterface, conditions map[string]interface{}, engine Engine) interface{}

+ Execute func(query string) *gorm.DB

+ GetModel func(ctx context.Context, model interface{}, conditions map[string]interface{}, ...) error

+ GetModelCount func(ctx context.Context, model interface{}, conditions map[string]interface{}, ...) (int64, error)

+ GetModels func(ctx context.Context, models interface{}, conditions map[string]interface{}, ...) error

+ GetModelsAggregate func(ctx context.Context, models interface{}, conditions map[string]interface{}, ...) (map[string]interface{}, error)

+ HasMigratedModel func(modelType string) bool

+ IncrementModel func(ctx context.Context, model interface{}, fieldName string, increment int64) (newValue int64, err error)

+ IndexExists func(tableName, indexName string) (bool, error)

+ IndexMetadata func(tableName, field string) error

+ NewRawTx func() (*Transaction, error)

+ NewTx func(ctx context.Context, fn func(*Transaction) error) error

+ Raw func(query string) *gorm.DB

+ SaveModel func(ctx context.Context, model interface{}, tx *Transaction, ...) error

+ type Transaction struct

+ func (tx *Transaction) CanCommit() bool

+ func (tx *Transaction) Commit() error

+ func (tx *Transaction) Rollback() error