datastore

Documentation

Overview

Package datastore is used to interact with a datastore. It has functions to help setup a sql.DB as well as helpers for working with the sql.DB once it's initialized.

Index

• func NewDB(dsn PGDatasourceName, logger zerolog.Logger) (*sql.DB, func(), error)
• func NewNullInt64(i int64) sql.NullInt64
• func NewNullString(s string) sql.NullString
• type Datastorer
• type DefaultDatastore
  • func NewDefaultDatastore(db *sql.DB) DefaultDatastore
  • func (ds DefaultDatastore) BeginTx(ctx context.Context) (*sql.Tx, error)
  • func (ds DefaultDatastore) CommitTx(tx *sql.Tx) error
  • func (ds DefaultDatastore) DB() *sql.DB
  • func (ds DefaultDatastore) RollbackTx(tx *sql.Tx, err error) error
• type PGDatasourceName
  • func NewPGDatasourceName(host, dbname, user, password string, port int) PGDatasourceName
  • func (dsn PGDatasourceName) String() string

Functions

func NewDB

func NewDB(dsn PGDatasourceName, logger zerolog.Logger) (*sql.DB, func(), error)

NewDB returns an open database handle of 0 or more underlying PostgreSQL connections

func NewNullInt64

func NewNullInt64(i int64) sql.NullInt64

NewNullInt64 returns a null if i == 0, otherwise it returns the int64 which was input.

func NewNullString

func NewNullString(s string) sql.NullString

NewNullString returns a null if s is empty, otherwise it returns the string which was input

Types

type Datastorer

type Datastorer interface {
	// DB returns a sql.DB
	DB() *sql.DB
	// BeginTx starts a sql.Tx using the input context
	BeginTx(context.Context) (*sql.Tx, error)
	// RollbackTx rolls back the input sql.Tx
	RollbackTx(*sql.Tx, error) error
	// CommitTx commits the Tx
	CommitTx(*sql.Tx) error
}

Datastorer is an interface for working with the Database

type DefaultDatastore

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

DefaultDatastore is a concrete implementation for a sql database

func NewDefaultDatastore

func NewDefaultDatastore(db *sql.DB) DefaultDatastore

NewDefaultDatastore is an initializer for the default Datastore struct

func (DefaultDatastore) BeginTx

func (ds DefaultDatastore) BeginTx(ctx context.Context) (*sql.Tx, error)

BeginTx is a wrapper for sql.DB.BeginTx in order to expose from the Datastore interface

func (DefaultDatastore) CommitTx

func (ds DefaultDatastore) CommitTx(tx *sql.Tx) error

CommitTx is a wrapper for sql.Tx.Commit in order to expose from the Datastore interface. Proper error handling is also considered.

func (DefaultDatastore) DB

func (ds DefaultDatastore) DB() *sql.DB

DB returns the sql.Db for the Datastore struct

func (DefaultDatastore) RollbackTx

func (ds DefaultDatastore) RollbackTx(tx *sql.Tx, err error) error

RollbackTx is a wrapper for sql.Tx.Rollback in order to expose from the Datastore interface. Proper error handling is also considered.

type PGDatasourceName

type PGDatasourceName struct {
	Host     string
	Port     int
	DBName   string
	User     string
	Password string
}

PGDatasourceName is a Postgres datasource name

func NewPGDatasourceName

func NewPGDatasourceName(host, dbname, user, password string, port int) PGDatasourceName

NewPGDatasourceName is an initializer for PGDatasourceName, which is a struct that holds the PostgreSQL datasource name details.

func (PGDatasourceName) String

func (dsn PGDatasourceName) String() string

String returns a formatted PostgreSQL datasource name. If you are using a local db with no password, it removes the password from the string, otherwise the connection will fail.