dbx

Documentation

Index

• func GetDatabase(dsn string) (string, error)
• func GetHost(dsn string) (string, error)
• func Scan[T any](rows Rows, pointers func(*T) []interface{}) ([]T, error)
• type ConnOpener
• type DB
  • func NewDB[T any](driverName string, dsns []string, connOpener ConnOpener[T], ...) (*DB[T], error)
  • func (db *DB[T]) Close()
  • func (db *DB[T]) Copy() *DB[T]
  • func (db *DB[T]) GetConn(ctx context.Context, strategy GetNodeStragegy) (T, error)
  • func (db *DB[T]) GetDefaultConn(ctx context.Context) (T, error)
  • func (db *DB[T]) GetReadFromConn(ctx context.Context) (T, error)
  • func (db *DB[T]) GetWriteToConn(ctx context.Context) (T, error)
• type DBxer
• type GetNodeStragegy
  • func NoWait(criteria cluster.NodeStateCriteria) GetNodeStragegy
  • func NoWaitAlive() GetNodeStragegy
  • func NoWaitPrimary() GetNodeStragegy
  • func NoWaitPrimaryPreferred() GetNodeStragegy
  • func NoWaitStandby() GetNodeStragegy
  • func NoWaitStandbyPreferred() GetNodeStragegy
  • func WaitForAlive() GetNodeStragegy
  • func WaitForPrimary() GetNodeStragegy
  • func WaitForPrimaryPreferred() GetNodeStragegy
  • func WaitForStandby() GetNodeStragegy
  • func WaitForStandbyPreferred() GetNodeStragegy
• type Option
  • func WithClusterOptions[T any](options ...cluster.ClusterOption[T]) Option[T]
  • func WithCtx[T any](ctx context.Context) Option[T]
  • func WithDefaultNodeStrategy[T any](strategy GetNodeStragegy) Option[T]
  • func WithNodeWaitTimeout[T any](timeout time.Duration) Option[T]
  • func WithReadFromNodeStrategy[T any](strategy GetNodeStragegy) Option[T]
  • func WithWriteToNodeStrategy[T any](strategy GetNodeStragegy) Option[T]
• type Row
• type Rows

Functions

func GetDatabase

func GetDatabase(dsn string) (string, error)

func GetHost

func GetHost(dsn string) (string, error)

func Scan

func Scan[T any](rows Rows, pointers func(*T) []interface{}) ([]T, error)

Types

type ConnOpener

type ConnOpener[T any] func(ctx context.Context, driverName string, dsn string) (T, error)

type DB

type DB[T any] struct {
	Cluster *cluster.Cluster[T]

	NodeWaitTimeout time.Duration

	WriteToNodeStrategy  GetNodeStragegy // This is used, when we can clearly guess, that query is a write query (for example, Exec())
	ReadFromNodeStrategy GetNodeStragegy // This is used, when we can clearly guess, that query is a read query (for example, Query())
	DefaultNodeStrategy  GetNodeStragegy // This is used, when we can not figure out, what type of request is formed (like Prepare())

	Ctx context.Context
	// contains filtered or unexported fields
}

func NewDB

func NewDB[T any](driverName string, dsns []string,
	connOpener ConnOpener[T],
	connCloser cluster.ConnCloser[T],
	nodeChecker cluster.NodeChecker[T],
	options ...Option[T]) (*DB[T], error)

func (*DB[T]) Close

func (db *DB[T]) Close()

Close closes all nodes in cluster.

func (*DB[T]) Copy

func (db *DB[T]) Copy() *DB[T]

func (*DB[T]) GetConn

func (db *DB[T]) GetConn(ctx context.Context, strategy GetNodeStragegy) (T, error)

func (*DB[T]) GetDefaultConn

func (db *DB[T]) GetDefaultConn(ctx context.Context) (T, error)

func (*DB[T]) GetReadFromConn

func (db *DB[T]) GetReadFromConn(ctx context.Context) (T, error)

func (*DB[T]) GetWriteToConn

func (db *DB[T]) GetWriteToConn(ctx context.Context) (T, error)

type DBxer

type DBxer[TConn any, TTx any, TTxOptions any] interface {
	DoTx(f func(db DBxer[TConn, TTx, TTxOptions]) error, opts TTxOptions) error
	DoTxContext(
		ctx context.Context,
		f func(ctx context.Context, db DBxer[TConn, TTx, TTxOptions]) error,
		opts TTxOptions) error
	Tx() (TTx, error)
	GetConn(ctx context.Context, strategy GetNodeStragegy) (TConn, error)
	GetWriteToConn(ctx context.Context) (TConn, error)
	GetReadFromConn(ctx context.Context) (TConn, error)
	GetDefaultConn(ctx context.Context) (TConn, error)
	Close()
}

type GetNodeStragegy

type GetNodeStragegy struct {
	Criteria cluster.NodeStateCriteria
	Wait     bool
}

func NoWait

func NoWait(criteria cluster.NodeStateCriteria) GetNodeStragegy

func NoWaitAlive

func NoWaitAlive() GetNodeStragegy

func NoWaitPrimary

func NoWaitPrimary() GetNodeStragegy

func NoWaitPrimaryPreferred

func NoWaitPrimaryPreferred() GetNodeStragegy

func NoWaitStandby

func NoWaitStandby() GetNodeStragegy

func NoWaitStandbyPreferred

func NoWaitStandbyPreferred() GetNodeStragegy

func WaitForAlive

func WaitForAlive() GetNodeStragegy

func WaitForPrimary

func WaitForPrimary() GetNodeStragegy

func WaitForPrimaryPreferred

func WaitForPrimaryPreferred() GetNodeStragegy

func WaitForStandby

func WaitForStandby() GetNodeStragegy

func WaitForStandbyPreferred

func WaitForStandbyPreferred() GetNodeStragegy

type Option

type Option[T any] func(*DB[T])

func WithClusterOptions

func WithClusterOptions[T any](options ...cluster.ClusterOption[T]) Option[T]

func WithCtx

func WithCtx[T any](ctx context.Context) Option[T]

func WithDefaultNodeStrategy

func WithDefaultNodeStrategy[T any](strategy GetNodeStragegy) Option[T]

func WithNodeWaitTimeout

func WithNodeWaitTimeout[T any](timeout time.Duration) Option[T]

func WithReadFromNodeStrategy

func WithReadFromNodeStrategy[T any](strategy GetNodeStragegy) Option[T]

func WithWriteToNodeStrategy

func WithWriteToNodeStrategy[T any](strategy GetNodeStragegy) Option[T]

type Row

type Row interface {
	Err() error
	Scan(dest ...any) error
}

type Rows

type Rows interface {
	Row
	Next() bool
}