thing

Jan 5, 2026

Changes in this version

+ func GetCacheVersion() int64

Jun 4, 2025

Changes in this version

type CacheClient

+ Expire func(ctx context.Context, key string, expiration time.Duration) error

+ Incr func(ctx context.Context, key string) (int64, error)

+ type ChannelLock struct

+ func NewChannelLock() *ChannelLock

Jun 2, 2025

Changes in this version

type CacheClient

+ func Cache() CacheClient

May 25, 2025

Changes in this version

+ var AllowDropColumn = false

May 5, 2025

Changes in this version

type Thing

+ func (t *Thing[T]) All() ([]T, error)

May 5, 2025

Changes in this version

type CachedResult

+ Err error

+ func (cr *CachedResult[T]) Order(order string) *CachedResult[T]

+ func (cr *CachedResult[T]) Preload(preloads ...string) *CachedResult[T]

+ func (cr *CachedResult[T]) Where(where string, args ...interface{}) *CachedResult[T]

type JSONOptions

+ NestedRules map[string]*JSONOptions

type Thing

+ func (t *Thing[T]) Order(order string) *CachedResult[T]

+ func (t *Thing[T]) Preload(preloads ...string) *CachedResult[T]

+ func (t *Thing[T]) Where(where string, args ...interface{}) *CachedResult[T]

May 4, 2025

Changes in this version

+ const ByIDBatchSize

+ const LockDuration

+ const LockMaxRetries

+ const LockRetryDelay

+ func AutoMigrate(models ...interface{}) error

+ func Configure(args ...interface{}) error

+ func ConfigureWithConfig(cfg Config) error

+ func GenerateCacheKey(prefix, tableName string, params QueryParams) string

+ func GenerateMigrationSQL(models ...interface{}) ([]string, error)

+ func GenerateQueryHash(params QueryParams) string

+ func NewThingByType(modelType reflect.Type, db DBAdapter, cache CacheClient) (interface{}, error)

+ func RegisterIntrospectorFactory(dialect string, factory IntrospectorFactory)

+ func RegisterListener(eventType EventType, listener EventListener)

+ func ResetListeners()

+ func UnregisterListener(eventType EventType, listenerToRemove EventListener)

+ func WithLock(ctx context.Context, cache CacheClient, lockKey string, ...) error

+ type BaseModel struct

+ CreatedAt time.Time

+ Deleted bool

+ ID int64

+ UpdatedAt time.Time

+ func (b *BaseModel) IsNewRecord() bool

+ func (b *BaseModel) SetID(id int64)

+ func (b *BaseModel) SetNewRecordFlag(isNew bool)

+ func (b BaseModel) GetID() int64

+ func (b BaseModel) KeepItem() bool

+ func (b BaseModel) TableName() string

+ type CacheClient interface

+ AcquireLock func(ctx context.Context, lockKey string, expiration time.Duration) (bool, error)

+ Delete func(ctx context.Context, key string) error

+ DeleteModel func(ctx context.Context, key string) error

+ DeleteQueryIDs func(ctx context.Context, queryKey string) error

+ Get func(ctx context.Context, key string) (string, error)

+ GetCacheStats func(ctx context.Context) CacheStats

+ GetModel func(ctx context.Context, key string, dest interface{}) error

+ GetQueryIDs func(ctx context.Context, queryKey string) ([]int64, error)

+ ReleaseLock func(ctx context.Context, lockKey string) error

+ Set func(ctx context.Context, key string, value string, expiration time.Duration) error

+ SetModel func(ctx context.Context, key string, model interface{}, expiration time.Duration) error

+ SetQueryIDs func(ctx context.Context, queryKey string, ids []int64, expiration time.Duration) error

+ var DefaultLocalCache CacheClient = &localCache{}

+ type CacheKeyLockManagerInternal struct

+ func NewCacheKeyLockManagerInternal() *CacheKeyLockManagerInternal

+ func (m *CacheKeyLockManagerInternal) Lock(key string)

+ func (m *CacheKeyLockManagerInternal) Unlock(key string)

+ type CacheStats struct

+ Counters map[string]int

+ type CachedResult struct

+ func (cr *CachedResult[T]) All() ([]T, error)

+ func (cr *CachedResult[T]) Count() (int64, error)

+ func (cr *CachedResult[T]) Fetch(offset, limit int) ([]T, error)

+ func (cr *CachedResult[T]) First() (T, error)

+ func (cr *CachedResult[T]) WithDeleted() *CachedResult[T]

+ type Config struct

+ Cache CacheClient

+ DB DBAdapter

+ TTL time.Duration

+ type DBAdapter interface

+ BeginTx func(ctx context.Context, opts *sql.TxOptions) (Tx, error)

+ Builder func() SQLBuilder

+ Close func() error

+ DB func() *sql.DB

+ DialectName func() string

+ Exec func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ Get func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ GetCount func(ctx context.Context, tableName string, where string, args []interface{}) (int64, error)

+ Select func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ func GlobalDB() DBAdapter

+ type Dialector interface

+ Placeholder func(index int) string

+ Quote func(identifier string) string

+ type EventListener func(ctx context.Context, eventType EventType, model interface{}, ...) error

+ type EventType string

+ const EventTypeAfterCreate

+ const EventTypeAfterDelete

+ const EventTypeAfterSave

+ const EventTypeAfterSoftDelete

+ const EventTypeBeforeCreate

+ const EventTypeBeforeDelete

+ const EventTypeBeforeSave

+ const EventTypeBeforeSoftDelete

+ type FieldRule struct

+ Name string

+ Nested *JSONOptions

+ type IntrospectorFactory func(DBAdapter) schema.Introspector

+ type JSONOption func(*JSONOptions)

+ func Exclude(fields ...string) JSONOption

+ func Include(fields ...string) JSONOption

+ func WithFields(dsl string) JSONOption

+ type JSONOptions struct

+ OrderedExclude []string

+ OrderedInclude []*FieldRule

+ func ParseFieldsDSL(dsl string) (*JSONOptions, error)

+ type Model interface

+ GetID func() int64

+ KeepItem func() bool

+ type QueryParams struct

+ Args []interface{}

+ IncludeDeleted bool

+ Order string

+ Preloads []string

+ Where string

+ type RelationshipOpts struct

+ ForeignKey string

+ JoinLocalKey string

+ JoinRelatedKey string

+ JoinTable string

+ LocalKey string

+ RelatedModel string

+ RelationType string

+ type SQLBuilder interface

+ BuildCountSQL func(tableName string, whereClause string) string

+ BuildDeleteSQL func(tableName, pkName string) string

+ BuildInsertSQL func(tableName string, columns []string) string

+ BuildSelectIDsSQL func(tableName string, pkName string, where string, args []interface{}, ...) (string, []interface{})

+ BuildSelectSQL func(tableName string, columns []string) string

+ BuildUpdateSQL func(tableName string, setClauses []string, pkName string) string

+ Rebind func(query string) string

+ func NewSQLBuilder(d Dialector) SQLBuilder

+ type Thing struct

+ func New[T Model](db DBAdapter, cache CacheClient) (*Thing[T], error)

+ func Use[T Model]() (*Thing[T], error)

+ func (t *Thing[T]) ByID(id int64) (T, error)

+ func (t *Thing[T]) ByIDs(ids []int64, preloads ...string) (map[int64]T, error)

+ func (t *Thing[T]) Cache() CacheClient

+ func (t *Thing[T]) CacheStats(ctx context.Context) CacheStats

+ func (t *Thing[T]) ClearCacheByID(ctx context.Context, id int64) error

+ func (t *Thing[T]) DB() *sql.DB

+ func (t *Thing[T]) Delete(value T) error

+ func (t *Thing[T]) Load(model T, relations ...string) error

+ func (t *Thing[T]) Query(params QueryParams) (*CachedResult[T], error)

+ func (t *Thing[T]) Save(value T) error

+ func (t *Thing[T]) SoftDelete(value T) error

+ func (t *Thing[T]) ToJSON(model T, opts ...JSONOption) ([]byte, error)

+ func (t *Thing[T]) WithContext(ctx context.Context) *Thing[T]

+ type Tx interface

+ Commit func() error

+ Exec func(ctx context.Context, query string, args ...interface{}) (sql.Result, error)

+ Get func(ctx context.Context, dest interface{}, query string, args ...interface{}) error

+ Rollback func() error

+ Select func(ctx context.Context, dest interface{}, query string, args ...interface{}) error