db

Documentation

Index

• type DB
  • func New(ctx context.Context, host string, port uint16, ...) (*DB, error)
  • func (db *DB) Close()
  • func (db *DB) Conn(ctx context.Context) (c *pgx.Conn, closer func(), err error)
  • func (db *DB) Tx(ctx context.Context) (tx pgx.Tx, closer func(error) error, err error)
• type Option
  • func WithConnTimeout(connTimeout time.Duration) Option
  • func WithMigrationsFs(migrationsFs fs.FS) Option
  • func WithSSL(ssl SSLMode) Option
  • func WithVersionTable(versionTable string) Option
• type Options
• type SSLMode
  • func (s *SSLMode) MarshalText() ([]byte, error)
  • func (s SSLMode) String() string
  • func (s *SSLMode) UnmarshalText(text []byte) error

Types

type DB

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

func New

func New(ctx context.Context, host string, port uint16, database, username, password string, options ...Option) (*DB, error)

func (*DB) Close

func (db *DB) Close()

func (*DB) Conn

func (db *DB) Conn(ctx context.Context) (c *pgx.Conn, closer func(), err error)

func (*DB) Tx

func (db *DB) Tx(ctx context.Context) (tx pgx.Tx, closer func(error) error, err error)

type Option

type Option func(*Options) error

func WithConnTimeout

func WithConnTimeout(connTimeout time.Duration) Option

func WithMigrationsFs

func WithMigrationsFs(migrationsFs fs.FS) Option

func WithSSL

func WithSSL(ssl SSLMode) Option

func WithVersionTable

func WithVersionTable(versionTable string) Option

type Options

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

type SSLMode

type SSLMode string

const (
	SSLModeDisable    SSLMode = "disable"
	SSLModeRequire    SSLMode = "require"
	SSLModeVerifyCA   SSLMode = "verify-ca"
	SSLModeVerifyFull SSLMode = "verify-full"
	SSLModePreferred  SSLMode = "prefer"
)

func (*SSLMode) MarshalText

func (s *SSLMode) MarshalText() ([]byte, error)

implemets encoding.TextMarshaler and TextUnmarshaler

func (SSLMode) String

func (s SSLMode) String() string

implement fmt.Stringer

func (*SSLMode) UnmarshalText

func (s *SSLMode) UnmarshalText(text []byte) error