sql

Documentation

Index

• func BuilderFor(db *sql.DB, driver Driver, preparedStatementsEnabled bool) sq.StatementBuilderType
• func WithMigrate(o *Options)
• func WithSSLDisabled(o *Options)
• type Driver
  • func Open(cfg config.Config, opts ...Option) (*sql.DB, Driver, error)
  • func (d Driver) AdaptError(err error) error
  • func (d Driver) String() string
• type JSONField
  • func (f *JSONField[T]) Scan(v any) error
  • func (f *JSONField[T]) Value() (driver.Value, error)
• type Migrator
  • func NewMigrator(cfg config.Config, logger *zap.Logger) (*Migrator, error)
  • func (m *Migrator) Close() (source, db error)
  • func (m *Migrator) Drop() error
  • func (m *Migrator) Up(force bool) error
• type NullableTimestamp
  • func (t *NullableTimestamp) Scan(value interface{}) error
  • func (t *NullableTimestamp) Value() (driver.Value, error)
• type Option
• type Options
• type Timestamp
  • func (t *Timestamp) Scan(value interface{}) error
  • func (t *Timestamp) Value() (driver.Value, error)

Functions

func BuilderFor

func BuilderFor(db *sql.DB, driver Driver, preparedStatementsEnabled bool) sq.StatementBuilderType

BuilderFor returns a squirrel statement builder which decorates the provided sql.DB configured for the provided driver.

func WithMigrate

func WithMigrate(o *Options)

func WithSSLDisabled

func WithSSLDisabled(o *Options)

Types

type Driver

type Driver uint8

Driver represents a database driver

const (

	// SQLite ...
	SQLite Driver
	// Postgres ...
	Postgres
	// MySQL ...
	MySQL
	// CockroachDB ...
	CockroachDB
)

func Open

func Open(cfg config.Config, opts ...Option) (*sql.DB, Driver, error)

Open opens a connection to the db

func (Driver) AdaptError

func (d Driver) AdaptError(err error) error

AdaptError converts specific known-driver errors into wrapped storage errors.

func (Driver) String

func (d Driver) String() string

type JSONField

type JSONField[T any] struct {
	T T
}

func (*JSONField[T]) Scan

func (f *JSONField[T]) Scan(v any) error

func (*JSONField[T]) Value

func (f *JSONField[T]) Value() (driver.Value, error)

type Migrator

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

Migrator is responsible for migrating the database schema

func NewMigrator

func NewMigrator(cfg config.Config, logger *zap.Logger) (*Migrator, error)

NewMigrator creates a new Migrator

func (*Migrator) Close

func (m *Migrator) Close() (source, db error)

Close closes the source and db

func (*Migrator) Drop

func (m *Migrator) Drop() error

Drop drops the database

func (*Migrator) Up

func (m *Migrator) Up(force bool) error

Up runs any pending migrations

type NullableTimestamp

type NullableTimestamp Timestamp

func (*NullableTimestamp) Scan

func (t *NullableTimestamp) Scan(value interface{}) error

func (*NullableTimestamp) Value

func (t *NullableTimestamp) Value() (driver.Value, error)

type Option

type Option func(*Options)

type Options

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

type Timestamp

type Timestamp struct {
	*timestamppb.Timestamp
}

func (*Timestamp) Scan

func (t *Timestamp) Scan(value interface{}) error

func (*Timestamp) Value

func (t *Timestamp) Value() (driver.Value, error)