storage

Documentation

Index

• func MakeDSN(params ConnParams) string
• func UnsetDefaultConnection()
• type ConnParams
• type Connection
  • func CreateTestConn(params ConnParams) (*Connection, func())
  • func InitConn(params ConnParams) *Connection
  • func (c *Connection) Close() error
  • func (c *Connection) Connect() error
  • func (c *Connection) CreateDB(dbName string) error
  • func (c *Connection) DropDB(dbName string) error
  • func (c *Connection) MigrateDown()
  • func (c *Connection) MigrateUp()
  • func (c *Connection) SetDefaultConnection()
  • func (c *Connection) SpawnConn(dbName string) (*Connection, error)
  • func (c *Connection) Truncate(tables []string)
• type Handler

Functions

func MakeDSN

func MakeDSN(params ConnParams) string

MakeDSN generates DSN string from ConnParams.

func UnsetDefaultConnection

func UnsetDefaultConnection()

Types

type ConnParams

type ConnParams struct {
	Connection string
	DBName     string
	Options    string
}

ConnParams are accepted by InitConn, containing database server parameters.

type Connection

type Connection struct {
	DB *sqlx.DB
	// contains filtered or unexported fields
}

Connection holds connection data.

var Conn *Connection

Conn holds a global database connection.

func CreateTestConn

func CreateTestConn(params ConnParams) (*Connection, func())

CreateTestConn creates a temporary test database and returns a connection object for accessing it plus a cleanup callback that should be deferredly called by function caller for properly getting rid of this temporary database.

func InitConn

func InitConn(params ConnParams) *Connection

InitConn initializes a module-level connection object.

func (*Connection) Close

func (c *Connection) Close() error

Close terminates the database server connection.

func (*Connection) Connect

func (c *Connection) Connect() error

Connect initiates a connection to the database server defined in c.params.

func (*Connection) CreateDB

func (c *Connection) CreateDB(dbName string) error

CreateDB creates the requested database.

func (*Connection) DropDB

func (c *Connection) DropDB(dbName string) error

DropDB drops the requested database.

func (*Connection) MigrateDown

func (c *Connection) MigrateDown()

MigrateDown undoes the previous migration.

func (*Connection) MigrateUp

func (c *Connection) MigrateUp()

MigrateUp executes forward migrations.

func (*Connection) SetDefaultConnection

func (c *Connection) SetDefaultConnection()

SetDefaultConnection sets global database connection object that other packages can import and utilize. You want to call that once in your main.go (or another entrypoint) after the physical DB connection has been established.

func (*Connection) SpawnConn

func (c *Connection) SpawnConn(dbName string) (*Connection, error)

SpawnConn creates a connection to another database on the same server.

func (*Connection) Truncate

func (c *Connection) Truncate(tables []string)

Truncate purges records from the requested tables.

type Handler

type Handler interface {
	MigrateUp()
	MigrateDown()
	Connect()
}

Handler implements the app database handler.