dbsql

package

Go to main page

Versions in this module

v1

v1.5.9

Nov 3, 2025

v1.5.8

Oct 28, 2025

v1.5.7

Oct 6, 2025

v1.5.6

Jul 3, 2025

v1.5.5

May 22, 2025

v1.5.4

May 2, 2025

v1.5.3

May 1, 2025

v1.5.2

Apr 29, 2025

v1.5.1

Apr 24, 2025

Changes in this version

type SQLFeatures

+ CustomSequenceColumnFilter bool

v1.5.0

Apr 16, 2025

v1.4.15

Feb 3, 2025

v1.4.14

Dec 17, 2024

v1.4.13

Oct 24, 2024

v1.4.12

Oct 14, 2024

v1.4.11

Sep 13, 2024

v1.4.10

Sep 11, 2024

v1.4.9

Aug 28, 2024

v1.4.8

Jun 7, 2024

v1.4.7

May 24, 2024

Changes in this version

+ func BuildPostgreSQLOptimizedUpsert(ctx context.Context, table string, idColumn string, ...) (insert sq.InsertBuilder, err error)

type CrudBase

+ AfterLoad func(ctx context.Context, inst T) error

+ IDField string

+ func (c *CrudBase[T]) GetIDField() string

type Database

+ func (s *Database) RunAsQueryTx(ctx context.Context, table string, tx *TXWrapper, q sq.Sqlizer) (*sql.Rows, *TXWrapper, error)

type MockProviderConfig

+ FakePSQLUpsertOptimization bool

type SQLFeatures

+ DBOptimizedUpsertBuilder func(ctx context.Context, table string, idColumn string, ...) (sq.InsertBuilder, error)

type UpsertOptimization

+ const UpsertOptimizationDB

v1.4.6

Feb 29, 2024

Changes in this version

type CRUD

+ TableAlias func() string

type CrudBase

+ func (c *CrudBase[T]) TableAlias() string

type Database

+ func (s *Database) ExecTx(ctx context.Context, table string, tx *TXWrapper, sqlQuery string, ...) (sql.Result, error)

v1.4.5

Jan 24, 2024

v1.4.4

Jan 22, 2024

v1.4.3

Jan 16, 2024

v1.4.2

Jan 11, 2024

v1.4.1

Dec 21, 2023

Changes in this version

type CRUD

+ GetQueryFactory func() ffapi.QueryFactory

type CrudBase

+ DefaultSort func() []interface{}

+ func (c *CrudBase[T]) GetQueryFactory() ffapi.QueryFactory

type MockProviderConfig

+ MultiRowInsert bool

type TXWrapper

+ func GetTXFromContext(ctx context.Context) *TXWrapper

v1.4.0

Nov 21, 2023

Changes in this version

+ func InitSQLiteConfig(conf config.Section)

type CRUD

+ NewFilterBuilder func(ctx context.Context) ffapi.FilterBuilder

+ NewUpdateBuilder func(ctx context.Context) ffapi.UpdateBuilder

+ type CRUDQuery interface

+ Count func(ctx context.Context, filter ffapi.Filter) (count int64, err error)

+ GetByID func(ctx context.Context, id string, getOpts ...GetOption) (inst T, err error)

+ GetByName func(ctx context.Context, name string, getOpts ...GetOption) (instance T, err error)

+ GetByUUIDOrName func(ctx context.Context, uuidOrName string, getOpts ...GetOption) (result T, err error)

+ GetFirst func(ctx context.Context, filter ffapi.Filter, getOpts ...GetOption) (instance T, err error)

+ GetMany func(ctx context.Context, filter ffapi.Filter) (instances []T, fr *ffapi.FilterResult, err error)

+ GetSequenceForID func(ctx context.Context, id string) (seq int64, err error)

+ ModifyQuery func(modifier QueryModifier) CRUDQuery[T]

type CrudBase

+ func (c *CrudBase[T]) ModifyQuery(newModifier QueryModifier) CRUDQuery[T]

+ func (c *CrudBase[T]) NewFilterBuilder(ctx context.Context) ffapi.FilterBuilder

+ func (c *CrudBase[T]) NewUpdateBuilder(ctx context.Context) ffapi.UpdateBuilder

type Database

+ func NewSQLiteProvider(ctx context.Context, conf config.Section) (*Database, error)

+ type QueryModifier = func(sq.SelectBuilder) sq.SelectBuilder

v1.3.0

Sep 11, 2023

Changes in this version

+ func UUIDValidator(ctx context.Context, idStr string) error

type CRUD

+ GetByName func(ctx context.Context, name string, getOpts ...GetOption) (instance T, err error)

+ GetByUUIDOrName func(ctx context.Context, uuidOrName string, getOpts ...GetOption) (result T, err error)

+ GetFirst func(ctx context.Context, filter ffapi.Filter, getOpts ...GetOption) (instance T, err error)

+ Scoped func(scope sq.Eq) *CrudBase[T]

type CrudBase

+ IDValidator func(ctx context.Context, idStr string) error

+ NameField string

+ QueryFactory ffapi.QueryFactory

+ func (c *CrudBase[T]) GetByName(ctx context.Context, name string, getOpts ...GetOption) (instance T, err error)

+ func (c *CrudBase[T]) GetByUUIDOrName(ctx context.Context, uuidOrName string, getOpts ...GetOption) (result T, err error)

+ func (c *CrudBase[T]) GetFirst(ctx context.Context, filter ffapi.Filter, getOpts ...GetOption) (instance T, err error)

+ func (c *CrudBase[T]) Scoped(scope sq.Eq) *CrudBase[T]

v1.2.19

Jul 25, 2023

Changes in this version

+ type ILikeEscape sq.ILike

+ func (lk ILikeEscape) ToSql() (sql string, args []interface{}, err error)

+ type LikeEscape sq.Like

+ func (lk LikeEscape) ToSql() (sql string, args []interface{}, err error)

+ type NotILikeEscape sq.NotILike

+ func (lk NotILikeEscape) ToSql() (sql string, args []interface{}, err error)

+ type NotLikeEscape sq.NotLike

+ func (lk NotLikeEscape) ToSql() (sql string, args []interface{}, err error)

v1.2.18

Jun 30, 2023

Changes in this version

type CRUD

+ Count func(ctx context.Context, filter ffapi.Filter) (count int64, err error)

+ DeleteMany func(ctx context.Context, filter ffapi.Filter, hooks ...PostCompletionHook) (err error)

+ GetSequenceForID func(ctx context.Context, id string) (seq int64, err error)

type CrudBase

+ PatchDisabled bool

+ TimesDisabled bool

+ func (c *CrudBase[T]) Count(ctx context.Context, filter ffapi.Filter) (count int64, err error)

+ func (c *CrudBase[T]) DeleteMany(ctx context.Context, filter ffapi.Filter, hooks ...PostCompletionHook) (err error)

+ func (c *CrudBase[T]) GetSequenceForID(ctx context.Context, id string) (seq int64, err error)

+ type ResourceSequence interface

+ SetSequence func(int64)

v1.2.17

Jun 23, 2023

v1.2.16

Jun 15, 2023

v1.2.15

Jun 9, 2023

v1.2.14

Jun 7, 2023

v1.2.13

May 25, 2023

v1.2.12

May 25, 2023

Changes in this version

+ const ColumnCreated

+ const ColumnID

+ const ColumnUpdated

+ type CRUD interface

+ Delete func(ctx context.Context, id *fftypes.UUID, hooks ...PostCompletionHook) (err error)

+ GetByID func(ctx context.Context, id *fftypes.UUID, getOpts ...GetOption) (inst T, err error)

+ GetMany func(ctx context.Context, filter ffapi.Filter) (instances []T, fr *ffapi.FilterResult, err error)

+ Insert func(ctx context.Context, inst T, hooks ...PostCompletionHook) (err error)

+ InsertMany func(ctx context.Context, instances []T, allowPartialSuccess bool, ...) (err error)

+ Replace func(ctx context.Context, inst T, hooks ...PostCompletionHook) (err error)

+ Update func(ctx context.Context, id *fftypes.UUID, update ffapi.Update, ...) (err error)

+ UpdateMany func(ctx context.Context, filter ffapi.Filter, update ffapi.Update, ...) (err error)

+ UpdateSparse func(ctx context.Context, sparseUpdate T, hooks ...PostCompletionHook) (err error)

+ Upsert func(ctx context.Context, inst T, optimization UpsertOptimization, ...) (created bool, err error)

+ Validate func()

type CrudBase

+ ImmutableColumns []string

+ func (c *CrudBase[T]) UpdateSparse(ctx context.Context, sparseUpdate T, hooks ...PostCompletionHook) (err error)

+ func (c *CrudBase[T]) Validate()

+ type GetOption int

+ const FailIfNotFound

+ type MockProvider struct

+ func NewMockProvider() *MockProvider

+ func (mp *MockProvider) ApplyInsertQueryCustomizations(insert sq.InsertBuilder, _ bool) (sq.InsertBuilder, bool)

+ func (mp *MockProvider) Features() SQLFeatures

+ func (mp *MockProvider) GetMigrationDriver(_ *sql.DB) (migratedb.Driver, error)

+ func (mp *MockProvider) MigrationsDir() string

+ func (mp *MockProvider) Name() string

+ func (mp *MockProvider) Open(_ string) (*sql.DB, error)

+ func (mp *MockProvider) SequenceColumn() string

+ func (mp *MockProvider) UTInit() (*MockProvider, sqlmock.Sqlmock)

+ type MockProviderConfig struct

+ FakePSQLInsert bool

+ GetMigrationDriverError error

+ IndividualSort bool

+ OpenError error

+ type Resource interface

+ GetID func() *fftypes.UUID

+ SetCreated func(*fftypes.FFTime)

+ SetUpdated func(*fftypes.FFTime)

+ type ResourceBase struct

+ Created *fftypes.FFTime

+ ID *fftypes.UUID

+ Updated *fftypes.FFTime

+ func (r *ResourceBase) GetID() *fftypes.UUID

+ func (r *ResourceBase) SetCreated(t *fftypes.FFTime)

+ func (r *ResourceBase) SetUpdated(t *fftypes.FFTime)

v1.2.11

May 19, 2023

v1.2.10

May 3, 2023

v1.2.9

Apr 26, 2023

v1.2.8

Apr 25, 2023

Changes in this version

+ type ChangeEventType int

+ const Created

+ const Deleted

+ const Updated

+ type CrudBase struct

+ Columns []string

+ DB *Database

+ EventHandler func(id *fftypes.UUID, eventType ChangeEventType)

+ FilterFieldMap map[string]string

+ GetFieldPtr func(inst T, col string) interface{}

+ NewInstance func() T

+ NilValue func() T

+ ReadOnlyColumns []string

+ ReadQueryModifier func(sq.SelectBuilder) sq.SelectBuilder

+ ReadTableAlias string

+ ScopedFilter func() sq.Eq

+ Table string

+ func (c *CrudBase[T]) Delete(ctx context.Context, id *fftypes.UUID, hooks ...PostCompletionHook) (err error)

+ func (c *CrudBase[T]) GetByID(ctx context.Context, id *fftypes.UUID) (inst T, err error)

+ func (c *CrudBase[T]) GetMany(ctx context.Context, filter ffapi.Filter) (instances []T, fr *ffapi.FilterResult, err error)

+ func (c *CrudBase[T]) Insert(ctx context.Context, inst T, hooks ...PostCompletionHook) (err error)

+ func (c *CrudBase[T]) InsertMany(ctx context.Context, instances []T, allowPartialSuccess bool, ...) (err error)

+ func (c *CrudBase[T]) Replace(ctx context.Context, inst T, hooks ...PostCompletionHook) (err error)

+ func (c *CrudBase[T]) Update(ctx context.Context, id *fftypes.UUID, update ffapi.Update, ...) (err error)

+ func (c *CrudBase[T]) UpdateMany(ctx context.Context, filter ffapi.Filter, update ffapi.Update, ...) (err error)

+ func (c *CrudBase[T]) Upsert(ctx context.Context, inst T, optimization UpsertOptimization, ...) (err error)

+ type PostCompletionHook func()

+ type UpsertOptimization int

+ const UpsertOptimizationExisting

+ const UpsertOptimizationNew

+ const UpsertOptimizationSkip

+ type WithID interface

+ GetID func() *fftypes.UUID

v1.2.7

Mar 23, 2023

v1.2.6

Mar 21, 2023

v1.2.5

Mar 16, 2023

v1.2.4

Mar 15, 2023

v1.2.3

Mar 1, 2023

Changes in this version

type Database

+ func (s *Database) Features() SQLFeatures

v1.2.2

Feb 23, 2023

v1.2.2-28022023

Feb 28, 2023

v1.2.1

Jan 12, 2023

v1.2.0

Jan 12, 2023

v1.1.6

Jan 4, 2023

v1.1.5

Dec 5, 2022

Changes in this version

+ const SQLConfDatasourceURL

+ const SQLConfMaxConnIdleTime

+ const SQLConfMaxConnLifetime

+ const SQLConfMaxConnections

+ const SQLConfMaxIdleConns

+ const SQLConfMigrationsAuto

+ const SQLConfMigrationsDirectory

+ type Database struct

+ func (s *Database) AcquireLockTx(ctx context.Context, lockName string, tx *TXWrapper) error

+ func (s *Database) BeginOrUseTx(ctx context.Context) (ctx1 context.Context, tx *TXWrapper, autoCommit bool, err error)

+ func (s *Database) BuildUpdate(sel sq.UpdateBuilder, update ffapi.Update, typeMap map[string]string) (sq.UpdateBuilder, error)

+ func (s *Database) Close()

+ func (s *Database) CommitTx(ctx context.Context, tx *TXWrapper, autoCommit bool) error

+ func (s *Database) ConnLimit() int

+ func (s *Database) CountQuery(ctx context.Context, table string, tx *TXWrapper, fop sq.Sqlizer, ...) (count int64, err error)

+ func (s *Database) DB() *sql.DB

+ func (s *Database) DeleteTx(ctx context.Context, table string, tx *TXWrapper, q sq.DeleteBuilder, ...) error

+ func (s *Database) FilterSelect(ctx context.Context, tableName string, sel sq.SelectBuilder, ...) (sq.SelectBuilder, sq.Sqlizer, *ffapi.FilterInfo, error)

+ func (s *Database) FilterUpdate(ctx context.Context, update sq.UpdateBuilder, filter ffapi.Filter, ...) (sq.UpdateBuilder, error)

+ func (s *Database) Init(ctx context.Context, provider Provider, config config.Section) (err error)

+ func (s *Database) InitConfig(provider Provider, config config.Section)

+ func (s *Database) InsertTx(ctx context.Context, table string, tx *TXWrapper, q sq.InsertBuilder, ...) (int64, error)

+ func (s *Database) InsertTxExt(ctx context.Context, table string, tx *TXWrapper, q sq.InsertBuilder, ...) (int64, error)

+ func (s *Database) InsertTxRows(ctx context.Context, table string, tx *TXWrapper, q sq.InsertBuilder, ...) error

+ func (s *Database) Query(ctx context.Context, table string, q sq.SelectBuilder) (*sql.Rows, *TXWrapper, error)

+ func (s *Database) QueryRes(ctx context.Context, table string, tx *TXWrapper, fop sq.Sqlizer, ...) *ffapi.FilterResult

+ func (s *Database) QueryTx(ctx context.Context, table string, tx *TXWrapper, q sq.SelectBuilder) (*sql.Rows, *TXWrapper, error)

+ func (s *Database) RollbackTx(ctx context.Context, tx *TXWrapper, autoCommit bool)

+ func (s *Database) RunAsGroup(ctx context.Context, fn func(ctx context.Context) error) error

+ func (s *Database) SequenceColumn() string

+ func (s *Database) UpdateTx(ctx context.Context, table string, tx *TXWrapper, q sq.UpdateBuilder, ...) (int64, error)

+ type PreCommitAccumulator interface

+ PreCommit func(ctx context.Context, tx *TXWrapper) error

+ type Provider interface

+ ApplyInsertQueryCustomizations func(insert sq.InsertBuilder, requestConflictEmptyResult bool) (updatedInsert sq.InsertBuilder, runAsQuery bool)

+ Features func() SQLFeatures

+ GetMigrationDriver func(*sql.DB) (migratedb.Driver, error)

+ MigrationsDir func() string

+ Name func() string

+ Open func(url string) (*sql.DB, error)

+ SequenceColumn func() string

+ type SQLFeatures struct

+ AcquireLock func(lockName string) string

+ MultiRowInsert bool

+ PlaceholderFormat sq.PlaceholderFormat

+ UseILIKE bool

+ func DefaultSQLProviderFeatures() SQLFeatures

+ type TXWrapper struct

+ func (tx *TXWrapper) AddPostCommitHook(fn func())

+ func (tx *TXWrapper) PreCommitAccumulator() PreCommitAccumulator

+ func (tx *TXWrapper) SetPreCommitAccumulator(pca PreCommitAccumulator)

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