entdb

package

v0.2.2 Latest Latest Go to latest Published: Dec 28, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Package entdb extends the ent db library and satisfies matt's needs for consistency

View Source

const (
	DefaultCacheTTL = 1 * time.Second
)

This section is empty.

func Healthcheck(client *entsql.Driver) func(ctx context.Context) error

Healthcheck pings the DB to check if the connection is working

func RegisterDatabaseFlags(v *viper.Viper, flags *pflag.FlagSet) error

RegisterDatabaseFlags registers the flags for the database configuration

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

EntClientConfig configures the entsql drivers

func NewDBConfig(c config.DB, l *zap.SugaredLogger) *EntClientConfig

NewDBConfig returns a new database configuration

func (c *EntClientConfig) GetPrimaryDB() *entsql.Driver

func (c *EntClientConfig) GetSecondaryDB() *entsql.Driver

func (c *EntClientConfig) NewMultiDriverDBClient(ctx context.Context, opts []ent.Option) (*ent.Client, error)

NewMultiDriverDBClient returns a ent client with a primary and secondary, if configured, write database

type MultiWriteDriver struct {
	// Wp (write-primary), Ws (write-secondary) Drivers
	Wp, Ws dialect.Driver
}

MultiWriteDriver allows you to write to a primary and secondary database

func (d *MultiWriteDriver) BeginTx(ctx context.Context, opts *sql.TxOptions) (dialect.Tx, error)

BeginTx adds an log-id for the transaction and calls the underlying driver BeginTx command if it is supported.

func (d *MultiWriteDriver) Close() error

Close the underlying connections

func (d *MultiWriteDriver) Dialect() string

Dialect returns the dialect name of the primary driver

func (d *MultiWriteDriver) Exec(ctx context.Context, query string, args, v any) error

Exec logs its params and calls the underlying driver Exec method for both write drivers

func (d *MultiWriteDriver) Query(ctx context.Context, query string, args, v any) error

Query will query the primary write database

func (d *MultiWriteDriver) Tx(ctx context.Context) (dialect.Tx, error)

Tx wraps the Exec and Query operations in transaction.