orm

package module

Go to main page

Versions in this module

v0

v0.3.2

Feb 28, 2026

Changes in this version

+ var OpenPostgres = OpenSQL

type DB

+ func OpenSQL(cfg *ormdb.SQLConfig) (DB, error)

v0.3.1

Feb 25, 2026

v0.3.0

Feb 24, 2026

Changes in this version

+ func CloneFromJSON[T any](data []byte) (*T, error)

+ func GetOrCreate[T any](db DB, id string, defaults func(*T)) (*T, bool, error)

+ func GetOrUpdate[T any](db DB, id string, fn func(*T)) (*T, error)

+ func MustGet[T any](db DB, id string) *T

+ func Zero[T any]() *T

type Model

+ func (m *Model[T]) CreateCtx(ctx context.Context) error

+ func (m *Model[T]) DeleteCtx(ctx context.Context) error

+ func (m *Model[T]) MustCreate()

+ func (m *Model[T]) MustDelete()

+ func (m *Model[T]) MustUpdate()

+ func (m *Model[T]) Namespace() string

+ func (m *Model[T]) PutCtx(ctx context.Context) error

+ func (m *Model[T]) SetNamespace(ns string)

+ func (m *Model[T]) UpdateCtx(ctx context.Context) error

type ModelQuery

+ func (q *ModelQuery[T]) Count(ctx context.Context) (int, error)

+ func (q *ModelQuery[T]) First() (*T, error)

+ func (q *ModelQuery[T]) GetAll(ctx context.Context) ([]*T, error)

v0.2.0

Feb 24, 2026

Changes in this version

type DB

+ func OpenZap(cfg *ormdb.ZapConfig) (DB, error)

v0.1.0

Feb 24, 2026

Changes in this version

+ const CacheKeyPrefix

+ const DefaultEntityTTL

+ const DefaultQueryTTL

+ var ErrAlreadyRegistered = errors.New("orm: kind already registered")

+ var ErrNotFound = errors.New("orm: entity not found")

+ func ApplyDefaults[T any](entity *T)

+ func DeserializeFields(entity interface{}) error

+ func EntityCacheKey(namespace, kind, id string) string

+ func Get[T any](db DB, id string) (*T, error)

+ func HashQuery(queryStr string) string

+ func Kind[T any]() string

+ func Kinds() []string

+ func New[T any](db DB) *T

+ func QueryCacheKey(namespace, kind, queryHash string) string

+ func Register[T any](kind string, opts ...Option[T])

+ func SerializeFields(entity interface{}) error

+ func SetCache(cache CacheLayer)

+ type AfterCreator interface

+ AfterCreate func() error

+ type AfterDeleter interface

+ AfterDelete func() error

+ type AfterUpdater interface

+ AfterUpdate func(prev *T) error

+ type BeforeCreator interface

+ BeforeCreate func() error

+ type BeforeDeleter interface

+ BeforeDelete func() error

+ type BeforeUpdater interface

+ BeforeUpdate func(prev *T) error

+ type CacheConfig struct

+ Enabled bool

+ EntityTTL int

+ QueryTTL int

+ type CacheLayer interface

+ Close func() error

+ GetEntity func(ctx context.Context, kind, id string) ([]byte, bool, error)

+ GetQuery func(ctx context.Context, kind, queryHash string) ([]byte, bool, error)

+ InvalidateEntity func(ctx context.Context, kind, id string) error

+ InvalidateKind func(ctx context.Context, kind string) error

+ SetEntity func(ctx context.Context, kind, id string, data []byte, ttl time.Duration) error

+ SetQuery func(ctx context.Context, kind, queryHash string, data []byte, ttl time.Duration) error

+ func GetCache() CacheLayer

+ type DB interface

+ AllocateIDs func(kind string, parent Key, n int) ([]Key, error)

+ Close func() error

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

+ Get func(ctx context.Context, key Key, dst interface{}) error

+ NewIncompleteKey func(kind string, parent Key) Key

+ NewKey func(kind string, stringID string, intID int64, parent Key) Key

+ Put func(ctx context.Context, key Key, src interface{}) (Key, error)

+ Query func(kind string) Query

+ RunInTransaction func(ctx context.Context, fn func(tx DB) error) error

+ func AdaptDB(d ormdb.DB) DB

+ func OpenSQLite(cfg *ormdb.SQLiteDBConfig) (DB, error)

+ type Defaulter interface

+ Defaults func()

+ type Iterator interface

+ Next func(dst interface{}) (Key, error)

+ type KVCache struct

+ func NewKVCache(cfg KVCacheConfig) (*KVCache, error)

+ func NewKVCacheFromClient(client *kv.Client, prefix string) *KVCache

+ func (c *KVCache) Close() error

+ func (c *KVCache) GetEntity(ctx context.Context, kind, id string) ([]byte, bool, error)

+ func (c *KVCache) GetQuery(ctx context.Context, kind, queryHash string) ([]byte, bool, error)

+ func (c *KVCache) InvalidateEntity(ctx context.Context, kind, id string) error

+ func (c *KVCache) InvalidateKind(ctx context.Context, kind string) error

+ func (c *KVCache) SetEntity(ctx context.Context, kind, id string, data []byte, ttl time.Duration) error

+ func (c *KVCache) SetQuery(ctx context.Context, kind, queryHash string, data []byte, ttl time.Duration) error

+ type KVCacheConfig struct

+ Addr string

+ DB int

+ Password string

+ PoolSize int

+ Prefix string

+ type Key interface

+ Encode func() string

+ IntID func() int64

+ Kind func() string

+ Namespace func() string

+ Parent func() Key

+ StringID func() string

+ type LegacyEntity interface

+ Id func() string

+ JSON func() []byte

+ JSONString func() string

+ type LegacyKind interface

+ Kind func() string

+ type MemoryCache struct

+ func NewMemoryCache(maxSize int) *MemoryCache

+ func (c *MemoryCache) Close() error

+ func (c *MemoryCache) GetEntity(_ context.Context, kind, id string) ([]byte, bool, error)

+ func (c *MemoryCache) GetQuery(_ context.Context, kind, queryHash string) ([]byte, bool, error)

+ func (c *MemoryCache) InvalidateEntity(_ context.Context, kind, id string) error

+ func (c *MemoryCache) InvalidateKind(_ context.Context, kind string) error

+ func (c *MemoryCache) Len() int

+ func (c *MemoryCache) SetEntity(_ context.Context, kind, id string, data []byte, ttl time.Duration) error

+ func (c *MemoryCache) SetQuery(_ context.Context, kind, queryHash string, data []byte, ttl time.Duration) error

+ type Model struct

+ CreatedAt time.Time

+ Deleted bool

+ Id_ string

+ UpdatedAt time.Time

+ func (m *Model[T]) Clone() *T

+ func (m *Model[T]) Create() error

+ func (m *Model[T]) Created() bool

+ func (m *Model[T]) DB() DB

+ func (m *Model[T]) Delete() error

+ func (m *Model[T]) Exists() (bool, error)

+ func (m *Model[T]) Get(key Key) error

+ func (m *Model[T]) GetById(id string) error

+ func (m *Model[T]) Id() string

+ func (m *Model[T]) Init(db DB)

+ func (m *Model[T]) IsMock() bool

+ func (m *Model[T]) JSON() []byte

+ func (m *Model[T]) JSONString() string

+ func (m *Model[T]) Key() Key

+ func (m *Model[T]) Kind() string

+ func (m *Model[T]) Parent() Key

+ func (m *Model[T]) Put() error

+ func (m *Model[T]) Query() *ModelQuery[T]

+ func (m *Model[T]) SetDB(db DB)

+ func (m *Model[T]) SetId(id string)

+ func (m *Model[T]) SetKey(key Key)

+ func (m *Model[T]) SetMock(mock bool)

+ func (m *Model[T]) SetParent(parent Key)

+ func (m *Model[T]) Update() error

+ type ModelMeta struct

+ CacheConfig *CacheConfig

+ Defaults map[string]string

+ DefaultsFn func(interface{})

+ InitFn func(DB, interface{})

+ Kind string

+ ParentFn func(DB) Key

+ Serialized map[string]string

+ StringKey bool

+ Type reflect.Type

+ func Lookup(kind string) (*ModelMeta, bool)

+ func LookupType(typ reflect.Type) (*ModelMeta, bool)

+ func MustLookup(kind string) *ModelMeta

+ type ModelQuery struct

+ func TypedQuery[T any](db DB) *ModelQuery[T]

+ func (q *ModelQuery[T]) Ancestor(key Key) *ModelQuery[T]

+ func (q *ModelQuery[T]) ById(id string) (bool, error)

+ func (q *ModelQuery[T]) Filter(filterStr string, value interface{}) *ModelQuery[T]

+ func (q *ModelQuery[T]) Get() (bool, error)

+ func (q *ModelQuery[T]) IdExists(id string) (Key, bool, error)

+ func (q *ModelQuery[T]) Inner() Query

+ func (q *ModelQuery[T]) KeyExists(key Key) (bool, error)

+ func (q *ModelQuery[T]) Limit(limit int) *ModelQuery[T]

+ func (q *ModelQuery[T]) Offset(offset int) *ModelQuery[T]

+ func (q *ModelQuery[T]) Order(fieldPath string) *ModelQuery[T]

+ type NoopCache struct

+ func (c *NoopCache) Close() error

+ func (c *NoopCache) GetEntity(_ context.Context, _, _ string) ([]byte, bool, error)

+ func (c *NoopCache) GetQuery(_ context.Context, _, _ string) ([]byte, bool, error)

+ func (c *NoopCache) InvalidateEntity(_ context.Context, _, _ string) error

+ func (c *NoopCache) InvalidateKind(_ context.Context, _ string) error

+ func (c *NoopCache) SetEntity(_ context.Context, _, _ string, _ []byte, _ time.Duration) error

+ func (c *NoopCache) SetQuery(_ context.Context, _, _ string, _ []byte, _ time.Duration) error

+ type Option interface

+ func WithCache[T any](cfg CacheConfig) Option[T]

+ func WithDefaults[T any](fn func(*T)) Option[T]

+ func WithInit[T any](fn func(DB, *T)) Option[T]

+ func WithParent[T any](fn func(DB) Key) Option[T]

+ func WithStringKey[T any]() Option[T]

+ type Query interface

+ Ancestor func(ancestor Key) Query

+ ById func(id string, dst interface{}) (Key, bool, error)

+ Count func(ctx context.Context) (int, error)

+ Filter func(filterStr string, value interface{}) Query

+ First func(dst interface{}) (Key, bool, error)

+ GetAll func(ctx context.Context, dst interface{}) ([]Key, error)

+ IdExists func(id string) (Key, bool, error)

+ KeyExists func(key Key) (bool, error)

+ KeysOnly func() Query

+ Limit func(limit int) Query

+ Offset func(offset int) Query

+ Order func(fieldPath string) Query

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