database

Documentation

Index

• Constants
• Variables
• func Close(db *gorm.DB) (err error)
• func Open(enforceFKs bool) (db *gorm.DB, err error)
• type Conn
  • func (c *Conn) Begin() (tx driver.Tx, err error)
  • func (c *Conn) BeginTx(ctx context.Context, opts driver.TxOptions) (tx driver.Tx, err error)
  • func (c *Conn) Close() (err error)
  • func (c *Conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (r driver.Result, err error)
  • func (c *Conn) IsValid() (b bool)
  • func (c *Conn) Ping(ctx context.Context) (err error)
  • func (c *Conn) Prepare(query string) (stmt driver.Stmt, err error)
  • func (c *Conn) PrepareContext(ctx context.Context, query string) (stmt driver.Stmt, err error)
  • func (c *Conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (r driver.Rows, err error)
  • func (c *Conn) ResetSession(ctx context.Context) (err error)
• type Driver
  • func (d *Driver) Connect(context.Context) (conn driver.Conn, err error)
  • func (d *Driver) Driver() driver.Driver
  • func (d *Driver) Open(dsn string) (conn driver.Conn, err error)
  • func (d *Driver) OpenConnector(dsn string) (dc driver.Connector, err error)
• type PkSequence
  • func (r *PkSequence) Load(db *gorm.DB, models []any) (err error)
  • func (r *PkSequence) Next(db *gorm.DB) (id uint)
• type Stmt
  • func (s *Stmt) Close() (err error)
  • func (s *Stmt) Exec(args []driver.Value) (r driver.Result, err error)
  • func (s *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (r driver.Result, err error)
  • func (s *Stmt) NumInput() (n int)
  • func (s *Stmt) Query(args []driver.Value) (r driver.Rows, err error)
  • func (s *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (r driver.Rows, err error)
• type Tx
  • func (t *Tx) Commit() (err error)
  • func (t *Tx) Rollback() (err error)

Constants

const (
	ConnectionString = "file:%s?_journal=WAL"
	FKsOn            = "&_foreign_keys=yes"
	FKsOff           = "&_foreign_keys=no"
)

Variables

var Settings = &settings.Settings

Functions

func Close

func Close(db *gorm.DB) (err error)

Close the DB.

func Open

func Open(enforceFKs bool) (db *gorm.DB, err error)

Open and automigrate the DB.

Types

type Conn

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

Conn is a DB connection.

func (*Conn) Begin

func (c *Conn) Begin() (tx driver.Tx, err error)

Begin a transaction.

func (*Conn) BeginTx

func (c *Conn) BeginTx(ctx context.Context, opts driver.TxOptions) (tx driver.Tx, err error)

BeginTx begins a transaction.

func (*Conn) Close

func (c *Conn) Close() (err error)

Close the connection.

func (*Conn) ExecContext

func (c *Conn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (r driver.Result, err error)

ExecContext executes an SQL/DDL statement with context.

func (*Conn) IsValid

func (c *Conn) IsValid() (b bool)

IsValid returns true when the connection is valid. When true, the connection may be reused by the sql package.

func (*Conn) Ping

func (c *Conn) Ping(ctx context.Context) (err error)

Ping the DB.

func (*Conn) Prepare

func (c *Conn) Prepare(query string) (stmt driver.Stmt, err error)

Prepare a statement.

func (*Conn) PrepareContext

func (c *Conn) PrepareContext(ctx context.Context, query string) (stmt driver.Stmt, err error)

PrepareContext prepares a statement with context.

func (*Conn) QueryContext

func (c *Conn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (r driver.Rows, err error)

QueryContext execute a query with context.

func (*Conn) ResetSession

func (c *Conn) ResetSession(ctx context.Context) (err error)

ResetSession reset the connection. - Reset the Tx. - Release the mutex.

type Driver

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

Driver is a wrapper around the SQLite driver. The purpose is to prevent database locked errors using a mutex around write operations.

func (*Driver) Connect

func (d *Driver) Connect(context.Context) (conn driver.Conn, err error)

Connect opens a connection.

func (*Driver) Driver

func (d *Driver) Driver() driver.Driver

Driver returns the underlying driver.

func (*Driver) Open

func (d *Driver) Open(dsn string) (conn driver.Conn, err error)

Open a connection.

func (*Driver) OpenConnector

func (d *Driver) OpenConnector(dsn string) (dc driver.Connector, err error)

OpenConnector opens a connection.

type PkSequence

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

PkSequence provides a primary key sequence.

var PK PkSequence

PK singleton pk sequence.

func (*PkSequence) Load

func (r *PkSequence) Load(db *gorm.DB, models []any) (err error)

Load highest key for all models.

func (*PkSequence) Next

func (r *PkSequence) Next(db *gorm.DB) (id uint)

Next returns the next primary key.

type Stmt

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

Stmt is a SQL/DDL statement.

func (*Stmt) Close

func (s *Stmt) Close() (err error)

Close the statement.

func (*Stmt) Exec

func (s *Stmt) Exec(args []driver.Value) (r driver.Result, err error)

Exec executes the statement.

func (*Stmt) ExecContext

func (s *Stmt) ExecContext(ctx context.Context, args []driver.NamedValue) (r driver.Result, err error)

ExecContext executes the statement with context.

func (*Stmt) NumInput

func (s *Stmt) NumInput() (n int)

NumInput returns the number of (query) input parameters.

func (*Stmt) Query

func (s *Stmt) Query(args []driver.Value) (r driver.Rows, err error)

Query executes a query.

func (*Stmt) QueryContext

func (s *Stmt) QueryContext(ctx context.Context, args []driver.NamedValue) (r driver.Rows, err error)

QueryContext executes a query.

type Tx

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

Tx is a transaction.

func (*Tx) Commit

func (t *Tx) Commit() (err error)

Commit the transaction. Releases the mutex.

func (*Tx) Rollback

func (t *Tx) Rollback() (err error)

Rollback the transaction. Releases the mutex.