quark

package module

Go to main page

Versions in this module

v1

v1.1.2

Jun 10, 2026

Changes in this version

type Column

+ PrimaryKey bool

v1.1.1

Jun 9, 2026

v1.1.0

Jun 6, 2026

Changes in this version

+ var ErrListenerClosed = errors.New("event listener closed")

+ var ErrNoSubscription = errors.New("event listener has no channel subscribed")

type MSSQLDialect

+ func (m *MSSQLDialect) ReleaseSavepointStmt(name string) string

+ func (m *MSSQLDialect) RollbackToSavepointStmt(name string) string

+ func (m *MSSQLDialect) SavepointStmt(name string) string

type OracleDialect

+ func (o *OracleDialect) ReleaseSavepointStmt(name string) string

+ func (o *OracleDialect) RollbackToSavepointStmt(name string) string

+ func (o *OracleDialect) SavepointStmt(name string) string

+ type SavepointDialect interface

+ ReleaseSavepointStmt func(name string) string

+ RollbackToSavepointStmt func(name string) string

+ SavepointStmt func(name string) string

v1.0.0

May 27, 2026

Changes in this version

+ func DefaultShardResolver(ctx context.Context) string

+ func ShardKeyFromContext(ctx context.Context) string

+ func WithShardKey(ctx context.Context, key string) context.Context

+ type ColumnTypeMapper interface

+ MapColumnType func(t string) string

type Option

+ func WithReplicaStrategy(s ReplicaStrategy) Option

type OracleDialect

+ func (d *OracleDialect) AcquireMigrationLock(ctx context.Context, db DBConnector, name string, timeout time.Duration) (MigrationLock, error)

+ func (o *OracleDialect) IntrospectSchema(ctx context.Context, exec Executor) (Schema, error)

+ func (o *OracleDialect) MapColumnType(t string) string

+ type ReplicaStrategy int

+ const ReplicaLeastConn

+ const ReplicaRandom

+ const ReplicaRoundRobin

+ type ShardFunc func(shardKey string) string

+ func HashShardFunc(shardNames []string) ShardFunc

+ type ShardResolver func(ctx context.Context) string

+ type ShardRouter struct

+ func NewShardRouter(shards map[string]*Client, resolve ShardResolver, shardFor ShardFunc) (*ShardRouter, error)

+ func (r *ShardRouter) GetClient(ctx context.Context) (*Client, error)

+ func (r *ShardRouter) ShardNames() []string

v0

v0.13.0

May 25, 2026

Changes in this version

+ func Sticky(ctx context.Context) context.Context

type Option

+ func WithReplicaDownCooldown(d time.Duration) Option

+ func WithReplicas(dsns ...string) Option

v0.12.0

May 24, 2026

Changes in this version

+ type Predicate struct

type Query

+ func (q *Query[T]) WhereP(preds ...Predicate) *Query[T]

+ type TypedColumn struct

+ func NewTypedColumn[T any](name string) TypedColumn[T]

+ func (c TypedColumn[T]) Between(lo, hi T) Predicate

+ func (c TypedColumn[T]) Eq(v T) Predicate

+ func (c TypedColumn[T]) Gt(v T) Predicate

+ func (c TypedColumn[T]) Gte(v T) Predicate

+ func (c TypedColumn[T]) In(values ...T) Predicate

+ func (c TypedColumn[T]) IsNotNull() Predicate

+ func (c TypedColumn[T]) IsNull() Predicate

+ func (c TypedColumn[T]) Lt(v T) Predicate

+ func (c TypedColumn[T]) Lte(v T) Predicate

+ func (c TypedColumn[T]) Name() string

+ func (c TypedColumn[T]) Neq(v T) Predicate

+ func (c TypedColumn[T]) NotIn(values ...T) Predicate

+ type TypedStringColumn struct

+ func NewTypedStringColumn(name string) TypedStringColumn

+ func (c TypedStringColumn) Like(pattern string) Predicate

+ func (c TypedStringColumn) NotLike(pattern string) Predicate

v0.11.0

May 24, 2026

Changes in this version

+ const GenContractVersion

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

+ func CanonicalType(s string) string

+ func CheckGeneratedDrift(t reflect.Type) (drifted bool, hasGenerated bool)

+ func GeneratedBinderRegistered(t reflect.Type) bool

+ func HashModelFields(fields []ModelField) string

+ func ModelHash(t reflect.Type) string

+ func RegisterGeneratedMeta(t reflect.Type, meta GeneratedMeta)

+ func RegisterTypedBinder(t reflect.Type, fn TypedBinder)

+ func RegisterTypedScanner(t reflect.Type, fn TypedScanner)

+ func ScanTarget(ptr any) any

+ func StubBinder(any, BindMode) ([]string, []any, error)

+ func StubScanner(*sql.Rows, any) error

+ type BindMode int

+ const BindInsert

+ const BindUpdate

+ type GeneratedMeta struct

+ ContractVersion int

+ ModelHash string

+ type ModelField struct

+ Column string

+ GoType string

+ IsPK bool

+ Name string

+ type TypedBinder func(entity any, mode BindMode) (cols []string, args []any, err error)

+ type TypedScanner func(rows *sql.Rows, dest any) error

v0.10.0

May 22, 2026

v0.9.0

May 21, 2026

Changes in this version

+ var ErrEventEmitFailed = errors.New("event emit failed after commit")

+ type AfterFindHook interface

+ AfterFind func(ctx context.Context) error

+ type AuditConfig struct

+ ExcludeTables []string

+ IncludeTables []string

+ TenantFromContext func(context.Context) string

+ UserFromContext func(context.Context) string

+ type BeforeFindHook interface

+ BeforeFind func(ctx context.Context) error

type Client

+ func (c *Client) DisableAuditLog()

+ func (c *Client) EnableAuditLog(ctx context.Context, cfg AuditConfig) error

+ func (c *Client) UseEventBus(bus EventBus)

+ type Event interface

+ Kind func() string

+ Payload func() any

+ Table func() string

type EventBus

+ Publish func(ctx context.Context, event Event) error

+ type ListenerFactory struct

+ func NewListenerFactory(client *Client) *ListenerFactory

+ func (f *ListenerFactory) CreateListener() (EventListener, error)

+ type LoggerEventBus struct

+ func NewLoggerEventBus(logger *slog.Logger) *LoggerEventBus

+ func (b *LoggerEventBus) Publish(ctx context.Context, event Event) error

+ type OTelEventBus struct

+ func NewOTelEventBus(logger *slog.Logger) *OTelEventBus

+ func (b *OTelEventBus) Publish(ctx context.Context, event Event) error

type TenantConfig

+ NativeRLSVar string

type TenantRouter

+ func (r *TenantRouter) Tx(ctx context.Context, fn func(tx *Tx) error) error

type TenantStrategy

+ const RowLevelSecurityClient

+ const RowLevelSecurityNative

type Tx

+ func TxFromContext(ctx context.Context) *Tx

+ func (t *Tx) OnCommit(fn func(context.Context) error)

+ func (t *Tx) OnRollback(fn func(context.Context) error)

v0.8.0

May 15, 2026

Changes in this version

type Option

+ func WithCacheJitter(pct float64) Option

+ func WithCacheXFetchBeta(beta float64) Option

+ func WithDeadlockRetry(maxAttempts int) Option

+ func WithSlowQueryThreshold(d time.Duration) Option

v0.7.0

May 14, 2026

Changes in this version

+ var ErrInvalidTimezone = errors.New("invalid column timezone")

type Option

+ func WithDefaultTZ(loc *time.Location) Option

v0.6.0

May 14, 2026

Changes in this version

+ var ErrLockTimeout = errors.New("migration lock acquisition timed out")

+ type Array struct

+ V []T

+ func (a *Array[T]) Scan(src any) error

+ func (a Array[T]) Len() int

+ func (a Array[T]) Slice() []T

+ func (a Array[T]) Value() (driver.Value, error)

+ type BackfillSpec struct

+ BatchSize int

+ Name string

+ PKColumn string

+ Process func(ctx context.Context, batchPKs []int64) error

+ Table string

+ type Check struct

+ Expression string

+ Name string

type Client

+ func (c *Client) AcquireMigrationLock(ctx context.Context, name string, timeout time.Duration) (MigrationLock, error)

+ func (c *Client) ApplyPlan(ctx context.Context, plan Plan) error

+ func (c *Client) Backfill(ctx context.Context, spec BackfillSpec) error

+ func (c *Client) IntrospectSchema(ctx context.Context) (Schema, error)

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

+ func (c *Client) PlanMigration(ctx context.Context, models ...any) (Plan, error)

+ func (c *Client) PlanMigrationRegistered(ctx context.Context) (Plan, error)

+ func (c *Client) RegisterModel(models ...any) error

+ func (c *Client) RegisteredModels() []any

+ type Column struct

+ Default *string

+ Name string

+ Nullable bool

+ Type string

+ type DBConn interface

+ Close func() error

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

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

+ type DBConnector interface

+ Conn func(ctx context.Context) (DBConn, error)

+ type ForeignKey struct

+ Columns []string

+ Name string

+ OnDelete string

+ OnUpdate string

+ RefColumns []string

+ RefTable string

+ type Index struct

+ Columns []string

+ Name string

+ Unique bool

type MSSQLDialect

+ func (d *MSSQLDialect) AcquireMigrationLock(ctx context.Context, db DBConnector, name string, timeout time.Duration) (MigrationLock, error)

+ func (d *MSSQLDialect) IntrospectSchema(ctx context.Context, exec Executor) (Schema, error)

type MariaDBDialect

+ func (d *MariaDBDialect) AcquireMigrationLock(ctx context.Context, db DBConnector, name string, timeout time.Duration) (MigrationLock, error)

+ func (d *MariaDBDialect) IntrospectSchema(ctx context.Context, exec Executor) (Schema, error)

+ type MigrationLock interface

+ Release func(ctx context.Context) error

+ type MigrationLocker interface

+ AcquireMigrationLock func(ctx context.Context, db DBConnector, name string, timeout time.Duration) (MigrationLock, error)

type MySQLDialect

+ func (d *MySQLDialect) AcquireMigrationLock(ctx context.Context, db DBConnector, name string, timeout time.Duration) (MigrationLock, error)

+ func (d *MySQLDialect) IntrospectSchema(ctx context.Context, exec Executor) (Schema, error)

+ type OpAddCheck struct

+ Check Check

+ Table string

+ func (o OpAddCheck) String() string

+ type OpAddColumn struct

+ Column Column

+ Table string

+ func (o OpAddColumn) String() string

+ type OpAddForeignKey struct

+ ForeignKey ForeignKey

+ Table string

+ func (o OpAddForeignKey) String() string

+ type OpAlterColumn struct

+ New Column

+ Old Column

+ Table string

+ func (o OpAlterColumn) String() string

+ type OpCreateIndex struct

+ Index Index

+ Table string

+ func (o OpCreateIndex) String() string

+ type OpCreateTable struct

+ Table Table

+ func (o OpCreateTable) String() string

+ type OpDropCheck struct

+ Check string

+ Table string

+ func (o OpDropCheck) String() string

+ type OpDropColumn struct

+ Column string

+ Table string

+ func (o OpDropColumn) String() string

+ type OpDropForeignKey struct

+ ForeignKey string

+ Table string

+ func (o OpDropForeignKey) String() string

+ type OpDropIndex struct

+ Index string

+ Table string

+ func (o OpDropIndex) String() string

+ type OpDropTable struct

+ Table string

+ func (o OpDropTable) String() string

+ type Operation interface

+ String func() string

+ func Diff(desired, current Schema) []Operation

+ type Plan struct

+ Ops []Operation

+ func (p Plan) Hash() string

+ func (p Plan) IsEmpty() bool

+ func (p Plan) String() string

type PostgresDialect

+ func (d *PostgresDialect) AcquireMigrationLock(ctx context.Context, db DBConnector, name string, timeout time.Duration) (MigrationLock, error)

+ func (d *PostgresDialect) IntrospectSchema(ctx context.Context, exec Executor) (Schema, error)

+ type Result interface

+ LastInsertId func() (int64, error)

+ RowsAffected func() (int64, error)

+ type Row interface

+ Scan func(dest ...any) error

type SQLiteDialect

+ func (d *SQLiteDialect) IntrospectSchema(ctx context.Context, exec Executor) (Schema, error)

+ type Schema struct

+ Tables []Table

+ type SchemaIntrospector interface

+ IntrospectSchema func(ctx context.Context, exec Executor) (Schema, error)

+ type Table struct

+ Checks []Check

+ Columns []Column

+ ForeignKeys []ForeignKey

+ Indexes []Index

+ Name string

v0.5.0

May 13, 2026

v0.4.0

May 10, 2026

Changes in this version

+ var ErrUnsupportedFeature = errors.New("feature not supported by dialect")

type Dialect

+ LockSuffix func(opts LockOptions) (tableHint, suffix string, err error)

+ type Expr interface

+ ToSQL func(d Dialect, g *SQLGuard) (sql string, args []any, err error)

+ func And(parts ...Expr) Expr

+ func Cmp(lhs Expr, op string, rhs Expr) Expr

+ func Col(name string) Expr

+ func DenseRank() Expr

+ func Eq(lhs, rhs Expr) Expr

+ func Exists(s *Subquery) Expr

+ func Func(name string, args ...Expr) Expr

+ func Gt(lhs, rhs Expr) Expr

+ func Gte(lhs, rhs Expr) Expr

+ func In(lhs Expr, values ...Expr) Expr

+ func InSub(lhs Expr, s *Subquery) Expr

+ func Lag(col Expr, offset int) Expr

+ func Lead(col Expr, offset int) Expr

+ func Lit(v any) Expr

+ func Lt(lhs, rhs Expr) Expr

+ func Lte(lhs, rhs Expr) Expr

+ func Ne(lhs, rhs Expr) Expr

+ func Not(e Expr) Expr

+ func NotExists(s *Subquery) Expr

+ func NotIn(lhs Expr, values ...Expr) Expr

+ func NotInSub(lhs Expr, s *Subquery) Expr

+ func Or(parts ...Expr) Expr

+ func Over(inner Expr, w *Window) Expr

+ func Rank() Expr

+ func RowNumber() Expr

+ func Sub(s *Subquery) Expr

+ type JoinBuilder struct

+ func (b *JoinBuilder[T]) On(left, op, right string) *Query[T]

+ func (b *JoinBuilder[T]) OnRaw(onClause string) *Query[T]

+ type LockMode int

+ const LockForShare

+ const LockForUpdate

+ const LockNone

+ type LockOptions struct

+ Mode LockMode

+ NoWait bool

+ SkipLocked bool

+ func (o LockOptions) IsZero() bool

type MSSQLDialect

+ func (m *MSSQLDialect) LockSuffix(opts LockOptions) (string, string, error)

type MariaDBDialect

+ func (m *MariaDBDialect) LockSuffix(opts LockOptions) (string, string, error)

type MySQLDialect

+ func (m *MySQLDialect) LockSuffix(opts LockOptions) (string, string, error)

type OracleDialect

+ func (o *OracleDialect) LockSuffix(opts LockOptions) (string, string, error)

type PostgresDialect

+ func (p *PostgresDialect) LockSuffix(opts LockOptions) (string, string, error)

type Query

+ func (q *Query[T]) AsSubquery() (*Subquery, error)

+ func (q *Query[T]) Except(other *Query[T]) *Query[T]

+ func (q *Query[T]) ForShare() *Query[T]

+ func (q *Query[T]) ForUpdate() *Query[T]

+ func (q *Query[T]) HavingAggregate(fn, column, operator string, value any) *Query[T]

+ func (q *Query[T]) HavingExpr(e Expr) *Query[T]

+ func (q *Query[T]) Intersect(other *Query[T]) *Query[T]

+ func (q *Query[T]) MustAsSubquery() *Subquery

+ func (q *Query[T]) NoWait() *Query[T]

+ func (q *Query[T]) SelectExpr(alias string, e Expr) *Query[T]

+ func (q *Query[T]) SkipLocked() *Query[T]

+ func (q *Query[T]) Union(other *Query[T]) *Query[T]

+ func (q *Query[T]) UnionAll(other *Query[T]) *Query[T]

+ func (q *Query[T]) WhereExpr(e Expr) *Query[T]

+ func (q *Query[T]) With(name string, sub *Subquery) *Query[T]

+ func (q *Query[T]) WithRecursive(name string, sub *Subquery) *Query[T]

type SQLiteDialect

+ func (s *SQLiteDialect) LockSuffix(opts LockOptions) (string, string, error)

+ type Subquery struct

+ func (s *Subquery) SQL() (string, []any)

+ type Window struct

+ func NewWindow() *Window

+ func (w *Window) OrderBy(col Expr, desc bool) *Window

+ func (w *Window) PartitionBy(cols ...Expr) *Window

v0.3.0

May 10, 2026

Changes in this version

+ var ErrInvalidJSONPath = errors.New("invalid JSON path")

+ var ErrInvalidJoin = errors.New("invalid JOIN ON clause")

+ var ErrStaleEntity = errors.New("stale entity (optimistic-locking conflict)")

+ func RegisterTypeMapper(t reflect.Type, m TypeMapper)

type Client

+ func (c *Client) WithOptions(opts ...any) (*Client, error)

+ type JSON struct

+ V T

+ func (j *JSON[T]) Scan(src any) error

+ func (j JSON[T]) Value() (driver.Value, error)

+ type Nullable = sql.Null[T]

+ func NullOf[T any]() Nullable[T]

+ func SomeOf[T any](v T) Nullable[T]

+ type PoolOption interface

+ func WithConnMaxIdleTime(d time.Duration) PoolOption

+ func WithConnMaxLifetime(d time.Duration) PoolOption

+ func WithMaxIdleConns(n int) PoolOption

+ func WithMaxOpenConns(n int) PoolOption

type Query

+ func (q *Query[T]) OnlyTrashed() *Query[T]

+ func (q *Query[T]) Restore(entity *T) (int64, error)

+ func (q *Query[T]) Track() *TrackedQuery[T]

+ func (q *Query[T]) UpdateFields(entity *T, fields ...string) (int64, error)

+ func (q *Query[T]) WithTrashed() *Query[T]

+ type Tracked struct

+ Entity *T

+ func (t *Tracked[T]) Changed() []string

+ func (t *Tracked[T]) Save(ctx context.Context) (int64, error)

+ type TrackedQuery struct

+ func (tq *TrackedQuery[T]) Find(id any) (*Tracked[T], error)

+ func (tq *TrackedQuery[T]) First() (*Tracked[T], error)

+ func (tq *TrackedQuery[T]) List() ([]*Tracked[T], error)

+ type TypeMapper = migrate.TypeMapper

+ type TypeOptions = migrate.TypeOptions

v0.1.0

May 5, 2026

Changes in this version

+ var ErrConnection = errors.New("database connection error")

+ var ErrConstraintViolation = errors.New("constraint violation")

+ var ErrDialectNotSupported = errors.New("dialect not supported")

+ var ErrInvalidIdentifier = errors.New("invalid identifier")

+ var ErrInvalidModel = errors.New("invalid model")

+ var ErrInvalidQuery = errors.New("invalid query")

+ var ErrNotFound = errors.New("record not found")

+ var ErrTimeout = errors.New("query timeout")

+ var HasPlaceholders = guard.HasPlaceholders

+ func Call(ctx context.Context, provider ClientProvider, procedure string, args ...any) error

+ func Notify(ctx context.Context, provider ClientProvider, channel, payload string) error

+ func RegisterDialect(name string, d Dialect)

+ type AfterCreateHook interface

+ AfterCreate func(ctx context.Context) error

+ type AfterDeleteHook interface

+ AfterDelete func(ctx context.Context) error

+ type AfterUpdateHook interface

+ AfterUpdate func(ctx context.Context) error

+ type BaseMiddleware struct

+ func (BaseMiddleware) WrapExec(next ExecFunc) ExecFunc

+ func (BaseMiddleware) WrapQuery(next QueryFunc) QueryFunc

+ func (BaseMiddleware) WrapQueryRow(next QueryRowFunc) QueryRowFunc

+ type BaseQuery struct

+ type BeforeCreateHook interface

+ BeforeCreate func(ctx context.Context) error

+ type BeforeDeleteHook interface

+ BeforeDelete func(ctx context.Context) error

+ type BeforeUpdateHook interface

+ BeforeUpdate func(ctx context.Context) error

+ type CacheConfig struct

+ Enabled bool

+ TTL time.Duration

+ Tags []string

+ type CacheStore interface

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

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

+ InvalidateTags func(ctx context.Context, tags ...string) error

+ Set func(ctx context.Context, key string, val []byte, ttl time.Duration, tags ...string) error

+ type Client struct

+ func New(db *sql.DB, opts ...Option) (*Client, error)

+ func (c *Client) AddForeignKey(ctx context.Context, table, constraintName string, columns []string, ...) error

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

+ func (c *Client) Close() error

+ func (c *Client) CreateIndex(ctx context.Context, table, indexName string, columns []string, unique bool) error

+ func (c *Client) Dialect() Dialect

+ func (c *Client) Exec(ctx context.Context, query string, args ...any) error

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

+ func (c *Client) Migrate(ctx context.Context, models ...any) error

+ func (c *Client) Raw() *sql.DB

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

+ func (c *Client) Sync(ctx context.Context, opts SyncOptions, models ...any) error

+ func (c *Client) Tx(ctx context.Context, fn func(tx *Tx) error) error

+ func (c *Client) Validate(ctx context.Context, model any) error

+ type ClientProvider interface

+ GetClient func(ctx context.Context) (*Client, error)

+ type Cursor struct

+ func (c *Cursor[T]) Close() error

+ func (c *Cursor[T]) Err() error

+ func (c *Cursor[T]) Next() bool

+ func (c *Cursor[T]) Scan(dest *T) error

+ type Dialect interface

+ AlterTableAddColumn func(table, column, dataType string) string

+ AlterTableAlterColumn func(table, column, newDataType string) string

+ AlterTableDropColumn func(table, column string) string

+ BuildProcedureCall func(procedure string, argCount int) string

+ BuildRoutineQuery func(routine string, argCount int) string

+ CurrentTimestamp func() string

+ JSONExtract func(column, path string) string

+ LastInsertIDQuery func(table, pkColumn string) string

+ LimitOffset func(limit, offset int) string

+ Name func() string

+ Placeholder func(index int) string

+ Placeholders func(n int) []string

+ Quote func(identifier string) string

+ RenameColumn func(table, oldName, newName string) string

+ RenameTable func(oldName, newName string) string

+ Returning func(columns ...string) string

+ SupportsLastInsertID func() bool

+ SupportsReturning func() bool

+ SupportsTransactionalDDL func() bool

+ UpsertSQL func(conflictCols, updateCols []string, argOffset int) string

+ func DetectDialect(driverName string) (Dialect, error)

+ func DetectDialectByName(name string) (Dialect, error)

+ func MSSQL() Dialect

+ func MariaDB() Dialect

+ func MySQL() Dialect

+ func Oracle() Dialect

+ func PostgreSQL() Dialect

+ func SQLite() Dialect

+ type EventBus struct

+ func NewEventBus(client *Client) *EventBus

+ func (eb *EventBus) CreateListener() (EventListener, error)

+ type EventListener interface

+ Close func() error

+ Listen func(ctx context.Context, channel string) error

+ Receive func(ctx context.Context) (EventPayload, error)

+ Unlisten func(ctx context.Context, channel string) error

+ type EventPayload struct

+ Channel string

+ Payload string

+ type ExecFunc func(ctx context.Context, exec Executor, sqlStr string, args []any) (sql.Result, error)

+ type Executor interface

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

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

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

+ type FieldMeta = schema.FieldMeta

+ type Limits struct

+ AllowRawQueries bool

+ MaxJoins int

+ MaxQueryLength int

+ MaxResults int

+ MaxWhereConditions int

+ QueryTimeout time.Duration

+ SafeMigrations bool

+ func DefaultLimits() Limits

+ type MSSQLDialect struct

+ func (d *MSSQLDialect) Name() string

+ func (m *MSSQLDialect) AlterTableAddColumn(table, column, dataType string) string

+ func (m *MSSQLDialect) AlterTableAlterColumn(table, column, newDataType string) string

+ func (m *MSSQLDialect) AlterTableDropColumn(table, column string) string

+ func (m *MSSQLDialect) BuildProcedureCall(procedure string, argCount int) string

+ func (m *MSSQLDialect) BuildRoutineQuery(routine string, argCount int) string

+ func (m *MSSQLDialect) CurrentTimestamp() string

+ func (m *MSSQLDialect) JSONExtract(column, path string) string

+ func (m *MSSQLDialect) LastInsertIDQuery(table, pkColumn string) string

+ func (m *MSSQLDialect) LimitOffset(limit, offset int) string

+ func (m *MSSQLDialect) Placeholder(index int) string

+ func (m *MSSQLDialect) Placeholders(n int) []string

+ func (m *MSSQLDialect) Quote(identifier string) string

+ func (m *MSSQLDialect) RenameColumn(table, oldName, newName string) string

+ func (m *MSSQLDialect) RenameTable(oldName, newName string) string

+ func (m *MSSQLDialect) Returning(columns ...string) string

+ func (m *MSSQLDialect) SupportsLastInsertID() bool

+ func (m *MSSQLDialect) SupportsReturning() bool

+ func (m *MSSQLDialect) SupportsTransactionalDDL() bool

+ func (m *MSSQLDialect) UpsertSQL(conflictCols, updateCols []string, _ int) string

+ type MariaDBDialect struct

+ func (d *MariaDBDialect) Name() string

+ func (m *MariaDBDialect) AlterTableAlterColumn(table, column, newDataType string) string

+ func (m *MariaDBDialect) CreateSequence(name string, start, increment int64) string

+ func (m *MariaDBDialect) CreateSystemVersionedTable(table string, columnDefs string) string

+ func (m *MariaDBDialect) HistoryBetween(table, from, to string) string

+ func (m *MariaDBDialect) HistoryQuery(table string) string

+ func (m *MariaDBDialect) JSONExtract(column, path string) string

+ func (m *MariaDBDialect) JSONTable(source, path string, columns ...string) string

+ func (m *MariaDBDialect) LastInsertIDQuery(table, pkColumn string) string

+ func (m *MariaDBDialect) LimitOffset(limit, offset int) string

+ func (m *MariaDBDialect) NextVal(sequenceName string) string

+ func (m *MariaDBDialect) RenameColumn(table, oldName, newName string) string

+ func (m *MariaDBDialect) Returning(columns ...string) string

+ func (m *MariaDBDialect) SupportsLastInsertID() bool

+ func (m *MariaDBDialect) SupportsReturning() bool

+ func (m *MariaDBDialect) SupportsTransactionalDDL() bool

+ func (m *MariaDBDialect) UpsertSQL(conflictCols, updateCols []string, argOffset int) string

+ type Middleware interface

+ WrapExec func(next ExecFunc) ExecFunc

+ WrapQuery func(next QueryFunc) QueryFunc

+ WrapQueryRow func(next QueryRowFunc) QueryRowFunc

+ type ModelMeta = schema.ModelMeta

+ func GetModelMetaByType(t reflect.Type) *ModelMeta

+ func GetModelMeta[T any]() *ModelMeta

+ type MySQLDialect struct

+ func (d *MySQLDialect) Name() string

+ func (m *MySQLDialect) AlterTableAddColumn(table, column, dataType string) string

+ func (m *MySQLDialect) AlterTableAlterColumn(table, column, newDataType string) string

+ func (m *MySQLDialect) AlterTableDropColumn(table, column string) string

+ func (m *MySQLDialect) BuildProcedureCall(procedure string, argCount int) string

+ func (m *MySQLDialect) BuildRoutineQuery(routine string, argCount int) string

+ func (m *MySQLDialect) CurrentTimestamp() string

+ func (m *MySQLDialect) JSONExtract(column, path string) string

+ func (m *MySQLDialect) LastInsertIDQuery(table, pkColumn string) string

+ func (m *MySQLDialect) LimitOffset(limit, offset int) string

+ func (m *MySQLDialect) Placeholder(index int) string

+ func (m *MySQLDialect) Placeholders(n int) []string

+ func (m *MySQLDialect) Quote(identifier string) string

+ func (m *MySQLDialect) RenameColumn(table, oldName, newName string) string

+ func (m *MySQLDialect) RenameTable(oldName, newName string) string

+ func (m *MySQLDialect) Returning(columns ...string) string

+ func (m *MySQLDialect) SupportsLastInsertID() bool

+ func (m *MySQLDialect) SupportsReturning() bool

+ func (m *MySQLDialect) SupportsTransactionalDDL() bool

+ func (m *MySQLDialect) UpsertSQL(conflictCols, updateCols []string, _ int) string

+ type Option func(*Client)

+ func WithCacheStore(s CacheStore) Option

+ func WithDialect(d Dialect) Option

+ func WithLimits(l Limits) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMiddleware(m Middleware) Option

+ func WithQueryObserver(o QueryObserver) Option

+ type OracleDialect struct

+ func (d *OracleDialect) Name() string

+ func (o *OracleDialect) AlterTableAddColumn(table, column, dataType string) string

+ func (o *OracleDialect) AlterTableAlterColumn(table, column, newDataType string) string

+ func (o *OracleDialect) AlterTableDropColumn(table, column string) string

+ func (o *OracleDialect) BuildProcedureCall(procedure string, argCount int) string

+ func (o *OracleDialect) BuildRoutineQuery(routine string, argCount int) string

+ func (o *OracleDialect) CurrentTimestamp() string

+ func (o *OracleDialect) JSONExtract(column, path string) string

+ func (o *OracleDialect) LastInsertIDQuery(table, pkColumn string) string

+ func (o *OracleDialect) LimitOffset(limit, offset int) string

+ func (o *OracleDialect) Placeholder(index int) string

+ func (o *OracleDialect) Placeholders(n int) []string

+ func (o *OracleDialect) Quote(identifier string) string

+ func (o *OracleDialect) RenameColumn(table, oldName, newName string) string

+ func (o *OracleDialect) RenameTable(oldName, newName string) string

+ func (o *OracleDialect) Returning(columns ...string) string

+ func (o *OracleDialect) SupportsLastInsertID() bool

+ func (o *OracleDialect) SupportsReturning() bool

+ func (o *OracleDialect) SupportsTransactionalDDL() bool

+ func (o *OracleDialect) UpsertSQL(conflictCols, updateCols []string, _ int) string

+ type Page struct

+ Items []T

+ Page int

+ PageSize int

+ Total int64

+ TotalPages int64

+ type PostgresDialect struct

+ func (d *PostgresDialect) Name() string

+ func (p *PostgresDialect) AlterTableAddColumn(table, column, dataType string) string

+ func (p *PostgresDialect) AlterTableAlterColumn(table, column, newDataType string) string

+ func (p *PostgresDialect) AlterTableDropColumn(table, column string) string

+ func (p *PostgresDialect) BuildProcedureCall(procedure string, argCount int) string

+ func (p *PostgresDialect) BuildRoutineQuery(routine string, argCount int) string

+ func (p *PostgresDialect) CurrentTimestamp() string

+ func (p *PostgresDialect) JSONExtract(column, path string) string

+ func (p *PostgresDialect) LastInsertIDQuery(table, pkColumn string) string

+ func (p *PostgresDialect) LimitOffset(limit, offset int) string

+ func (p *PostgresDialect) Placeholder(index int) string

+ func (p *PostgresDialect) Placeholders(n int) []string

+ func (p *PostgresDialect) Quote(identifier string) string

+ func (p *PostgresDialect) RenameColumn(table, oldName, newName string) string

+ func (p *PostgresDialect) RenameTable(oldName, newName string) string

+ func (p *PostgresDialect) Returning(columns ...string) string

+ func (p *PostgresDialect) SupportsLastInsertID() bool

+ func (p *PostgresDialect) SupportsReturning() bool

+ func (p *PostgresDialect) SupportsTransactionalDDL() bool

+ func (p *PostgresDialect) UpsertSQL(conflictCols, updateCols []string, _ int) string

+ type Query struct

+ func ForTx[T any](ctx context.Context, tx *Tx) *Query[T]

+ func For[T any](ctx context.Context, provider ClientProvider) *Query[T]

+ func (q *Query[T]) Apply(scopes ...Scope[T]) *Query[T]

+ func (q *Query[T]) Avg(column string) (float64, error)

+ func (q *Query[T]) Cache(ttl time.Duration, tags ...string) *Query[T]

+ func (q *Query[T]) Count() (int64, error)

+ func (q *Query[T]) Create(entity *T) error

+ func (q *Query[T]) CreateBatch(entities []*T) error

+ func (q *Query[T]) Cursor() (*Cursor[T], error)

+ func (q *Query[T]) Delete(entity *T) (int64, error)

+ func (q *Query[T]) DeleteBatch(ids []any) (int64, error)

+ func (q *Query[T]) DeleteBy() (int64, error)

+ func (q *Query[T]) Distinct() *Query[T]

+ func (q *Query[T]) Find(id any) (T, error)

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

+ func (q *Query[T]) GroupBy(columns ...string) *Query[T]

+ func (q *Query[T]) HardDelete(entity *T) (int64, error)

+ func (q *Query[T]) Having(column string, operator string, value any) *Query[T]

+ func (q *Query[T]) Iter(fn func(T) error) error

+ func (q *Query[T]) Join(table, on string) *Query[T]

+ func (q *Query[T]) LeftJoin(table, on string) *Query[T]

+ func (q *Query[T]) Limit(n int) *Query[T]

+ func (q *Query[T]) List() ([]T, error)

+ func (q *Query[T]) Max(column string) (float64, error)

+ func (q *Query[T]) Min(column string) (float64, error)

+ func (q *Query[T]) Offset(n int) *Query[T]

+ func (q *Query[T]) Or(fn func(*Query[T]) *Query[T]) *Query[T]

+ func (q *Query[T]) OrderBy(column string, direction string) *Query[T]

+ func (q *Query[T]) Paginate(pageSize, page int) (*Page[T], error)

+ func (q *Query[T]) Preload(relations ...string) *Query[T]

+ func (q *Query[T]) RightJoin(table, on string) *Query[T]

+ func (q *Query[T]) Select(columns ...string) *Query[T]

+ func (q *Query[T]) Sum(column string) (float64, error)

+ func (q *Query[T]) Unscoped() *Query[T]

+ func (q *Query[T]) Update(entity *T) (int64, error)

+ func (q *Query[T]) UpdateBatch(entities []*T) error

+ func (q *Query[T]) UpdateMap(data map[string]any) (int64, error)

+ func (q *Query[T]) Upsert(entity *T, conflictCols []string, updateCols []string) error

+ func (q *Query[T]) UpsertBatch(entities []*T, conflictCols []string, updateCols []string) error

+ func (q *Query[T]) Where(column string, operator string, value any) *Query[T]

+ func (q *Query[T]) WhereBetween(column string, start, end any) *Query[T]

+ func (q *Query[T]) WhereIn(column string, values []any) *Query[T]

+ func (q *Query[T]) WhereJSON(column, path, operator string, value any) *Query[T]

+ func (q *Query[T]) WhereNot(column string, operator string, value any) *Query[T]

+ func (q *Query[T]) WhereSubquery(column, operator, subquery string) *Query[T]

+ type QueryEvent struct

+ Args []any

+ Duration time.Duration

+ Error error

+ Operation string

+ Rows int64

+ SQL string

+ Table string

+ type QueryFunc func(ctx context.Context, exec Executor, sqlStr string, args []any) (*sql.Rows, error)

+ type QueryObserver interface

+ ObserveQuery func(event QueryEvent)

+ type QueryRowFunc func(ctx context.Context, exec Executor, sqlStr string, args []any) *sql.Row

+ type RelationMeta = schema.RelationMeta

+ type Routine struct

+ func NewRoutine[T any](ctx context.Context, provider ClientProvider, routine string, args ...any) *Routine[T]

+ func (r *Routine[T]) First() (T, error)

+ func (r *Routine[T]) List() ([]T, error)

+ func (r *Routine[T]) Scalar() (T, error)

+ type SQLGuard = guard.SQLGuard

+ func NewSQLGuard() *SQLGuard

+ type SQLiteDialect struct

+ func (d *SQLiteDialect) Name() string

+ func (s *SQLiteDialect) AlterTableAddColumn(table, column, dataType string) string

+ func (s *SQLiteDialect) AlterTableAlterColumn(table, column, newDataType string) string

+ func (s *SQLiteDialect) AlterTableDropColumn(table, column string) string

+ func (s *SQLiteDialect) BuildProcedureCall(procedure string, argCount int) string

+ func (s *SQLiteDialect) BuildRoutineQuery(routine string, argCount int) string

+ func (s *SQLiteDialect) CurrentTimestamp() string

+ func (s *SQLiteDialect) JSONExtract(column, path string) string

+ func (s *SQLiteDialect) LastInsertIDQuery(table, pkColumn string) string

+ func (s *SQLiteDialect) LimitOffset(limit, offset int) string

+ func (s *SQLiteDialect) Placeholder(index int) string

+ func (s *SQLiteDialect) Placeholders(n int) []string

+ func (s *SQLiteDialect) Quote(identifier string) string

+ func (s *SQLiteDialect) RenameColumn(table, oldName, newName string) string

+ func (s *SQLiteDialect) RenameTable(oldName, newName string) string

+ func (s *SQLiteDialect) Returning(columns ...string) string

+ func (s *SQLiteDialect) SupportsLastInsertID() bool

+ func (s *SQLiteDialect) SupportsReturning() bool

+ func (s *SQLiteDialect) SupportsTransactionalDDL() bool

+ func (s *SQLiteDialect) UpsertSQL(conflictCols, updateCols []string, _ int) string

+ type Scope func(*Query[T]) *Query[T]

+ type SyncOptions struct

+ DryRun bool

+ NoTransaction bool

+ type TenantConfig struct

+ BaseClient *Client

+ MaxCachedPools int

+ Strategy TenantStrategy

+ TenantColumn string

+ func DefaultTenantConfig() TenantConfig

+ type TenantRouter struct

+ func NewTenantRouter(config TenantConfig, resolver func(ctx context.Context) string, ...) *TenantRouter

+ func (r *TenantRouter) ActiveTenants() []string

+ func (r *TenantRouter) GetClient(ctx context.Context) (*Client, error)

+ func (r *TenantRouter) ResolveTenant(ctx context.Context) (string, error)

+ type TenantStrategy int

+ const DatabasePerTenant

+ const RowLevelSecurity

+ const SchemaPerTenant

+ type Tx struct

+ func (t *Tx) Commit() error

+ func (t *Tx) ReleaseSavepoint(name string) error

+ func (t *Tx) Rollback() error

+ func (t *Tx) RollbackTo(name string) error

+ func (t *Tx) Savepoint(name string) error

+ func (t *Tx) Tx(ctx context.Context, fn func(tx *Tx) error) error

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