dbx

package
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package dbx carries what db knows about a model's tables to store and the batteries without widening db's public API: the indexes db.Table declares, SoftUnique and Unique, which store uses to name the field of a duplicate-key error and to resolve an upsert's conflict target, the plain tables a battery declares for its own schema, the statement observer telemetry attaches to a handle, and the batteries' migration files the chok command applies.

Index

Constants

This section is empty.

Variables

View Source
var Describe func(d any) Observed

Describe reads immutable metadata without publishing an observer.

View Source
var Indexes func(d any, t reflect.Type) []Index

Indexes returns the index metadata of model type t on a database handle, SoftUnique and Unique alike. Set by db at initialization; no model metadata is shared across handles.

View Source
var Migrations = map[string]fs.FS{}

Migrations maps the ledger owner of each battery schema — identity, rbac, jobs — to the versioned SQL files the battery registers with RegisterSchema. Each battery package adds its entry when it initializes, so the chok command, which links them, can report and apply a battery's migrations without the battery exporting them. It is written only during package initialization.

View Source
var Observe func(d any, o Observer) Observed

Observe, set by package db when it initializes, attaches o to the *db.DB d: from then on every statement of d runs o, in place of the observer attached before (nil detaches it). It returns what o needs to know about d.

View Source
var PlainTable func(model any) any

PlainTable, set by package db when it initializes, declares the table of a model that embeds no db model base — an append-only log, or a schema another library defines, such as casbin_rule — for a battery's RegisterSchema. It returns a db.TableSpec and panics on a model that db.Table takes, or on one without a primary key.

Functions

This section is empty.

Types

type Index

type Index struct {
	Name    string
	Columns []string
	// Soft marks a SoftUnique, UNIQUE(Columns..., delete_token), whose
	// upsert conflict target gains delete_token; a Unique is
	// UNIQUE(Columns...), and Columns are its target as they are.
	Soft bool
}

Index is one index db.Table declares: a SoftUnique or a Unique.

type Observed

type Observed struct {
	// Driver is the dialect: sqlite, mysql or postgres.
	Driver string
	// SlowThreshold is db.slow_threshold; 0 turns the slow-query log off.
	SlowThreshold time.Duration
	// Primary is the handle's connection pool; Readers is the separate
	// read pool of a SQLite file, nil otherwise.
	Primary, Readers *sql.DB
}

Observed describes the handle an Observer is attached to.

type Observer

type Observer interface {
	Before(tx *gorm.DB, op string)
	After(tx *gorm.DB, op string)
}

Observer watches every statement of a database handle; telemetry is the one implementation. Before runs just ahead of the statement and After right after it, both with gorm's statement in tx; op names the gorm callback chain: create, query, update, delete, row or raw.

Jump to

Keyboard shortcuts

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