datastore

Documentation

Index

• func NewDB(n DSName) (*sql.DB, func(), error)
• func NewMockDB(n DSName) *sql.DB
• type DS
  • func (db *DS) BeginTx(ctx context.Context) error
  • func (db *DS) CommitTx() error
  • func (db *DS) RollbackTx(err error) error
• type DSName
  • func (n DSName) String() string
• type Datastore
  • func NewDatastore(n DSName, db *sql.DB) (Datastore, error)
• type MockDS
  • func (db *MockDS) BeginTx(ctx context.Context) error
  • func (db *MockDS) CommitTx() error
  • func (db *MockDS) RollbackTx(err error) error
  • func (db *MockDS) Tx() (*sql.Tx, error)

Functions

func NewDB

func NewDB(n DSName) (*sql.DB, func(), error)

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

func NewMockDB

func NewMockDB(n DSName) *sql.DB

NewMockDB returns nil

Types

type DS

type DS struct {
	DB *sql.DB
	Tx *sql.Tx
}

DS is a concrete implementation for a database

func (*DS) BeginTx

func (db *DS) BeginTx(ctx context.Context) error

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

func (*DS) CommitTx

func (db *DS) CommitTx() error

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

func (*DS) RollbackTx

func (db *DS) RollbackTx(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 DSName

type DSName int

DSName defines the name for the Datastore

const (
	// LocalDatastore represents the local PostgreSQL db
	LocalDatastore DSName = iota
	// GCPCPDatastore represents a local connection to a GCP Cloud
	// SQL db through the Google Cloud Proxy
	GCPCPDatastore
	// GCPDatastore represents a true GCP connection to a GCP
	// Cloud SQL db
	GCPDatastore
	// MockDatastore represents a Mocked Database
	MockDatastore
)

func (DSName) String

func (n DSName) String() string

type Datastore

type Datastore interface {
	BeginTx(context.Context) error
	RollbackTx(error) error
	CommitTx() error
}

Datastore is an interface for working with the Database

func NewDatastore

func NewDatastore(n DSName, db *sql.DB) (Datastore, error)

NewDatastore provides either a DS struct, which has a concrete implementation of a database or a MockDS struct which is a mocked DB implementation

type MockDS

type MockDS struct {
}

MockDS is a mock implementation for a database

func (*MockDS) BeginTx

func (db *MockDS) BeginTx(ctx context.Context) error

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

func (*MockDS) CommitTx

func (db *MockDS) CommitTx() error

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

func (*MockDS) RollbackTx

func (db *MockDS) RollbackTx(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.

func (*MockDS) Tx

func (db *MockDS) Tx() (*sql.Tx, error)

Tx exposes the Tx stored in the struct in order to be exposed from the Datastore interface.