orm

package module

Go to main page

Versions in this module

v1

v1.0.3

Nov 7, 2026

Changes in this version

type NatsConsumerSettings

+ Stream string

v1.0.2

Nov 7, 2026

Changes in this version

type ClickhouseOptions

+ Replicated bool

type ConfigClickhouse

+ Replicated bool

v1.0.1

Oct 26, 2026

Changes in this version

+ func ScanIDs(rows Rows, ids []uint64) ([]uint64, error)

type DBQuery

+ func (q *DBQuery) PageSize() int

+ func (q *DBQuery) WriteSelect(b *strings.Builder, prefix string, ...) []any

type MySQLOptions

+ ServerSidePreparedStatements bool

v1.0.0

Oct 26, 2026

Changes in this version

+ const CDCOutboxDispatched

+ const CDCOutboxPending

+ const CDCOutboxStored

+ const DefaultPoolCode

+ const DefaultQueue

+ const EntityCacheTTL

+ const EntityStreamName

+ const HeaderDirtyOp

+ const HeaderJobRunID

+ const JobRunDeduplicated

+ const JobRunFailed

+ const JobRunPending

+ const JobRunRunning

+ const JobRunSucceeded

+ const MaxCachedAllRows

+ const MetricsMetaKey

+ const RowCacheRewriteScript

+ const TaskStreamName

+ var ErrDispatchInTransaction = errors.New(...)

+ var ErrEntityNeedsRegeneration = errors.New(...)

+ var ErrEntityNotPersisted = errors.New("entity was never persisted")

+ var ErrEntityReadOnly = errors.New("entity is a read-only write snapshot")

+ var ErrEntityUnsavedChanges = errors.New("entity has unsaved changes")

+ var ErrEntityVanished = errors.New("entity row no longer exists")

+ var ErrJobRunEntityNotRegistered = errors.New(...)

+ var ErrOutboxDispatchMark = errors.New("cdc outbox dispatch mark failed")

+ var ErrPayloadUndecodable = errors.New("task payload cannot be decoded")

+ var ErrTxRollbackOnly = errors.New("transaction is rollback-only")

+ func CDCOutboxBacklog(ctx Context) (depth int, oldest time.Duration, err error)

+ func ConsumerPending(ctx Context, consumer ConsumerName) (uint64, error)

+ func DispatchTask[T any](ctx Context, task *T, opts ...DispatchOption) (uint64, error)

+ func Generate(engine Engine, outputDirectory string) error

+ func JobRunBacklog(ctx Context) (depth int, oldest time.Duration, err error)

+ func JsonMarshalToString(v any) (string, error)

+ func JsonUnmarshalFromString(data string, v any) error

+ func LoadJobRun(ctx Context, id uint64) (task, queue, status, payload string, err error)

+ func MarkJobRunFinished(ctx Context, id uint64, res JobRunResult) error

+ func MarkJobRunStarted(ctx Context, id uint64, attempt uint8) error

+ func NewConsumer[B any](engine Engine, ref ConsumerRef[B]) *B

+ func PurgeCDCOutbox(ctx Context, olderThan time.Duration, limit int) (int, error)

+ func PurgeJobRuns(ctx Context, status string, olderThan time.Duration, limit int) (int, error)

+ func RedispatchJobRun(ctx Context, runID uint64) (uint64, error)

+ func RegisterAfterDeleteHandler(engine Engine, cacheIndex string, handler func(Context, Entity) error)

+ func RegisterAfterInsertHandler(engine Engine, cacheIndex string, handler func(Context, Entity) error)

+ func RegisterAfterUpdateHandler(engine Engine, cacheIndex string, ...)

+ func RegisterEntityPublisher[E any](table string, ...)

+ func SQLScanTarget(destination any) any

+ func UniqueIndexKeyHash(values ...any) string

+ func UniqueIndexKeySegment(indexName string, columns []string) string

+ type Alter struct

+ Entity string

+ Kind AlterKind

+ Pool string

+ Reason string

+ SQL string

+ Safety AlterSafety

+ Table string

+ func GetAlters(ctx Context) (alters []Alter, err error)

+ func SplitAlters(in []Alter) (safe, destructive []Alter)

+ func (a Alter) Exec(ctx Context) error

+ func (a Alter) IsSafe() bool

+ type AlterKind string

+ const AlterKindAddColumn

+ const AlterKindAddIndex

+ const AlterKindAddUniqueIndex

+ const AlterKindChangeColumn

+ const AlterKindConvertTable

+ const AlterKindCreateTable

+ const AlterKindDropColumn

+ const AlterKindDropForeignKey

+ const AlterKindDropIndex

+ const AlterKindDropTable

+ const AlterKindModifyTable

+ const AlterKindRebuildIndex

+ const AlterKindSetDefault

+ func AllAlterKinds() []AlterKind

+ type AlterSafety uint8

+ const AlterDestructive

+ const AlterSafe

+ func (s AlterSafety) String() string

+ type BaseWhere struct

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

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

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

+ func (w *BaseWhere) IsWithFakeDeletes() bool

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

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

+ func (w *BaseWhere) String() string

+ func (w *BaseWhere) WithFakeDeletes() *BaseWhere

+ type BatchDispatch func(ctx Context, msgs []*NatsMessage) error

+ func BuildBatchDispatch[T any](handler func(ctx Context, evs []*DirtyEvent[T]) error, opts ...HandlerOption) BatchDispatch

+ type BoolField struct

+ Column string

+ func (f BoolField) ColumnName() string

+ func (f BoolField) Is(v bool) Condition

+ type CDCOutboxEntity struct

+ CreatedAt time.Time

+ DispatchedAt *time.Time

+ EntityID uint64

+ EntityName string

+ ID uint64

+ Op uint8

+ Payload string

+ Status string

+ func (e CDCOutboxEntity) Indexes() [][]string

+ type CDCOutboxRelayResult struct

+ Dispatched int

+ Fetched int

+ Published map[string]int

+ func RelayCDCOutbox(ctx Context, minAge time.Duration, limit int) (CDCOutboxRelayResult, error)

+ type Clickhouse interface

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

+ GetConfig func() ClickhouseConfig

+ GetDBClient func() DBClient

+ Query func(ctx Context, query string, args ...any) (rows Rows, close func(), err error)

+ QueryRow func(ctx Context, query Where, toFill ...any) (found bool, err error)

+ SetMockDBClient func(mock DBClient)

+ type ClickhouseAlter struct

+ Kind AlterKind

+ Pool string

+ SQL string

+ Safety AlterSafety

+ func GetClickhouseAlters(ctx Context) ([]ClickhouseAlter, error)

+ func (a ClickhouseAlter) Exec(ctx Context) error

+ func (a ClickhouseAlter) IsSafe() bool

+ type ClickhouseColumnOptions struct

+ Alias string

+ Codec string

+ Comment string

+ Default string

+ Materialized string

+ TTL string

+ type ClickhouseConfig interface

+ GetCode func() string

+ GetDataSourceURI func() string

+ GetDatabaseName func() string

+ GetOptions func() *ClickhouseOptions

+ type ClickhouseOptions struct

+ ConnMaxLifetime time.Duration

+ IgnoredTables []string

+ MaxIdleConnections int

+ MaxOpenConnections int

+ type ClickhouseTableBuilder struct

+ func NewClickhouseTable(tableName, poolCode string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) Column(name, typeName string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnAlias(name, typeName, expr string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnCodec(name, typeName, codec string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnComment(name, typeName, comment string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnDefault(name, typeName, defaultExpr string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnFull(name, typeName string, opts ClickhouseColumnOptions) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnMaterialized(name, typeName, expr string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) ColumnTTL(name, typeName, ttl string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) Comment(comment string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) Engine(engine string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) OrderBy(columns ...string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) PartitionBy(expr string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) PrimaryKey(columns ...string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) Setting(key, value string) *ClickhouseTableBuilder

+ func (b *ClickhouseTableBuilder) TTL(expr string) *ClickhouseTableBuilder

+ type ColumnSchemaDefinition struct

+ ColumnName string

+ Definition string

+ type Condition interface

+ Not func() Condition

+ ToSQL func() (clause string, params []any)

+ type Config struct

+ ClickhousePools []ConfigClickhouse

+ MySQlPools []ConfigMysql

+ NatsPools []ConfigNats

+ RedisPools []ConfigRedis

+ RedisSentinelPools []ConfigRedisSentinel

+ type ConfigClickhouse struct

+ Code string

+ ConnMaxLifetime int

+ IgnoredTables []string

+ MaxIdleConnections int

+ MaxOpenConnections int

+ URI string

+ type ConfigMysql struct

+ Code string

+ ConnMaxLifetime int

+ DefaultCollate string

+ DefaultEncoding string

+ IgnoredTables []string

+ MaxIdleConnections int

+ MaxOpenConnections int

+ URI string

+ type ConfigNats struct

+ AuthCredsFile string

+ AuthNKeySeed string

+ AuthPassword string

+ AuthToken string

+ AuthUser string

+ ClientID string

+ Code string

+ ConnectTimeoutMs int

+ Consumers []ConfigNatsConsumer

+ IgnoredConsumers []string

+ IgnoredSubjects []string

+ MaxReconnects int

+ ReconnectBufSize int

+ ReconnectWaitMs int

+ RetryOnFailedConnect bool

+ Streams []ConfigNatsStream

+ URLs []string

+ type ConfigNatsConsumer struct

+ AckWaitMs int

+ FilterSubjects []string

+ MaxAckPending int

+ MaxDeliver int

+ Name string

+ type ConfigNatsStream struct

+ DuplicateWindow int

+ MaxAgeMs int

+ MaxBytes int64

+ MaxMsgSize int32

+ Name string

+ Replicas int

+ Retention string

+ Storage string

+ Subjects []string

+ type ConfigRedis struct

+ Code string

+ Database int

+ Password string

+ URI string

+ User string

+ type ConfigRedisSentinel struct

+ Code string

+ Database int

+ MasterName string

+ Password string

+ Sentinels []string

+ User string

+ type ConsumerBuilder struct

+ func (b *ConsumerBuilder) AddBatchDispatch(entityName string, d BatchDispatch)

+ func (b *ConsumerBuilder) AddDispatch(key string, d Dispatch)

+ func (b *ConsumerBuilder) Build() StreamConsumer

+ func (b *ConsumerBuilder) Name() ConsumerName

+ type ConsumerDef struct

+ AckWait time.Duration

+ Entities []any

+ MaxAckPending int

+ MaxDeliver int

+ Name ConsumerName

+ NatsPool string

+ Queues []Queue

+ type ConsumerHandle interface

+ Enqueue func(orm Context, entities []Entity) error

+ Name func() ConsumerName

+ Subjects func() []Subject

+ type ConsumerName string

+ type ConsumerRef struct

+ func NewConsumerRef[B any](name ConsumerName, subjects []Subject, ...) ConsumerRef[B]

+ func (r ConsumerRef[B]) Enqueue(orm Context, entities []Entity) error

+ func (r ConsumerRef[B]) Name() ConsumerName

+ func (r ConsumerRef[B]) Subjects() []Subject

+ type Context interface

+ Clone func() Context

+ CloneWithContext func(context context.Context) Context

+ Context func() context.Context

+ DB func(pool string) DBBase

+ DatabasePipeLine func(pool string) *DatabasePipeline

+ Delete func(entities ...Entity) error

+ DisableContextCache func()

+ EnableQueryDebug func()

+ EnableQueryDebugCustom func(options QueryLoggerOptions)

+ Engine func() Engine

+ ForceDelete func(entities ...Entity) error

+ GetFromContextCache func(cacheIndex string, id uint64) Entity

+ GetMetaData func() Meta

+ InTransaction func() bool

+ InvalidateCacheKey func(pool, key string)

+ RedisPipeLine func(pool string) *RedisPipeLine

+ RegisterQueryLogger func(handler LogHandler, options QueryLoggerOptions)

+ Reload func(entities ...Entity) error

+ Save func(entities ...Entity) error

+ SetInContextCache func(cacheIndex string, id uint64, entity Entity)

+ SetMetaData func(key, value string)

+ Transaction func(fn func(tx Context) error) error

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

+ func PrepareTablesWithConsumers(t *testing.T, registry Registry, consumers []ConsumerDef, entities ...any) (orm Context)

+ func PrepareTablesWithNats(t *testing.T, registry Registry, entities ...any) (orm Context)

+ type DB interface

+ Begin func(ctx Context) (DBTransaction, error)

+ type DBBase interface

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

+ GetConfig func() MySQLConfig

+ GetDBClient func() DBClient

+ Query func(ctx Context, query string, args ...any) (rows Rows, close func(), err error)

+ QueryRow func(ctx Context, query Where, toFill ...any) (found bool, err error)

+ 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(context context.Context, query string, args ...any) (sql.Result, error)

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

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

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

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

+ type DBQuery struct

+ func NewQuery() *DBQuery

+ func (q *DBQuery) BuildLimitClause() string

+ func (q *DBQuery) BuildOrderClause() string

+ func (q *DBQuery) BuildWhereClause() (string, []any)

+ func (q *DBQuery) Filter(conditions ...Condition) *DBQuery

+ func (q *DBQuery) FilterWhere(w Where) *DBQuery

+ func (q *DBQuery) GetConditions() []Condition

+ func (q *DBQuery) IsWithFakeDeletes() bool

+ func (q *DBQuery) Pager(p *Pager) *DBQuery

+ func (q *DBQuery) SortByASC(f Field) *DBQuery

+ func (q *DBQuery) SortByDESC(f Field) *DBQuery

+ type DBTransaction interface

+ Commit func(ctx Context) error

+ Rollback func(ctx Context) error

+ type DatabasePipeline struct

+ func (dp *DatabasePipeline) AddQuery(query string, parameters ...any)

+ func (dp *DatabasePipeline) AddQueryForTable(table, query string, parameters ...any)

+ func (dp *DatabasePipeline) Exec(ctx Context) error

+ type DirtyEvent struct

+ After *T

+ Before *T

+ ID uint64

+ Op DirtyOp

+ TsMs int64

+ type DirtyOp uint8

+ const DirtyDelete

+ const DirtyInsert

+ const DirtyUpdate

+ func (op DirtyOp) String() string

+ type Dispatch func(ctx Context, msg *NatsMessage) error

+ func BuildDispatch[T any](handler func(ctx Context, ev *DirtyEvent[T]) error, opts ...HandlerOption) Dispatch

+ func BuildTaskDispatch[T any](handler func(ctx Context, task *T) error) Dispatch

+ type DispatchOption func(*dispatchConfig)

+ func WithIdempotencyKey(key string) DispatchOption

+ type Engine interface

+ Clickhouse func(code string) Clickhouse

+ DB func(code string) DB

+ Nats func(code string) Nats

+ NewContext func(parent context.Context) Context

+ NextID func() uint64

+ Option func(key string) any

+ Redis func(code string) RedisCache

+ Registry func() EngineRegistry

+ SetNodeID func(node int64)

+ type EngineRegistry interface

+ ClickhousePools func() map[string]Clickhouse

+ DBPools func() map[string]DB

+ NatsPools func() map[string]Nats

+ Option func(key string) any

+ RedisPools func() map[string]RedisCache

+ type EngineSetter interface

+ SetOption func(key string, value any)

+ type Entity interface

+ GetID func() uint64

+ PrivateFlush func() error

+ PrivateFlushEvent func() (uint8, map[string]any)

+ PrivateFlushed func()

+ PrivateGetDatabaseBind func() map[string]any

+ PrivateIsNew func() bool

+ PrivateReload func() (found bool, err error)

+ type EntityCachedUniqueIndexes interface

+ CachedUniqueIndexes func() [][]string

+ type EntityIndexes interface

+ Indexes func() [][]string

+ type EntityProvider interface

+ DBCode func() string

+ TableName func() string

+ type EntityStreamOptions struct

+ DuplicateWindow time.Duration

+ MaxAge time.Duration

+ MaxBytes int64

+ NatsPool string

+ Replicas int

+ Storage jetstream.StorageType

+ type EntityUniqueIndexes interface

+ UniqueIndexes func() [][]string

+ type EnumField struct

+ Column string

+ func (f EnumField) ColumnName() string

+ func (f EnumField) In(values ...any) Condition

+ func (f EnumField) Is(v any) Condition

+ type EqCondition interface

+ ColumnName func() string

+ EqValue func() any

+ type ExecResult interface

+ LastInsertId func() (uint64, error)

+ RowsAffected func() (uint64, error)

+ type Field interface

+ ColumnName func() string

+ type FloatField struct

+ Column string

+ func (f FloatField) ColumnName() string

+ func (f FloatField) Eq(v float64) Condition

+ func (f FloatField) Gt(v float64) Condition

+ func (f FloatField) Gte(v float64) Condition

+ func (f FloatField) In(values ...float64) Condition

+ func (f FloatField) Lt(v float64) Condition

+ func (f FloatField) Lte(v float64) Condition

+ type HandlerOption func(*handlerConfig)

+ func WatchFields(fields ...Field) HandlerOption

+ type IndexSchemaDefinition struct

+ Duplicated bool

+ Name string

+ Unique bool

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

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

+ type IntField struct

+ Column string

+ func (f IntField) ColumnName() string

+ func (f IntField) Eq(v int64) Condition

+ func (f IntField) Gt(v int64) Condition

+ func (f IntField) Gte(v int64) Condition

+ func (f IntField) In(values ...int64) Condition

+ func (f IntField) Lt(v int64) Condition

+ func (f IntField) Lte(v int64) Condition

+ type JobRunEntity struct

+ Attempts uint8

+ CreatedAt time.Time

+ DurationMs uint32

+ FinishedAt *time.Time

+ ID uint64

+ LastError string

+ Payload string

+ Queue string

+ StartedAt *time.Time

+ Status string

+ Task string

+ func (e JobRunEntity) Indexes() [][]string

+ type JobRunResult struct

+ Duration time.Duration

+ Err string

+ Status string

+ type JobRunSpec struct

+ Payload string

+ Queue string

+ Task string

+ type Lock struct

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

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

+ func (l *Lock) TTL(ctx Context) (time.Duration, error)

+ type Locker struct

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

+ type LogHandler interface

+ Handle func(ctx 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(context context.Context, query string, args ...any) (*sql.Rows, error)

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

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

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

+ RollbackMock func() error

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

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

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

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

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

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

+ func (m *MockDBClient) QueryRowContext(context 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 Nats interface

+ Close func()

+ Consumer func(name string) (NatsConsumer, error)

+ ConsumerNames func() []string

+ GetCode func() string

+ GetConn func() (*nats.Conn, error)

+ GetJetStream func() (jetstream.JetStream, error)

+ GetPoolOptions func() *NatsPoolOptions

+ GetURLs func() []string

+ MustConsumer func(name string) NatsConsumer

+ Ping func() error

+ Publish func(ctx Context, msg *NatsMessage) error

+ PublishAsync func(ctx Context, msg *NatsMessage, callback func(*NatsMessage, error))

+ PublishBatch func(ctx Context, msgs []*NatsMessage) error

+ PublishWithAck func(ctx Context, msg *NatsMessage) (NatsPubAck, error)

+ type NatsAlter struct

+ Description string

+ Kind AlterKind

+ PoolCode string

+ Safety AlterSafety

+ func GetNatsAlters(ctx Context) ([]NatsAlter, error)

+ func (a NatsAlter) Exec(ctx Context) error

+ func (a NatsAlter) IsSafe() bool

+ type NatsAuthConfig struct

+ CredsFile string

+ NKeySeed string

+ Password string

+ Token string

+ User string

+ type NatsBatch struct

+ func (b NatsBatch) EachError(fn func(error))

+ func (b NatsBatch) EachRecord(fn func(*NatsMessage))

+ func (b NatsBatch) Error() error

+ func (b NatsBatch) IsEmpty() bool

+ func (b NatsBatch) Records() []*NatsMessage

+ type NatsConsumer interface

+ Close func()

+ Fetch func(ctx Context, batch int, maxWait time.Duration) NatsBatch

+ GetName func() string

+ GetSettings func() *NatsConsumerSettings

+ type NatsConsumerBuilder struct

+ func NewNatsConsumer(name, poolCode string) *NatsConsumerBuilder

+ func (b *NatsConsumerBuilder) AckWait(d time.Duration) *NatsConsumerBuilder

+ func (b *NatsConsumerBuilder) DeliverPolicy(p jetstream.DeliverPolicy) *NatsConsumerBuilder

+ func (b *NatsConsumerBuilder) FilterSubjects(subjects ...string) *NatsConsumerBuilder

+ func (b *NatsConsumerBuilder) MaxAckPending(n int) *NatsConsumerBuilder

+ func (b *NatsConsumerBuilder) MaxDeliver(n int) *NatsConsumerBuilder

+ func (b *NatsConsumerBuilder) Stream(name string) *NatsConsumerBuilder

+ type NatsConsumerSettings struct

+ AckWait time.Duration

+ DeliverPolicy jetstream.DeliverPolicy

+ FilterSubjects []string

+ MaxAckPending int

+ MaxDeliver int

+ Name string

+ type NatsMessage struct

+ Data []byte

+ Deliveries uint64

+ Headers nats.Header

+ Sequence uint64

+ Subject string

+ Timestamp time.Time

+ func NewNatsMessage(subject string) *NatsMessage

+ func (m *NatsMessage) Ack() error

+ func (m *NatsMessage) Nak() error

+ func (m *NatsMessage) NakWithDelay(d time.Duration) error

+ func (m *NatsMessage) Term() error

+ type NatsPoolOptions struct

+ Auth *NatsAuthConfig

+ ClientID string

+ ConnectTimeout time.Duration

+ IgnoredConsumers []string

+ IgnoredSubjects []string

+ MaxReconnects int

+ PingInterval time.Duration

+ ReconnectBufSize int

+ ReconnectWait time.Duration

+ RetryOnFailedConnect bool

+ type NatsPubAck struct

+ Duplicate bool

+ Sequence uint64

+ Stream string

+ type NatsStreamBuilder struct

+ func NewNatsStream(streamName, poolCode string) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) Duplicates(d time.Duration) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) MaxAge(d time.Duration) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) MaxBytes(n int64) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) MaxMsgSize(n int32) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) Replicas(n int) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) Retention(r jetstream.RetentionPolicy) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) Storage(s jetstream.StorageType) *NatsStreamBuilder

+ func (b *NatsStreamBuilder) Subjects(subjects ...string) *NatsStreamBuilder

+ type NotFoundError struct

+ Entity string

+ ID uint64

+ func (e *NotFoundError) Error() string

+ type NullableBoolField struct

+ Column string

+ func (f NullableBoolField) ColumnName() string

+ func (f NullableBoolField) Is(v bool) Condition

+ func (f NullableBoolField) IsNotNull() Condition

+ func (f NullableBoolField) IsNull() Condition

+ type NullableEnumField struct

+ Column string

+ func (f NullableEnumField) ColumnName() string

+ func (f NullableEnumField) In(values ...any) Condition

+ func (f NullableEnumField) Is(v any) Condition

+ func (f NullableEnumField) IsNotNull() Condition

+ func (f NullableEnumField) IsNull() Condition

+ type NullableFloatField struct

+ Column string

+ func (f NullableFloatField) ColumnName() string

+ func (f NullableFloatField) Eq(v float64) Condition

+ func (f NullableFloatField) Gt(v float64) Condition

+ func (f NullableFloatField) Gte(v float64) Condition

+ func (f NullableFloatField) In(values ...float64) Condition

+ func (f NullableFloatField) IsNotNull() Condition

+ func (f NullableFloatField) IsNull() Condition

+ func (f NullableFloatField) Lt(v float64) Condition

+ func (f NullableFloatField) Lte(v float64) Condition

+ type NullableIntField struct

+ Column string

+ func (f NullableIntField) ColumnName() string

+ func (f NullableIntField) Eq(v int64) Condition

+ func (f NullableIntField) Gt(v int64) Condition

+ func (f NullableIntField) Gte(v int64) Condition

+ func (f NullableIntField) In(values ...int64) Condition

+ func (f NullableIntField) IsNotNull() Condition

+ func (f NullableIntField) IsNull() Condition

+ func (f NullableIntField) Lt(v int64) Condition

+ func (f NullableIntField) Lte(v int64) Condition

+ type NullableReferenceField struct

+ Column string

+ func (f NullableReferenceField) ColumnName() string

+ func (f NullableReferenceField) Eq(v uint64) Condition

+ func (f NullableReferenceField) In(values ...uint64) Condition

+ func (f NullableReferenceField) IsNotNull() Condition

+ func (f NullableReferenceField) IsNull() Condition

+ type NullableStringField struct

+ Column string

+ func (f NullableStringField) ColumnName() string

+ func (f NullableStringField) In(values ...string) Condition

+ func (f NullableStringField) Is(v string) Condition

+ func (f NullableStringField) IsEmpty() Condition

+ func (f NullableStringField) IsNotNull() Condition

+ func (f NullableStringField) IsNull() Condition

+ func (f NullableStringField) Like(v string) Condition

+ type NullableTimeField struct

+ Column string

+ func (f NullableTimeField) ColumnName() string

+ func (f NullableTimeField) Eq(v time.Time) Condition

+ func (f NullableTimeField) Gt(v time.Time) Condition

+ func (f NullableTimeField) Gte(v time.Time) Condition

+ func (f NullableTimeField) IsNotNull() Condition

+ func (f NullableTimeField) IsNull() Condition

+ func (f NullableTimeField) Lt(v time.Time) Condition

+ func (f NullableTimeField) Lte(v time.Time) Condition

+ type NullableUintField struct

+ Column string

+ func (f NullableUintField) ColumnName() string

+ func (f NullableUintField) Eq(v uint64) Condition

+ func (f NullableUintField) Gt(v uint64) Condition

+ func (f NullableUintField) Gte(v uint64) Condition

+ func (f NullableUintField) In(values ...uint64) Condition

+ func (f NullableUintField) IsNotNull() Condition

+ func (f NullableUintField) IsNull() Condition

+ func (f NullableUintField) Lt(v uint64) Condition

+ func (f NullableUintField) Lte(v uint64) Condition

+ 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, error)

+ type PipeLineGet struct

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

+ type PipeLineInt struct

+ func (c *PipeLineInt) Result() (int64, error)

+ type PipeLineSlice struct

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

+ type PipeLineString struct

+ func (c *PipeLineString) Result() (string, error)

+ type PostCommitError struct

+ Err error

+ func (e *PostCommitError) Error() string

+ func (e *PostCommitError) Unwrap() error

+ type QueryLoggerOptions struct

+ Clickhouse bool

+ MySQL bool

+ Nats bool

+ Redis bool

+ type QueryLoggerSource int

+ type Queue string

+ type Queued interface

+ Queue func() Queue

+ type RedisCache interface

+ BLMove func(ctx Context, source, destination, srcPos, destPos string, ...) (string, error)

+ Client func() *redis.Client

+ Del func(ctx Context, keys ...string) error

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

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

+ Exists func(ctx Context, keys ...string) (int64, error)

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

+ FTCreate func(ctx Context, index string, options *redis.FTCreateOptions, ...) error

+ FTDrop func(ctx Context, index string, dropDocuments bool) error

+ FTInfo func(ctx Context, index string) (info *redis.FTInfoResult, found bool, err error)

+ FTList func(ctx Context) ([]string, error)

+ FTSearch func(ctx Context, index string, query string, options *redis.FTSearchOptions) (redis.FTSearchResult, error)

+ FlushAll func(ctx Context) error

+ FlushDB func(ctx Context) error

+ Get func(ctx Context, key string) (value string, has bool, err error)

+ GetCode func() string

+ GetConfig func() RedisPoolConfig

+ GetLocker func() *Locker

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

+ HDel func(ctx Context, key string, keys ...string) error

+ HGet func(ctx Context, key, field string) (value string, has bool, err error)

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

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

+ HLen func(ctx Context, key string) (int64, error)

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

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

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

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

+ IncrBy func(ctx Context, key string, incr int64) (int64, error)

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

+ Info func(ctx Context, section ...string) (string, error)

+ LIndex func(ctx Context, key string, index int64) (string, bool, error)

+ LLen func(ctx Context, key string) (int64, error)

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

+ LPop func(ctx Context, key string) (string, error)

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

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

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

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

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

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

+ MSet func(ctx Context, pairs ...any) error

+ RPop func(ctx Context, key string) (value string, found bool, err error)

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

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

+ SCard func(ctx Context, key string) (int64, error)

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

+ SMembers func(ctx Context, key string) ([]string, error)

+ SPop func(ctx Context, key string) (string, bool, error)

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

+ Scan func(ctx Context, cursor uint64, match string, count int64) (keys []string, cursorNext uint64, err error)

+ ScriptExists func(ctx Context, sha1 string) (bool, error)

+ ScriptLoad func(ctx Context, script string) (string, error)

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

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

+ Type func(ctx Context, key string) (string, error)

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

+ XAckDel func(ctx Context, stream, group string, ids ...string) ([]interface{}, error)

+ XAutoClaim func(ctx Context, a *redis.XAutoClaimArgs) (messages []redis.XMessage, start string, err error)

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

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

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

+ XGroupCreate func(ctx Context, stream, group, start string) (key string, exists bool, err error)

+ XGroupCreateMkStream func(ctx Context, stream, group, start string) (key string, exists bool, err error)

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

+ XGroupDestroy func(ctx Context, stream, group string) (int64, error)

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

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

+ XLen func(ctx Context, stream string) (int64, error)

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

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

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

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

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

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

+ XTrim func(ctx Context, stream string, maxLen int64) (deleted int64, err error)

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

+ ZCard func(ctx Context, key string) (int64, error)

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

+ ZRangeArgsWithScores func(ctx Context, z redis.ZRangeArgs) ([]redis.Z, error)

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

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

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

+ ZScore func(ctx Context, key, member string) (float64, error)

+ type RedisCacheEntityProvider interface

+ ClearRedisCache func(ctx Context) (int, error)

+ RedisCachePrefix func() string

+ RedisCode func() string

+ 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(ctx Context) (response []redis.Cmder, err error)

+ 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) LRangeBatchInto(results []PipeLineSlice, keys []string, start, stop int64)

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

+ 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)

+ type RedisPoolConfig interface

+ GetAddress func() string

+ GetCode func() string

+ GetDatabaseNumber func() int

+ type RedisSearchAlter struct

+ IndexName string

+ Kind AlterKind

+ RedisPool string

+ Safety AlterSafety

+ func GetRedisSearchAlters(ctx Context) ([]RedisSearchAlter, error)

+ func (a RedisSearchAlter) Exec(ctx Context) error

+ func (a RedisSearchAlter) IsSafe() bool

+ type RedisSearchCondition interface

+ ToFTSearch func() string

+ type RedisSearchEntityProvider interface

+ RedisSearchCode func() string

+ RedisSearchHashPrefix func() string

+ RedisSearchIndexName func() string

+ ReindexRedisSearch func(ctx Context) error

+ type RedisSearchField interface

+ ColumnName func() string

+ type RedisSearchIntField struct

+ Column string

+ func (f RedisSearchIntField) Between(min, max int64) RedisSearchCondition

+ func (f RedisSearchIntField) ColumnName() string

+ func (f RedisSearchIntField) Eq(v int64) RedisSearchCondition

+ func (f RedisSearchIntField) Gt(v int64) RedisSearchCondition

+ func (f RedisSearchIntField) Gte(v int64) RedisSearchCondition

+ func (f RedisSearchIntField) Lt(v int64) RedisSearchCondition

+ func (f RedisSearchIntField) Lte(v int64) RedisSearchCondition

+ type RedisSearchNumericField struct

+ Column string

+ func (f RedisSearchNumericField) Between(min, max float64) RedisSearchCondition

+ func (f RedisSearchNumericField) ColumnName() string

+ func (f RedisSearchNumericField) Eq(v float64) RedisSearchCondition

+ func (f RedisSearchNumericField) Gt(v float64) RedisSearchCondition

+ func (f RedisSearchNumericField) Gte(v float64) RedisSearchCondition

+ func (f RedisSearchNumericField) Lt(v float64) RedisSearchCondition

+ func (f RedisSearchNumericField) Lte(v float64) RedisSearchCondition

+ type RedisSearchQuery struct

+ func NewRedisSearchQuery() *RedisSearchQuery

+ func (q *RedisSearchQuery) BuildQueryString() string

+ func (q *RedisSearchQuery) BuildSearchOptions(offset, count int) *redis.FTSearchOptions

+ func (q *RedisSearchQuery) Filter(conditions ...RedisSearchCondition) *RedisSearchQuery

+ func (q *RedisSearchQuery) GetPagerOffsetCount() (offset int, count int)

+ func (q *RedisSearchQuery) Pager(p *Pager) *RedisSearchQuery

+ func (q *RedisSearchQuery) SortByASC(f RedisSearchField) *RedisSearchQuery

+ func (q *RedisSearchQuery) SortByDESC(f RedisSearchField) *RedisSearchQuery

+ type RedisSearchReferenceField struct

+ Column string

+ func (f RedisSearchReferenceField) ColumnName() string

+ func (f RedisSearchReferenceField) Eq(id uint64) RedisSearchCondition

+ func (f RedisSearchReferenceField) In(ids ...uint64) RedisSearchCondition

+ type RedisSearchTagField struct

+ Column string

+ func (f RedisSearchTagField) ColumnName() string

+ func (f RedisSearchTagField) In(values ...string) RedisSearchCondition

+ type RedisSearchTextField struct

+ Column string

+ func (f RedisSearchTextField) ColumnName() string

+ func (f RedisSearchTextField) Match(text string) RedisSearchCondition

+ type RedisSearchUintField struct

+ Column string

+ func (f RedisSearchUintField) Between(min, max uint64) RedisSearchCondition

+ func (f RedisSearchUintField) ColumnName() string

+ func (f RedisSearchUintField) Eq(v uint64) RedisSearchCondition

+ func (f RedisSearchUintField) Gt(v uint64) RedisSearchCondition

+ func (f RedisSearchUintField) Gte(v uint64) RedisSearchCondition

+ func (f RedisSearchUintField) Lt(v uint64) RedisSearchCondition

+ func (f RedisSearchUintField) Lte(v uint64) RedisSearchCondition

+ type RedisSearchWhere struct

+ func NewRedisSearchWhere() *RedisSearchWhere

+ func (w *RedisSearchWhere) Bool(field string, value bool) *RedisSearchWhere

+ func (w *RedisSearchWhere) Float64Equal(field string, value float64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Float64Max(field string, max float64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Float64Min(field string, min float64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Float64Range(field string, min, max float64) *RedisSearchWhere

+ func (w *RedisSearchWhere) GetSearchOptions(offset, count int) *redis.FTSearchOptions

+ func (w *RedisSearchWhere) Int64Equal(field string, value int64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Int64Max(field string, max int64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Int64Min(field string, min int64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Int64Range(field string, min, max int64) *RedisSearchWhere

+ func (w *RedisSearchWhere) SortBy(field string, ascending bool) *RedisSearchWhere

+ func (w *RedisSearchWhere) String() string

+ func (w *RedisSearchWhere) Tag(field string, values ...string) *RedisSearchWhere

+ func (w *RedisSearchWhere) Text(field string, text string) *RedisSearchWhere

+ func (w *RedisSearchWhere) Uint64Equal(field string, value uint64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Uint64Max(field string, max uint64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Uint64Min(field string, min uint64) *RedisSearchWhere

+ func (w *RedisSearchWhere) Uint64Range(field string, min, max uint64) *RedisSearchWhere

+ type Reference uint64

+ type ReferenceField struct

+ Column string

+ func (f ReferenceField) ColumnName() string

+ func (f ReferenceField) Eq(v uint64) Condition

+ func (f ReferenceField) In(values ...uint64) Condition

+ type References struct

+ type Registry interface

+ EnableMetrics func(factory promauto.Factory)

+ InitByConfig func(config *Config) error

+ InitByYaml func(yaml any) error

+ RegisterClickhouse func(dataSourceName string, poolCode string, poolOptions *ClickhouseOptions)

+ RegisterClickhouseTable func(table *ClickhouseTableBuilder)

+ RegisterConsumer func(def ConsumerDef)

+ RegisterEntity func(entity ...any)

+ RegisterEntityStream func(opts EntityStreamOptions)

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

+ RegisterNats func(urls []string, poolCode string, options *NatsPoolOptions)

+ RegisterNatsConsumer func(consumer *NatsConsumerBuilder)

+ RegisterNatsStream func(stream *NatsStreamBuilder)

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

+ RegisterTask func(task any, opts TaskOptions)

+ RegisterTaskStream func(opts TaskStreamOptions)

+ SetOption func(key string, value any)

+ Validate func() (Engine, error)

+ ValidateForCodeGen func() (Engine, error)

+ func NewRegistry() Registry

+ type Rows interface

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

+ Next func() bool

+ Scan func(dest ...any) error

+ type SQLRow interface

+ Err func() error

+ 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 StreamConsumer interface

+ Consume func(ctx context.Context, batch int, timeout time.Duration) error

+ type StringField struct

+ Column string

+ func (f StringField) ColumnName() string

+ func (f StringField) In(values ...string) Condition

+ func (f StringField) Is(v string) Condition

+ func (f StringField) IsEmpty() Condition

+ func (f StringField) Like(v string) Condition

+ type Subject string

+ func EntitySubject(table string) Subject

+ func ReplaySubject(consumer ConsumerName, table string) Subject

+ func TaskSubject(queue Queue, task TaskName) Subject

+ func (s Subject) String() string

+ type Subjected interface

+ Subject func() Subject

+ type TXClient interface

+ type TaskName string

+ func TaskNameFor[T any]() TaskName

+ type TaskOptions struct

+ BaseBackoff time.Duration

+ MaxAttempts int

+ MaxBackoff time.Duration

+ type TaskStreamOptions struct

+ DuplicateWindow time.Duration

+ MaxAge time.Duration

+ MaxBytes int64

+ NatsPool string

+ Replicas int

+ Storage jetstream.StorageType

+ type TimeField struct

+ Column string

+ func (f TimeField) ColumnName() string

+ func (f TimeField) Eq(v time.Time) Condition

+ func (f TimeField) Gt(v time.Time) Condition

+ func (f TimeField) Gte(v time.Time) Condition

+ func (f TimeField) Lt(v time.Time) Condition

+ func (f TimeField) Lte(v time.Time) Condition

+ type UintField struct

+ Column string

+ func (f UintField) ColumnName() string

+ func (f UintField) Eq(v uint64) Condition

+ func (f UintField) Gt(v uint64) Condition

+ func (f UintField) Gte(v uint64) Condition

+ func (f UintField) In(values ...uint64) Condition

+ func (f UintField) Lt(v uint64) Condition

+ func (f UintField) Lte(v uint64) Condition

+ type Where interface

+ GetParameters func() []any

+ IsWithFakeDeletes func() bool

+ String func() string

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