end
7647884464
Expand README with setup and API guidance, add CHANGELOG breaking section, and refresh package documentation for the V1 API surface. Co-authored-by: Cursor <cursoragent@cursor.com>
49 lines
1.8 KiB
Go
49 lines
1.8 KiB
Go
// Package dbx provides database utilities built on go-jet/jet and go-toolkit/app.
|
|
//
|
|
// # Module lifecycle
|
|
//
|
|
// Call [ModuleDB] once to register the database [app.Module], then use [SQLO]
|
|
// to access the connection pool. [CurrentDialect] reports the configured dialect.
|
|
// Only one database per process is supported.
|
|
//
|
|
// # Query and mutation helpers
|
|
//
|
|
// [Fetch], [FetchOne], [Insert], [Update], [Delete], and their Must* and Context
|
|
// variants wrap Jet [Statement] execution with consistent error semantics.
|
|
// [WithTx] runs a function inside a SQL transaction.
|
|
//
|
|
// # Jet column utilities
|
|
//
|
|
// Dialect-neutral type aliases ([Column], [ColumnList]) and helpers for column
|
|
// lists ([NormalCols], [ContainsCol]) and expression building ([ExprValues]).
|
|
//
|
|
// Partial-update helpers ([ApplyPtr], [ApplyVal]) track changed fields for
|
|
// repository patch logic.
|
|
//
|
|
// # Identifier types
|
|
//
|
|
// [StringKSUID] and [BinaryKSUID] wrap segmentio/ksuid with storage-specific
|
|
// SQL encoding. Both share identical GraphQL string transit. Choose StringKSUID
|
|
// for text columns (VARCHAR, TEXT); choose BinaryKSUID for binary columns
|
|
// (BINARY(20), BYTEA).
|
|
//
|
|
// [JSONB] provides map-based JSON column scanning for Postgres JSONB and MySQL JSON.
|
|
//
|
|
// # Pointer and string utilities
|
|
//
|
|
// [Ptr], [Val], [TrimPtr], [StringToFilter], and related helpers for nullable
|
|
// field handling in repository code.
|
|
//
|
|
// # Debug logging
|
|
//
|
|
// Enable [DBConfig.DebugLog] and blank-import dbxm (MySQL) or dbxp (Postgres)
|
|
// to register Jet query debug output. Setup returns an error if DebugLog is
|
|
// enabled without the matching blank import.
|
|
//
|
|
// # Dialect notes
|
|
//
|
|
// Use [Insert] with LastInsertId on MySQL; Postgres callers should use
|
|
// [InsertReturning]. [InsertReturning] and [UpdateReturning] require Jet
|
|
// RETURNING clauses.
|
|
package dbx
|