datastore

Documentation

Index

• func NewDB(n Name) (*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 Datastorer
• type MockDatastore
  • func NewMockDatastore() *MockDatastore
  • func (mds *MockDatastore) BeginTx(_ context.Context) (*sql.Tx, error)
  • func (mds *MockDatastore) CommitTx(_ *sql.Tx) error
  • func (mds *MockDatastore) DB() *sql.DB
  • func (mds *MockDatastore) RollbackTx(_ *sql.Tx, err error) error
  • func (mds *MockDatastore) Tx() (*sql.Tx, error)
• type Name
  • func (n Name) String() string

Functions

func NewDB

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

NewDB 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 database

func NewDatastore

func NewDatastore(db *sql.DB) *Datastore

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

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 Datastorer

type Datastorer interface {
	DB() *sql.DB
	BeginTx(context.Context) (*sql.Tx, error)
	RollbackTx(*sql.Tx, error) error
	CommitTx(*sql.Tx) error
}

Datastorer is an interface for working with the Database

type MockDatastore

type MockDatastore struct {
}

MockDatastore is a mock implementation for a database

func NewMockDatastore

func NewMockDatastore() *MockDatastore

func (*MockDatastore) BeginTx

func (mds *MockDatastore) BeginTx(_ context.Context) (*sql.Tx, error)

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

func (*MockDatastore) CommitTx

func (mds *MockDatastore) CommitTx(_ *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 (*MockDatastore) DB

func (mds *MockDatastore) DB() *sql.DB

func (*MockDatastore) RollbackTx

func (mds *MockDatastore) RollbackTx(_ *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.

func (*MockDatastore) Tx

func (mds *MockDatastore) Tx() (*sql.Tx, error)

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

type Name

type Name int

DSName defines the name for the Datastore

const (
	// LocalDatastore represents the local PostgreSQL db
	LocalDatastore Name = 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
	// MockedDatastore represents a Mocked Database
	MockedDatastore
)

func (Name) String

func (n Name) String() string