datastore

Documentation

Overview

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

Index

• func NewNullInt64(i int64) sql.NullInt64
• func NewNullString(s string) sql.NullString
• func NewPostgreSQLDB(dsn PostgreSQLDSN, logger zerolog.Logger) (*sql.DB, func(), error)
• type Datastore
  • func NewDatastore(db *sql.DB) Datastore
  • func (ds Datastore) BeginTx(ctx context.Context) (*sql.Tx, error)
  • func (ds Datastore) CommitTx(tx *sql.Tx) error
  • func (ds Datastore) DB() *sql.DB
  • func (ds Datastore) RollbackTx(tx *sql.Tx, err error) error
• type PostgreSQLDSN
  • func NewPostgreSQLDSN(host, dbname, user, password string, port int) PostgreSQLDSN
  • func (dsn PostgreSQLDSN) String() string

Functions

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

func NewPostgreSQLDB

func NewPostgreSQLDB(dsn PostgreSQLDSN, logger zerolog.Logger) (*sql.DB, func(), error)

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

Types

type Datastore

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

Datastore is a concrete implementation for a sql database

func NewDatastore

func NewDatastore(db *sql.DB) Datastore

NewDatastore is an initializer for the Datastore struct

func (Datastore) BeginTx

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

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

func (Datastore) CommitTx

func (ds Datastore) 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 (Datastore) DB

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

DB returns the sql.Db for the Datastore struct

func (Datastore) RollbackTx

func (ds Datastore) 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 PostgreSQLDSN

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

PostgreSQLDSN is a PostgreSQL datasource name

func NewPostgreSQLDSN

func NewPostgreSQLDSN(host, dbname, user, password string, port int) PostgreSQLDSN

NewPostgreSQLDSN is an initializer for PostgreSQLDSN

func (PostgreSQLDSN) String

func (dsn PostgreSQLDSN) 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.