sqldb

Oct 6, 2025

Changes in this version

+ var ErrMigrationMismatch = fmt.Errorf(...)

+ func CompareRecords(original, migrated any, identifier string) error

+ func ExecuteBatchQuery[I any, T any, R any](ctx context.Context, cfg *QueryConfig, inputItems []I, ...) error

+ func ExecuteCollectAndBatchWithSharedDataQuery[C any, T any, I any, D any](ctx context.Context, cfg *QueryConfig, initialCursor C, ...) error

+ func ExecutePaginatedQuery[C any, T any](ctx context.Context, cfg *QueryConfig, initialCursor C, ...) error

+ func ExtractSqlInt16[T constraints.Integer](num sql.NullInt16) T

+ func SQLBool(b bool) sql.NullBool

+ func SQLInt16[T constraints.Integer](num T) sql.NullInt16

+ func SQLStrValid(s string) sql.NullString

+ type BatchQueryFunc func(context.Context, []T) ([]R, error)

+ type CollectAndBatchDataQueryFunc func(context.Context, []ID) (BatchData, error)

+ type CollectFunc func(T) (ID, error)

+ type ConvertFunc func(I) T

+ type CursorExtractFunc func(T) C

+ type ItemCallbackFunc func(context.Context, R) error

+ type ItemProcessFunc func(context.Context, T) error

+ type ItemWithBatchDataProcessFunc func(context.Context, T, BatchData) error

+ type PagedQueryFunc func(context.Context, C, int32) ([]T, error)

+ type QueryConfig struct

+ MaxBatchSize uint32

+ MaxPageSize uint32

+ func DefaultPostgresConfig() *QueryConfig

+ func DefaultSQLiteConfig() *QueryConfig

+ func (c *QueryConfig) Validate(sqlite bool) error

type SqliteConfig

+ func (p *SqliteConfig) Validate() error

Jun 10, 2025

Changes in this version

+ var NoOpReset = func()

type TxOptions

+ func ReadTxOpt() TxOptions

+ func WriteTxOpt() TxOptions

Mar 28, 2025

Changes in this version

type MigrationExecutor

+ GetSchemaVersion func() (int, bool, error)

+ SetSchemaVersion func(version int, dirty bool) error

type PostgresStore

+ func (s *PostgresStore) GetSchemaVersion() (int, bool, error)

+ func (s *PostgresStore) SetSchemaVersion(version int, dirty bool) error

type SqliteStore — darwin/amd64, linux/amd64, windows/amd64

+ func (s *SqliteStore) GetSchemaVersion() (int, bool, error)

+ func (s *SqliteStore) SetSchemaVersion(version int, dirty bool) error

Jan 31, 2025

Changes in this version

+ func ApplyMigrations(ctx context.Context, db *BaseDB, migrator MigrationExecutor, ...) error

+ type DB interface

+ ApplyAllMigrations func(ctx context.Context, customMigrations []MigrationConfig) error

+ GetBaseDB func() *BaseDB

+ type MigrationConfig struct

+ MigrationFn func(tx *sqlc.Queries) error

+ Name string

+ SchemaVersion int

+ Version int

+ func GetMigrations() []MigrationConfig

+ type MigrationExecutor interface

+ ExecuteMigrations func(target MigrationTarget) error

+ type MigrationTxOptions struct

+ func (m *MigrationTxOptions) ReadOnly() bool

type PostgresStore

+ func (s *PostgresStore) ApplyAllMigrations(ctx context.Context, migrations []MigrationConfig) error

+ func (s *PostgresStore) GetBaseDB() *BaseDB

type SqliteStore — darwin/amd64, linux/amd64, windows/amd64

+ func (s *SqliteStore) ApplyAllMigrations(ctx context.Context, migrations []MigrationConfig) error

+ func (s *SqliteStore) GetBaseDB() *BaseDB

type SqliteStore — js/wasm

+ func (s *SqliteStore) ApplyAllMigrations(context.Context, []MigrationConfig) error

Jul 9, 2024

Changes in this version

+ var TargetLatest = func(mig *migrate.Migrate) error

+ var TargetVersion = func(version uint) MigrationTarget

+ type MigrationTarget func(mig *migrate.Migrate) error

type PostgresStore — darwin/amd64, linux/amd64, windows/amd64

+ func NewTestPostgresDBWithVersion(t *testing.T, fixture *TestPgFixture, version uint) *PostgresStore

+ func (s *PostgresStore) ExecuteMigrations(target MigrationTarget) error

type SqliteStore — darwin/amd64, linux/amd64, windows/amd64

+ func NewTestSqliteDBWithVersion(t *testing.T, version uint) *SqliteStore

+ func (s *SqliteStore) ExecuteMigrations(target MigrationTarget) error

Apr 11, 2024

Changes in this version

+ const DefaultMaxRetryDelay

+ func ExecuteSQLTransactionWithRetry(ctx context.Context, makeTx MakeTx, rollbackTx RollbackTx, txBody TxBody, ...) error

+ type MakeTx func() (Tx, error)

+ type OnBackoff func(retry int, delay time.Duration)

+ type RollbackTx func(tx Tx) error

+ type TxBody func(tx Tx) error

Apr 10, 2024

Changes in this version

+ const DefaultNumTxRetries

+ const DefaultRetryDelay

+ const PostgresTag — darwin/amd64, linux/amd64, windows/amd64

+ const Subsystem

+ var DefaultPostgresFixtureLifetime = 10 * time.Minute

+ var DefaultStoreTimeout = time.Second * 10

+ var ErrRetriesExceeded = errors.New("db tx retries exceeded")

+ func DisableLog()

+ func IsSerializationError(err error) bool

+ func MapSQLError(err error) error

+ func SQLInt32[T constraints.Integer](num T) sql.NullInt32

+ func SQLInt64[T constraints.Integer](num T) sql.NullInt64

+ func SQLStr(s string) sql.NullString

+ func SQLTime(t time.Time) sql.NullTime

+ func UseLogger(logger btclog.Logger)

+ type BaseDB struct

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

+ type BatchedQuerier interface

+ BeginTx func(ctx context.Context, options TxOptions) (*sql.Tx, error)

+ type BatchedTx interface

+ ExecTx func(ctx context.Context, txOptions TxOptions, txBody func(Q) error) error

+ type ErrSQLUniqueConstraintViolation struct

+ DBError error

+ func (e ErrSQLUniqueConstraintViolation) Error() string

+ type ErrSerializationError struct

+ DBError error

+ func (e ErrSerializationError) Error() string

+ func (e ErrSerializationError) Unwrap() error

+ type PostgresConfig struct

+ Dsn string

+ MaxConnections int

+ SkipMigrations bool

+ Timeout time.Duration

+ func (p *PostgresConfig) Validate() error

+ type PostgresStore struct

+ func NewPostgresStore(cfg *PostgresConfig) (*PostgresStore, error)

+ func NewTestPostgresDB(t *testing.T, fixture *TestPgFixture) *PostgresStore

+ type QueryCreator func(*sql.Tx) Q

+ type SqliteConfig struct

+ BusyTimeout time.Duration

+ MaxConnections int

+ PragmaOptions []string

+ SkipMigrations bool

+ Timeout time.Duration

+ type SqliteStore struct

+ func NewSqliteStore(cfg *SqliteConfig, dbPath string) (*SqliteStore, error)

+ func NewTestSqliteDB(t *testing.T) *SqliteStore

+ type TestPgFixture struct — darwin/amd64, linux/amd64, windows/amd64

+ func NewTestPgFixture(t *testing.T, expiry time.Duration) *TestPgFixture

+ func (f *TestPgFixture) GetConfig(dbName string) *PostgresConfig

+ func (f *TestPgFixture) TearDown(t *testing.T)

+ type TransactionExecutor struct

+ func NewTransactionExecutor[Querier any](db BatchedQuerier, createQuery QueryCreator[Querier], opts ...TxExecutorOption) *TransactionExecutor[Querier]

+ func (t *TransactionExecutor[Q]) ExecTx(ctx context.Context, txOptions TxOptions, txBody func(Q) error) error

+ type Tx interface

+ Commit func() error

+ Rollback func() error

+ type TxExecutorOption func(*txExecutorOptions)

+ func WithTxRetries(numRetries int) TxExecutorOption

+ func WithTxRetryDelay(delay time.Duration) TxExecutorOption

+ type TxOptions interface

+ ReadOnly func() bool