database

package module

v0.5.1 Latest Latest Go to latest Published: Jan 12, 2022 License: MIT Imports: 12 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/loghole/database

Links

Open Source Insights

README ¶

db

Documentation ¶

Index ¶

type Config
- func (cfg *Config) DSN() (connStr string)
type DB
- func New(cfg *Config, options ...Option) (db *DB, err error)
- func (d *DB) RunTxx(ctx context.Context, fn TransactionFunc) error
type DBType
- func (d DBType) String() string
type Option
type RetryFunc
type TransactionFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Addr         string
	User         string
	Database     string
	CertPath     string
	Type         DBType
	ReadTimeout  string
	WriteTimeout string
}

func (*Config) DSN ¶ added in v0.3.0

func (cfg *Config) DSN() (connStr string)

type DB ¶

type DB struct {
	*sqlx.DB
	// contains filtered or unexported fields
}

func New ¶

func New(cfg *Config, options ...Option) (db *DB, err error)

func (*DB) RunTxx ¶

func (d *DB) RunTxx(ctx context.Context, fn TransactionFunc) error

type DBType ¶

type DBType string

const (
	PostgresDatabase   DBType = "postgres"
	ClickhouseDatabase DBType = "clickhouse"
	SQLiteDatabase     DBType = "sqlite3"
)

func (DBType) String ¶

func (d DBType) String() string

type Option ¶

type Option interface {
	// contains filtered or unexported methods
}

func WithCockroachRetryFunc ¶

func WithCockroachRetryFunc() Option

func WithCustomHook ¶

func WithCustomHook(hook dbhook.Hook) Option

func WithDefaultOptions ¶

func WithDefaultOptions(tracer opentracing.Tracer) Option

func WithMetricsHook ¶ added in v0.5.0

func WithMetricsHook(collector hooks.MetricCollector) Option

func WithPrometheusMetrics ¶ added in v0.5.0

func WithPrometheusMetrics() Option

func WithReconnectHook ¶

func WithReconnectHook() Option

func WithRetryFunc ¶

func WithRetryFunc(f RetryFunc) Option

func WithSimplerrHook ¶

func WithSimplerrHook() Option

func WithTracingHook ¶

func WithTracingHook(tracer opentracing.Tracer) Option

type RetryFunc ¶

type RetryFunc func(retryCount int, err error) bool

type TransactionFunc ¶

type TransactionFunc func(ctx context.Context, tx *sqlx.Tx) error

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
hooks
internal
dbsqlx
helpers
metrics
tests
reconnect command

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL