db

Documentation

Index

• func ApplySQLiteSessionPragmas(db *sql.DB) error
• func ConnectDB() (*sql.DB, error)
• func DefaultOperationTimeout() time.Duration
• func DefaultStatementTimeout() time.Duration
• func EnsurePostgresSchema(dbconn *sql.DB) error
• func NewOperationContext(parent context.Context) (context.Context, context.CancelFunc)
• func QueryWithOptionalForUpdate(dbconn *sql.DB, query string) string
• func QueryWithOptionalForUpdateNowait(dbconn *sql.DB, query string) string
• func QueryWithOptionalForUpdateSkipLocked(dbconn *sql.DB, query string) string
• func RunMigrations(dbconn *sql.DB) error
• func SupportsSelectForUpdate(dbconn *sql.DB) bool
• func SupportsSelectForUpdateNowait(dbconn *sql.DB) bool
• func SupportsSelectForUpdateSkipLocked(dbconn *sql.DB) bool
• type Backend
  • func BackendFromDB(dbconn *sql.DB) Backend
• type DBTX

Functions

func ApplySQLiteSessionPragmas

func ApplySQLiteSessionPragmas(db *sql.DB) error

func ConnectDB

func ConnectDB() (*sql.DB, error)

func DefaultOperationTimeout

func DefaultOperationTimeout() time.Duration

func DefaultStatementTimeout

func DefaultStatementTimeout() time.Duration

func EnsurePostgresSchema

func EnsurePostgresSchema(dbconn *sql.DB) error

EnsurePostgresSchema validates the runtime PostgreSQL schema. If COLDKEEP_DB_AUTO_BOOTSTRAP is enabled and schema_version is missing, it bootstraps by applying the embedded db/schema_postgres.sql.

func NewOperationContext

func NewOperationContext(parent context.Context) (context.Context, context.CancelFunc)

func QueryWithOptionalForUpdate

func QueryWithOptionalForUpdate(dbconn *sql.DB, query string) string

QueryWithOptionalForUpdate appends FOR UPDATE only for backends that support it.

func QueryWithOptionalForUpdateNowait

func QueryWithOptionalForUpdateNowait(dbconn *sql.DB, query string) string

QueryWithOptionalForUpdateNowait appends FOR UPDATE NOWAIT when supported.

func QueryWithOptionalForUpdateSkipLocked

func QueryWithOptionalForUpdateSkipLocked(dbconn *sql.DB, query string) string

QueryWithOptionalForUpdateSkipLocked appends FOR UPDATE SKIP LOCKED when supported.

func RunMigrations

func RunMigrations(dbconn *sql.DB) error

RunMigrations applies the embedded SQLite schema to a DB connection. It is intended for simulated/local SQLite contexts only.

func SupportsSelectForUpdate

func SupportsSelectForUpdate(dbconn *sql.DB) bool

SupportsSelectForUpdate reports whether SELECT ... FOR UPDATE is supported.

func SupportsSelectForUpdateNowait

func SupportsSelectForUpdateNowait(dbconn *sql.DB) bool

SupportsSelectForUpdateNowait reports whether FOR UPDATE NOWAIT is supported.

func SupportsSelectForUpdateSkipLocked

func SupportsSelectForUpdateSkipLocked(dbconn *sql.DB) bool

SupportsSelectForUpdateSkipLocked reports whether FOR UPDATE SKIP LOCKED is supported.

Types

type Backend

type Backend string

Backend identifies the SQL backend in use for a given *sql.DB.

const (
	BackendUnknown  Backend = "unknown"
	BackendPostgres Backend = "postgres"
	BackendSQLite   Backend = "sqlite"
)

func BackendFromDB

func BackendFromDB(dbconn *sql.DB) Backend

BackendFromDB detects the configured backend from the DB driver.

type DBTX

type DBTX interface {
	Exec(query string, args ...any) (sql.Result, error)
	QueryRow(query string, args ...any) *sql.Row
}

DBTX is implemented by *sql.DB and *sql.Tx (so we can reuse helpers inside a tx).