database

README

Database

The database module provides access to Pippin's database schema as well as a redis client.

ent is uses as an ORM, supporting postgres, mysql, and sqlite3 databases.

Documentation

Index

• Variables
• func GetRedisDB() *redisManager
• func NewEntClient(connInfo SqlDBConn) (*ent.Client, error)
• type MysqlConn
  • func (c *MysqlConn) DSN() string
  • func (c *MysqlConn) Dialect() string
• type PostgresConn
  • func (c *PostgresConn) DSN() string
  • func (c *PostgresConn) Dialect() string
• type SqlDBConn
  • func GetSqlDbConn(mock bool) (SqlDBConn, error)
• type SqliteConn
  • func (c *SqliteConn) DSN() string
  • func (c *SqliteConn) Dialect() string

Variables

var ErrLockNotObtained = errors.New("couldn't obtain lock")

var LockRetryStrategy = redislock.Options{
	RetryStrategy: redislock.LimitRetry(redislock.LinearBackoff(2*time.Second), 3),
}

Retry every 100ms, for up-to 3x

Functions

func GetRedisDB

func GetRedisDB() *redisManager

func NewEntClient

func NewEntClient(connInfo SqlDBConn) (*ent.Client, error)

Types

type MysqlConn

type MysqlConn struct {
	Host     string
	Port     string
	Password string
	User     string
	DBName   string
}

func (*MysqlConn) DSN

func (c *MysqlConn) DSN() string

func (*MysqlConn) Dialect

func (c *MysqlConn) Dialect() string

type PostgresConn

type PostgresConn struct {
	Host     string
	Port     string
	Password string
	User     string
	DBName   string
}

func (*PostgresConn) DSN

func (c *PostgresConn) DSN() string

func (*PostgresConn) Dialect

func (c *PostgresConn) Dialect() string

type SqlDBConn

type SqlDBConn interface {
	DSN() string
	Dialect() string
}

func GetSqlDbConn

func GetSqlDbConn(mock bool) (SqlDBConn, error)

Gets the DB connection information based on environment variables

type SqliteConn

type SqliteConn struct {
	FileName string
	Mode     string
}

func (*SqliteConn) DSN

func (c *SqliteConn) DSN() string

func (*SqliteConn) Dialect

func (c *SqliteConn) Dialect() string