beeorm

package module

Go to main page

Versions in this module

v3

v3.7.4

Feb 27, 2024

v3.7.3

Feb 27, 2024

v3.7.2

Feb 21, 2024

v3.7.1

Feb 19, 2024

Changes in this version

type EntityAnonymousIterator

+ ID func() uint64

+ Index func() int

type EntityIterator

+ func GetByIndex[E any](orm ORM, indexName string, attributes ...any) EntityIterator[E]

+ ID func() uint64

+ Index func() int

+ type ID interface

type IndexSchemaDefinition

+ Duplicated bool

v3.7.0

Jan 18, 2024

Changes in this version

+ type IDGetter interface

+ GetID func() uint64

type Reference

+ func (r Reference[E]) GetID() uint64

v3.6.2

Jan 11, 2024

v3.6.1

Jan 11, 2024

Changes in this version

type LocalCache

+ GetUsage func() []LocalCacheUsage

type LocalCacheConfig

+ GetSchema func() EntitySchema

+ type LocalCacheUsage struct

+ Evictions uint64

+ Limit uint64

+ Type string

+ Used uint64

v3.6.0

Jan 9, 2024

Changes in this version

+ func MustByID[E any](orm ORM, id uint64) *E

v3.5.1

Jan 9, 2024

Changes in this version

type AsyncFlushEvents

+ RedilPool func() string

+ RedisList func() string

type EntityIterator

+ LoadReference func(columns ...string)

v3.5.0

Jan 4, 2024

Changes in this version

+ type BaseWhere struct

+ func (w *BaseWhere) Append(query string, parameters ...any)

+ func (w *BaseWhere) GetParameters() []any

+ func (w *BaseWhere) SetParameter(index int, param any) *BaseWhere

+ func (w *BaseWhere) SetParameters(params ...any) *BaseWhere

+ func (w *BaseWhere) String() string

v3.4.1

Jan 4, 2024

v3.4.0

Jan 3, 2024

Changes in this version

type EntityAnonymousIterator

+ Reset func()

type EntityIterator

+ All func() []*E

+ Reset func()

v3.3.0

Jan 3, 2024

Changes in this version

type EntitySchema

+ Copy func(orm ORM, source any) any

+ DeleteEntity func(orm ORM, entity any)

+ EditEntity func(orm ORM, entity any) any

+ EditEntityField func(orm ORM, entity any, field string, value any) error

v3.2.0

Dec 20, 2023

Changes in this version

type Bind

+ func IsDirty[E any](orm ORM, id uint64) (oldValues, newValues Bind, hasChanges bool)

type Engine

+ NewORM func(parent context.Context) ORM

type EngineRegistry

+ Enums func() map[string][]string

+ type EntityAnonymousIterator interface

+ Entity func() any

+ Len func() int

+ Next func() bool

type EntitySchema

+ GetByID func(orm ORM, id uint64) any

+ IsDirty func(orm ORM, id uint64) (oldValues, newValues Bind, hasChanges bool)

+ NewEntity func(orm ORM) any

+ Search func(orm ORM, where *Where, pager *Pager) EntityAnonymousIterator

+ SearchIDs func(orm ORM, where *Where, pager *Pager) []uint64

+ SearchIDsWithCount func(orm ORM, where *Where, pager *Pager) (results []uint64, totalRows int)

+ SearchWithCount func(orm ORM, where *Where, pager *Pager) (results EntityAnonymousIterator, totalRows int)

+ type ORM interface

+ ClearFlush func()

+ Clone func() ORM

+ CloneWithContext func(context context.Context) ORM

+ Context func() context.Context

+ EnableQueryDebug func()

+ EnableQueryDebugCustom func(mysql, redis, local bool)

+ Engine func() Engine

+ Flush func() error

+ FlushAsync func() error

+ GetMetaData func() Meta

+ RedisPipeLine func(pool string) *RedisPipeLine

+ RegisterQueryLogger func(handler LogHandler, mysql, redis, local bool)

+ SetMetaData func(key, value string)

v3.1.2

Dec 8, 2023

v3.1.1

Dec 7, 2023

Changes in this version

+ func ConsumeAsyncBuffer(c Context, errF func(err error)) (stop func())

+ func EditEntityField[E any](c Context, entity *E, field string, value any) error

v3.1.0

Nov 10, 2023

Changes in this version

type Engine

+ Option func(key string) any

type EngineRegistry

+ Option func(key string) any

+ type EngineSetter interface

+ SetOption func(key string, value any)

+ type EntitySchemaSetter interface

+ SetOption func(key string, value any)

+ type EntitySchemaShared interface

+ GetColumns func() []string

+ GetDB func() DB

+ GetLocalCache func() (cache LocalCache, has bool)

+ GetRedisCache func() (cache RedisCache, has bool)

+ GetTableName func() string

+ GetTag func(field, key, trueValue, defaultValue string) string

+ GetType func() reflect.Type

+ GetUniqueIndexes func() map[string][]string

+ Option func(key string) any

+ type PluginInterfaceEntityFlush interface

+ EntityFlush func(schema EntitySchema, entity reflect.Value, before, after Bind, engine Engine) (PostFlushAction, error)

+ type PluginInterfaceInitRegistryFromYaml interface

+ InitRegistryFromYaml func(registry Registry, yaml map[string]any) error

+ type PluginInterfaceValidateEntitySchema interface

+ ValidateEntitySchema func(schema EntitySchemaSetter) error

+ type PluginInterfaceValidateRegistry interface

+ ValidateRegistry func(engine EngineSetter, registry Registry) error

+ type PostFlushAction func(c Context)

type RedisCache

+ Del func(c Context, keys ...string)

+ HDel func(c Context, key string, keys ...string)

+ HSet func(c Context, key string, values ...any)

+ MSet func(c Context, pairs ...any)

+ Set func(c Context, key string, value any, expiration time.Duration)

type Registry

+ RegisterPlugin func(plugin ...any)

+ SetOption func(key string, value any)

v3.0.0

Nov 3, 2023

Changes in this version

+ const DefaultPoolCode

+ func ConsumeAsyncFlushEvents(c Context, block bool) error

+ func Copy[E any](c Context, source *E) *E

+ func DeleteEntity[E any](c Context, source *E)

+ func EditEntity[E any](c Context, source *E) *E

+ func GetByID[E any](c Context, id uint64) (entity *E)

+ func GetByUniqueIndex[E any](c Context, indexName string, attributes ...any) *E

+ func LoadUniqueKeys(c Context, debug bool)

+ func NewEntity[E any](c Context) *E

+ func SearchIDsWithCount[E any](c Context, where *Where, pager *Pager) (results []uint64, totalRows int)

+ func SearchIDs[E any](c Context, where *Where, pager *Pager) []uint64

+ func SearchOne[E any](c Context, where *Where) *E

+ type Alter struct

+ Pool string

+ SQL string

+ Safe bool

+ func GetAlters(c Context) (alters []Alter)

+ func (a Alter) Exec(c Context)

+ type AsyncFlushEvents interface

+ EntitySchemas func() []EntitySchema

+ Errors func(total int) []FlushEventWithError

+ ErrorsCount func() uint64

+ Events func(total int) []FlushEvent

+ EventsCount func() uint64

+ TrimErrors func(total int)

+ TrimEvents func(total int)

+ func ReadAsyncFlushEvents(c Context) []AsyncFlushEvents

+ type Bind map[string]string

+ func (b Bind) Get(key string) any

+ type BindError struct

+ Field string

+ Message string

+ func (b *BindError) Error() string

+ type ColumnSchemaDefinition struct

+ ColumnName string

+ Definition string

+ type Context interface

+ ClearFlush func()

+ Clone func() Context

+ CloneWithContext func(ctx context.Context) Context

+ Ctx func() context.Context

+ EnableQueryDebug func()

+ EnableQueryDebugCustom func(mysql, redis, local bool)

+ Engine func() Engine

+ Flush func() error

+ FlushAsync func() error

+ GetMetaData func() Meta

+ RedisPipeLine func(pool string) *RedisPipeLine

+ RegisterQueryLogger func(handler LogHandler, mysql, redis, local bool)

+ SetMetaData func(key, value string)

+ func PrepareTables(t *testing.T, registry Registry, entities ...any) (c Context)

+ type DB interface

+ Begin func(c Context) DBTransaction

+ type DBBase interface

+ Exec func(c Context, query string, args ...any) ExecResult

+ GetConfig func() MySQLConfig

+ GetDBClient func() DBClient

+ Prepare func(c Context, query string) (stmt PreparedStmt, close func())

+ Query func(c Context, query string, args ...any) (rows Rows, close func())

+ QueryRow func(c Context, query string, toFill []any, args ...any) (found bool)

+ SetMockDBClient func(mock DBClient)

+ type DBClient interface

+ type DBClientNoTX interface

+ Begin func() (*sql.Tx, error)

+ type DBClientQuery interface

+ Exec func(query string, args ...any) (sql.Result, error)

+ ExecContext func(ctx context.Context, query string, args ...any) (sql.Result, error)

+ Prepare func(query string) (*sql.Stmt, error)

+ Query func(query string, args ...any) (*sql.Rows, error)

+ QueryContext func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryRow func(query string, args ...any) *sql.Row

+ QueryRowContext func(ctx context.Context, query string, args ...any) *sql.Row

+ type DBTransaction interface

+ Commit func(c Context)

+ Rollback func(c Context)

+ type DuplicatedKeyBindError struct

+ Columns []string

+ ID uint64

+ Index string

+ func (d *DuplicatedKeyBindError) Error() string

+ type DuplicatedKeyError struct

+ Index string

+ Message string

+ func (err *DuplicatedKeyError) Error() string

+ type Engine interface

+ DB func(code string) DB

+ LocalCache func(code string) LocalCache

+ NewContext func(parent context.Context) Context

+ Redis func(code string) RedisCache

+ Registry func() EngineRegistry

+ type EngineRegistry interface

+ DBPools func() map[string]DB

+ Entities func() map[string]reflect.Type

+ EntitySchema func(entity any) EntitySchema

+ LocalCachePools func() map[string]LocalCache

+ RedisPools func() map[string]RedisCache

+ type EntityFlush interface

+ ID func() uint64

+ Schema func() *entitySchema

+ type EntityFlushedEvent interface

+ FlushType func() FlushType

+ type EntityIterator interface

+ Entity func() *E

+ Len func() int

+ Next func() bool

+ func GetAll[E any](c Context) EntityIterator[E]

+ func GetByIDs[E any](c Context, ids ...uint64) EntityIterator[E]

+ func GetByReference[E any](c Context, referenceName string, id uint64) EntityIterator[E]

+ func SearchWithCount[E any](c Context, where *Where, pager *Pager) (results EntityIterator[E], totalRows int)

+ func Search[E any](c Context, where *Where, pager *Pager) EntityIterator[E]

+ type EntitySchema interface

+ DisableCache func(local, redis bool)

+ DropTable func(c Context)

+ GetColumns func() []string

+ GetDB func() DB

+ GetLocalCache func() (cache LocalCache, has bool)

+ GetRedisCache func() (cache RedisCache, has bool)

+ GetSchemaChanges func(c Context) (alters []Alter, has bool)

+ GetTableName func() string

+ GetTag func(field, key, trueValue, defaultValue string) string

+ GetType func() reflect.Type

+ GetUniqueIndexes func() map[string][]string

+ TruncateTable func(c Context)

+ UpdateSchema func(c Context)

+ UpdateSchemaAndTruncateTable func(c Context)

+ func GetEntitySchema[E any](c Context) EntitySchema

+ type EnumValues interface

+ EnumValues func() any

+ type ExecResult interface

+ LastInsertId func() uint64

+ RowsAffected func() uint64

+ type FlushEvent struct

+ QueryAttributes []string

+ SQL string

+ type FlushEventWithError struct

+ Error string

+ type FlushType int

+ const Delete

+ const Insert

+ const Update

+ type IndexSchemaDefinition struct

+ Name string

+ Unique bool

+ func (ti *IndexSchemaDefinition) GetColumns() []string

+ func (ti *IndexSchemaDefinition) SetColumns(columns []string)

+ type LocalCache interface

+ Clear func(c Context)

+ Get func(c Context, key string) (value any, ok bool)

+ GetConfig func() LocalCacheConfig

+ GetObjectsCount func() int

+ Remove func(c Context, key string)

+ Set func(c Context, key string, value any)

+ type LocalCacheConfig interface

+ GetCode func() string

+ GetLimit func() int

+ type Lock struct

+ func (l *Lock) Refresh(c Context, ttl time.Duration) bool

+ func (l *Lock) Release(c Context)

+ func (l *Lock) TTL(c Context) time.Duration

+ type Locker struct

+ func (l *Locker) Obtain(c Context, key string, ttl time.Duration, waitTimeout time.Duration) (lock *Lock, obtained bool)

+ type LogEntity struct

+ After []byte

+ Before []byte

+ Date time.Time

+ EntityID uint64

+ ID uint64

+ Meta []byte

+ type LogHandler interface

+ Handle func(c Context, log map[string]any)

+ type Meta map[string]string

+ func (m Meta) Get(key string) string

+ type MockDBClient struct

+ BeginMock func() (*sql.Tx, error)

+ CommitMock func() error

+ ExecContextMock func(context context.Context, query string, args ...any) (sql.Result, error)

+ ExecMock func(query string, args ...any) (sql.Result, error)

+ OriginDB DBClient

+ PrepareMock func(query string) (*sql.Stmt, error)

+ QueryContextMock func(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ QueryMock func(query string, args ...any) (*sql.Rows, error)

+ QueryRowContextMock func(ctx context.Context, query string, args ...any) *sql.Row

+ QueryRowMock func(query string, args ...any) *sql.Row

+ RollbackMock func() error

+ func (m *MockDBClient) Exec(query string, args ...any) (sql.Result, error)

+ func (m *MockDBClient) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)

+ func (m *MockDBClient) Prepare(query string) (*sql.Stmt, error)

+ func (m *MockDBClient) Query(query string, args ...any) (*sql.Rows, error)

+ func (m *MockDBClient) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error)

+ func (m *MockDBClient) QueryRow(query string, args ...any) *sql.Row

+ func (m *MockDBClient) QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row

+ type MockLogHandler struct

+ Logs []map[string]any

+ func (h *MockLogHandler) Clear()

+ func (h *MockLogHandler) Handle(_ Context, log map[string]any)

+ type MySQLConfig interface

+ GetCode func() string

+ GetDataSourceURI func() string

+ GetDatabaseName func() string

+ GetOptions func() *MySQLOptions

+ type MySQLOptions struct

+ ConnMaxLifetime time.Duration

+ DefaultCollate string

+ DefaultEncoding string

+ IgnoredTables []string

+ MaxIdleConnections int

+ MaxOpenConnections int

+ type Pager struct

+ CurrentPage int

+ PageSize int

+ func NewPager(currentPage, pageSize int) *Pager

+ func (pager *Pager) GetCurrentPage() int

+ func (pager *Pager) GetPageSize() int

+ func (pager *Pager) IncrementPage()

+ func (pager *Pager) String() string

+ type PipeLineBool struct

+ func (c *PipeLineBool) Result() bool

+ type PipeLineGet struct

+ func (c *PipeLineGet) Result() (value string, has bool)

+ type PipeLineInt struct

+ func (c *PipeLineInt) Result() int64

+ type PipeLineSlice struct

+ func (c *PipeLineSlice) Result() []string

+ type PipeLineString struct

+ func (c *PipeLineString) Result() string

+ type PreparedStmt interface

+ Close func() error

+ Exec func(c Context, args ...any) ExecResult

+ Query func(c Context, args ...any) (rows Rows, close func())

+ QueryRow func(c Context, args []any, toFill ...any) (found bool)

+ type QueryLoggerSource int

+ type RedisCache interface

+ BLMove func(c Context, source, destination, srcPos, destPos string, timeout time.Duration) string

+ Eval func(c Context, script string, keys []string, args ...any) any

+ EvalSha func(c Context, sha1 string, keys []string, args ...any) (res any, exists bool)

+ Exists func(c Context, keys ...string) int64

+ Expire func(c Context, key string, expiration time.Duration) bool

+ FlushAll func(c Context)

+ FlushDB func(c Context)

+ Get func(c Context, key string) (value string, has bool)

+ GetCode func() string

+ GetConfig func() RedisPoolConfig

+ GetLocker func() *Locker

+ GetSet func(c Context, key string, expiration time.Duration, provider func() any) any

+ HGet func(c Context, key, field string) (value string, has bool)

+ HGetAll func(c Context, key string) map[string]string

+ HIncrBy func(c Context, key, field string, incr int64) int64

+ HLen func(c Context, key string) int64

+ HMGet func(c Context, key string, fields ...string) map[string]any

+ HSetNx func(c Context, key, field string, value any) bool

+ Incr func(c Context, key string) int64

+ IncrBy func(c Context, key string, incr int64) int64

+ IncrWithExpire func(c Context, key string, expire time.Duration) int64

+ Info func(c Context, section ...string) string

+ LLen func(c Context, key string) int64

+ LMove func(c Context, source, destination, srcPos, destPos string) string

+ LPop func(c Context, key string) string

+ LPush func(c Context, key string, values ...any) int64

+ LRange func(c Context, key string, start, stop int64) []string

+ LRem func(c Context, key string, count int64, value any)

+ LSet func(c Context, key string, index int64, value any)

+ Ltrim func(c Context, key string, start, stop int64)

+ MGet func(c Context, keys ...string) []any

+ Process func(c Context, cmd redis.Cmder) error

+ RPop func(c Context, key string) (value string, found bool)

+ RPush func(c Context, key string, values ...any) int64

+ SAdd func(c Context, key string, members ...any) int64

+ SCard func(c Context, key string) int64

+ SIsMember func(c Context, key string, member any) bool

+ SMembers func(c Context, key string) []string

+ SPop func(c Context, key string) (string, bool)

+ SPopN func(c Context, key string, max int64) []string

+ ScriptExists func(c Context, sha1 string) bool

+ ScriptLoad func(c Context, script string) string

+ SetNX func(c Context, key string, value any, expiration time.Duration) bool

+ Type func(c Context, key string) string

+ XAck func(c Context, stream, group string, ids ...string) int64

+ XClaim func(c Context, a *redis.XClaimArgs) []redis.XMessage

+ XClaimJustID func(c Context, a *redis.XClaimArgs) []string

+ XDel func(c Context, stream string, ids ...string) int64

+ XGroupCreate func(c Context, stream, group, start string) (key string, exists bool)

+ XGroupCreateMkStream func(c Context, stream, group, start string) (key string, exists bool)

+ XGroupDelConsumer func(c Context, stream, group, consumer string) int64

+ XGroupDestroy func(c Context, stream, group string) int64

+ XInfoGroups func(c Context, stream string) []redis.XInfoGroup

+ XInfoStream func(c Context, stream string) *redis.XInfoStream

+ XLen func(c Context, stream string) int64

+ XPending func(c Context, stream, group string) *redis.XPending

+ XPendingExt func(c Context, a *redis.XPendingExtArgs) []redis.XPendingExt

+ XRange func(c Context, stream, start, stop string, count int64) []redis.XMessage

+ XRead func(c Context, a *redis.XReadArgs) []redis.XStream

+ XReadGroup func(c Context, a *redis.XReadGroupArgs) (streams []redis.XStream)

+ XRevRange func(c Context, stream, start, stop string, count int64) []redis.XMessage

+ XTrim func(c Context, stream string, maxLen int64) (deleted int64)

+ ZAdd func(c Context, key string, members ...redis.Z) int64

+ ZCard func(c Context, key string) int64

+ ZCount func(c Context, key string, min, max string) int64

+ ZRangeWithScores func(c Context, key string, start, stop int64) []redis.Z

+ ZRevRange func(c Context, key string, start, stop int64) []string

+ ZRevRangeWithScores func(c Context, key string, start, stop int64) []redis.Z

+ ZScore func(c Context, key, member string) float64

+ type RedisCacheSetter interface

+ Del func(c Context, keys ...string)

+ HDel func(c Context, key string, keys ...string)

+ HSet func(c Context, key string, values ...any)

+ MSet func(c Context, pairs ...any)

+ Set func(c Context, key string, value any, expiration time.Duration)

+ type RedisOptions struct

+ Master string

+ Password string

+ SentinelOptions *redis.FailoverOptions

+ Sentinels []string

+ User string

+ type RedisPipeLine struct

+ func (rp *RedisPipeLine) Del(key ...string)

+ func (rp *RedisPipeLine) Exec(c Context)

+ func (rp *RedisPipeLine) Expire(key string, expiration time.Duration) *PipeLineBool

+ func (rp *RedisPipeLine) Get(key string) *PipeLineGet

+ func (rp *RedisPipeLine) HDel(key string, values ...string)

+ func (rp *RedisPipeLine) HIncrBy(key, field string, incr int64) *PipeLineInt

+ func (rp *RedisPipeLine) HSet(key string, values ...any)

+ func (rp *RedisPipeLine) LPush(key string, values ...any)

+ func (rp *RedisPipeLine) LRange(key string, start, stop int64) *PipeLineSlice

+ func (rp *RedisPipeLine) LSet(key string, index int64, value any)

+ func (rp *RedisPipeLine) MSet(pairs ...any)

+ func (rp *RedisPipeLine) RPush(key string, values ...any)

+ func (rp *RedisPipeLine) SAdd(key string, members ...any)

+ func (rp *RedisPipeLine) SRem(key string, members ...any)

+ func (rp *RedisPipeLine) Set(key string, value any, expiration time.Duration)

+ func (rp *RedisPipeLine) XAdd(stream string, values []string) *PipeLineString

+ type RedisPoolConfig interface

+ GetAddress func() string

+ GetCode func() string

+ GetDatabaseNumber func() int

+ type Reference struct

+ ID uint64

+ func (r *Reference[E]) GetEntity(c Context) *E

+ type Registry interface

+ InitByYaml func(yaml map[string]any) error

+ RegisterEntity func(entity ...any)

+ RegisterLocalCache func(code string, limit int)

+ RegisterMySQL func(dataSourceName string, poolCode string, poolOptions *MySQLOptions)

+ RegisterRedis func(address string, db int, poolCode string, options *RedisOptions)

+ Validate func() (Engine, error)

+ func NewRegistry() Registry

+ type Rows interface

+ Columns func() []string

+ Next func() bool

+ Scan func(dest ...any)

+ type SQLRow interface

+ Scan func(dest ...any) error

+ type SQLRows interface

+ Close func() error

+ Columns func() ([]string, error)

+ Err func() error

+ Next func() bool

+ Scan func(dest ...any) error

+ type TXClient interface

+ type TableSQLSchemaDefinition struct

+ DBCreateSchema string

+ DBEncoding string

+ DBIndexes []*IndexSchemaDefinition

+ DBTableColumns []*ColumnSchemaDefinition

+ Engine string

+ EntityColumns []*ColumnSchemaDefinition

+ EntityIndexes []*IndexSchemaDefinition

+ EntitySchema EntitySchema

+ PostAlters []Alter

+ PreAlters []Alter

+ func (td *TableSQLSchemaDefinition) CreateTableSQL() string

+ type Where struct

+ func NewWhere(query string, parameters ...any) *Where

+ func (where *Where) Append(query string, parameters ...any)

+ func (where *Where) GetParameters() []any

+ func (where *Where) SetParameter(index int, param any) *Where

+ func (where *Where) SetParameters(params ...any) *Where

+ func (where *Where) String() string

Other modules containing this package

github.com/latolukasz/beeorm

github.com/latolukasz/beeorm/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL