sql

Documentation

Overview

Code generated by MockGen. DO NOT EDIT. Source: ./interface.go

Generated by this command:

mockgen -typed -package=sql -destination=./mocks.go -source=./interface.go

Package sql is a generated GoMock package.

Index

• Variables
• func Vacuum(db Executor) error
• type Database
  • func InMemory(opts ...Opt) *Database
  • func Open(uri string, opts ...Opt) (*Database, error)
  • func (db *Database) Close() error
  • func (db *Database) Exec(query string, encoder Encoder, decoder Decoder) (int, error)
  • func (db *Database) Tx(ctx context.Context) (*Tx, error)
  • func (db *Database) TxImmediate(ctx context.Context) (*Tx, error)
  • func (db *Database) WithTx(ctx context.Context, exec func(*Tx) error) error
  • func (db *Database) WithTxImmediate(ctx context.Context, exec func(*Tx) error) error
• type Decoder
• type Encoder
• type Executor
• type Migration
  • func LocalMigrations() ([]Migration, error)
  • func StateMigrations() ([]Migration, error)
• type MigrationApplyCall
  • func (c *MigrationApplyCall) Do(f func(Executor) error) *MigrationApplyCall
  • func (c *MigrationApplyCall) DoAndReturn(f func(Executor) error) *MigrationApplyCall
  • func (c *MigrationApplyCall) Return(arg0 error) *MigrationApplyCall
• type MigrationNameCall
  • func (c *MigrationNameCall) Do(f func() string) *MigrationNameCall
  • func (c *MigrationNameCall) DoAndReturn(f func() string) *MigrationNameCall
  • func (c *MigrationNameCall) Return(arg0 string) *MigrationNameCall
• type MigrationOrderCall
  • func (c *MigrationOrderCall) Do(f func() int) *MigrationOrderCall
  • func (c *MigrationOrderCall) DoAndReturn(f func() int) *MigrationOrderCall
  • func (c *MigrationOrderCall) Return(arg0 int) *MigrationOrderCall
• type MigrationRollbackCall
  • func (c *MigrationRollbackCall) Do(f func() error) *MigrationRollbackCall
  • func (c *MigrationRollbackCall) DoAndReturn(f func() error) *MigrationRollbackCall
  • func (c *MigrationRollbackCall) Return(arg0 error) *MigrationRollbackCall
• type MockMigration
  • func NewMockMigration(ctrl *gomock.Controller) *MockMigration
  • func (m *MockMigration) Apply(db Executor) error
  • func (m *MockMigration) EXPECT() *MockMigrationMockRecorder
  • func (m *MockMigration) Name() string
  • func (m *MockMigration) Order() int
  • func (m *MockMigration) Rollback() error
• type MockMigrationMockRecorder
  • func (mr *MockMigrationMockRecorder) Apply(db any) *MigrationApplyCall
  • func (mr *MockMigrationMockRecorder) Name() *MigrationNameCall
  • func (mr *MockMigrationMockRecorder) Order() *MigrationOrderCall
  • func (mr *MockMigrationMockRecorder) Rollback() *MigrationRollbackCall
• type Opt
  • func WithConnections(n int) Opt
  • func WithLatencyMetering(enable bool) Opt
  • func WithMigration(migration Migration) Opt
  • func WithMigrations(migrations []Migration) Opt
  • func WithSkipMigrations(i ...int) Opt
  • func WithVacuumState(i int) Opt
• type Statement
• type Tx
  • func (tx *Tx) Commit() error
  • func (tx *Tx) Exec(query string, encoder Encoder, decoder Decoder) (int, error)
  • func (tx *Tx) Release() error

Variables

var (
	// ErrNoConnection is returned if pooled connection is not available.
	ErrNoConnection = errors.New("database: no free connection")
	// ErrNotFound is returned if requested record is not found.
	ErrNotFound = errors.New("database: not found")
	// ErrObjectExists is returned if database constraints didn't allow to insert an object.
	ErrObjectExists = errors.New("database: object exists")
)

Functions

func Vacuum

func Vacuum(db Executor) error

Types

type Database

type Database struct {
	// contains filtered or unexported fields
}

Database is an instance of sqlite database.

func InMemory

func InMemory(opts ...Opt) *Database

InMemory database for testing.

func Open

func Open(uri string, opts ...Opt) (*Database, error)

Open database with options.

Database is opened in WAL mode and pragma synchronous=normal. https://sqlite.org/wal.html https://www.sqlite.org/pragma.html#pragma_synchronous

func (*Database) Close

func (db *Database) Close() error

Close closes all pooled connections.

func (*Database) Exec

func (db *Database) Exec(query string, encoder Encoder, decoder Decoder) (int, error)

Exec statement using one of the connection from the pool.

If you care about atomicity of the operation (for example writing rewards to multiple accounts) Tx should be used. Otherwise sqlite will not guarantee that all side-effects of operations are applied to the database if machine crashes.

Note that Exec will block until database is closed or statement has finished. If application needs to control statement execution lifetime use one of the transaction.

func (*Database) Tx

func (db *Database) Tx(ctx context.Context) (*Tx, error)

Tx creates deferred sqlite transaction.

Deferred transactions are not started until the first statement. Transaction may be started in read mode and automatically upgraded to write mode after one of the write statements.

https://www.sqlite.org/lang_transaction.html

func (*Database) TxImmediate

func (db *Database) TxImmediate(ctx context.Context) (*Tx, error)

TxImmediate creates immediate transaction.

IMMEDIATE cause the database connection to start a new write immediately, without waiting for a write statement. The BEGIN IMMEDIATE might fail with SQLITE_BUSY if another write transaction is already active on another database connection.

func (*Database) WithTx

func (db *Database) WithTx(ctx context.Context, exec func(*Tx) error) error

WithTx will pass initialized deferred transaction to exec callback. Will commit only if error is nil.

func (*Database) WithTxImmediate

func (db *Database) WithTxImmediate(ctx context.Context, exec func(*Tx) error) error

WithTxImmediate will pass initialized immediate transaction to exec callback. Will commit only if error is nil.

type Decoder

type Decoder func(*Statement) bool

Decoder for sqlite rows.

type Encoder

type Encoder func(*Statement)

Encoder for parameters. Both positional parameters: select block from blocks where id = ?1;

and named parameters are supported: select blocks from blocks where id = @id;

For complete information see https://www.sqlite.org/c3ref/bind_blob.html.

type Executor

type Executor interface {
	Exec(string, Encoder, Decoder) (int, error)
}

Executor is an interface for executing raw statement.

type Migration

type Migration interface {
	Apply(db Executor) error
	Rollback() error
	Name() string
	Order() int
}

Migration is interface for migrations provider.

func LocalMigrations

func LocalMigrations() ([]Migration, error)

func StateMigrations

func StateMigrations() ([]Migration, error)

type MigrationApplyCall

type MigrationApplyCall struct {
	*gomock.Call
}

MigrationApplyCall wrap *gomock.Call

func (*MigrationApplyCall) Do

func (c *MigrationApplyCall) Do(f func(Executor) error) *MigrationApplyCall

Do rewrite *gomock.Call.Do

func (*MigrationApplyCall) DoAndReturn

func (c *MigrationApplyCall) DoAndReturn(f func(Executor) error) *MigrationApplyCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MigrationApplyCall) Return

func (c *MigrationApplyCall) Return(arg0 error) *MigrationApplyCall

Return rewrite *gomock.Call.Return

type MigrationNameCall

type MigrationNameCall struct {
	*gomock.Call
}

MigrationNameCall wrap *gomock.Call

func (*MigrationNameCall) Do

func (c *MigrationNameCall) Do(f func() string) *MigrationNameCall

Do rewrite *gomock.Call.Do

func (*MigrationNameCall) DoAndReturn

func (c *MigrationNameCall) DoAndReturn(f func() string) *MigrationNameCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MigrationNameCall) Return

func (c *MigrationNameCall) Return(arg0 string) *MigrationNameCall

Return rewrite *gomock.Call.Return

type MigrationOrderCall

type MigrationOrderCall struct {
	*gomock.Call
}

MigrationOrderCall wrap *gomock.Call

func (*MigrationOrderCall) Do

func (c *MigrationOrderCall) Do(f func() int) *MigrationOrderCall

Do rewrite *gomock.Call.Do

func (*MigrationOrderCall) DoAndReturn

func (c *MigrationOrderCall) DoAndReturn(f func() int) *MigrationOrderCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MigrationOrderCall) Return

func (c *MigrationOrderCall) Return(arg0 int) *MigrationOrderCall

Return rewrite *gomock.Call.Return

type MigrationRollbackCall

type MigrationRollbackCall struct {
	*gomock.Call
}

MigrationRollbackCall wrap *gomock.Call

func (*MigrationRollbackCall) Do

func (c *MigrationRollbackCall) Do(f func() error) *MigrationRollbackCall

Do rewrite *gomock.Call.Do

func (*MigrationRollbackCall) DoAndReturn

func (c *MigrationRollbackCall) DoAndReturn(f func() error) *MigrationRollbackCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MigrationRollbackCall) Return

func (c *MigrationRollbackCall) Return(arg0 error) *MigrationRollbackCall

Return rewrite *gomock.Call.Return

type MockMigration

type MockMigration struct {
	// contains filtered or unexported fields
}

MockMigration is a mock of Migration interface.

func NewMockMigration

func NewMockMigration(ctrl *gomock.Controller) *MockMigration

NewMockMigration creates a new mock instance.

func (*MockMigration) Apply

func (m *MockMigration) Apply(db Executor) error

Apply mocks base method.

func (*MockMigration) EXPECT

func (m *MockMigration) EXPECT() *MockMigrationMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMigration) Name

func (m *MockMigration) Name() string

Name mocks base method.

func (*MockMigration) Order

func (m *MockMigration) Order() int

Order mocks base method.

func (*MockMigration) Rollback

func (m *MockMigration) Rollback() error

Rollback mocks base method.

type MockMigrationMockRecorder

type MockMigrationMockRecorder struct {
	// contains filtered or unexported fields
}

MockMigrationMockRecorder is the mock recorder for MockMigration.

func (*MockMigrationMockRecorder) Apply

func (mr *MockMigrationMockRecorder) Apply(db any) *MigrationApplyCall

Apply indicates an expected call of Apply.

func (*MockMigrationMockRecorder) Name

func (mr *MockMigrationMockRecorder) Name() *MigrationNameCall

Name indicates an expected call of Name.

func (*MockMigrationMockRecorder) Order

func (mr *MockMigrationMockRecorder) Order() *MigrationOrderCall

Order indicates an expected call of Order.

func (*MockMigrationMockRecorder) Rollback

func (mr *MockMigrationMockRecorder) Rollback() *MigrationRollbackCall

Rollback indicates an expected call of Rollback.

type Opt

type Opt func(c *conf)

Opt for configuring database.

func WithConnections

func WithConnections(n int) Opt

WithConnections overwrites number of pooled connections.

func WithLatencyMetering

func WithLatencyMetering(enable bool) Opt

WithLatencyMetering enables metric that track latency for every database query. Note that it will be a significant amount of data, and should not be enabled on multiple nodes by default.

func WithMigration

func WithMigration(migration Migration) Opt

WithMigration adds migration to the list of migrations. It will overwrite an existing migration with the same order.

func WithMigrations

func WithMigrations(migrations []Migration) Opt

WithMigrations overwrites embedded migrations. Migrations are sorted by order before applying.

func WithSkipMigrations

func WithSkipMigrations(i ...int) Opt

WithSkipMigrations will update database version with executing associated migrations. It should be used at your own risk.

func WithVacuumState

func WithVacuumState(i int) Opt

WithVacuumState will execute vacuum if database version before the migration was less or equal to the provided value.

type Statement

type Statement = sqlite.Stmt

Statement is an sqlite statement.

type Tx

type Tx struct {
	// contains filtered or unexported fields
}

Tx is wrapper for database transaction.

func (*Tx) Commit

func (tx *Tx) Commit() error

Commit transaction.

func (*Tx) Exec

func (tx *Tx) Exec(query string, encoder Encoder, decoder Decoder) (int, error)

Exec query.

func (*Tx) Release

func (tx *Tx) Release() error

Release transaction. Every transaction that was created must be released.