repositories

Documentation

Index

• Constants
• func GenerateConnectionStr(v *viper.Viper, vs *vault.Secrets) string
• type Database
  • func ConnectDB(ctx context.Context, v *VaultDB) (*Database, error)
  • func NewDatabase(db *sqlx.DB) *Database
  • func (d *Database) Close() error
  • func (d *Database) PingContext(ctx context.Context) error
  • func (d *Database) Reconnect(ctx context.Context, db *sqlx.DB) error
• type VaultDB

Constants

const (
	EnvDbConnStr = "DB_CONN_STR"
	EnvRedisHost = "REDIS_HOST"
)

Functions

func GenerateConnectionStr

func GenerateConnectionStr(v *viper.Viper, vs *vault.Secrets) string

Types

type Database

type Database struct {
	*sqlx.DB
	*sync.RWMutex
}

func ConnectDB

func ConnectDB(ctx context.Context, v *VaultDB) (*Database, error)

ConnectDB connects to the database

func NewDatabase

func NewDatabase(db *sqlx.DB) *Database

NewDatabase establishes a database connection with the given Vault credentials

func (*Database) Close

func (d *Database) Close() error

func (*Database) PingContext

func (d *Database) PingContext(ctx context.Context) error

func (*Database) Reconnect

func (d *Database) Reconnect(ctx context.Context, db *sqlx.DB) error

Reconnect will be called periodically to refresh the database connection since the dynamic credentials expire after some time, it will:

1. construct a connection string using the given credentials
2. establish a database connection
3. close & replace the existing connection with the new one behind a mutex

type VaultDB

type VaultDB struct {
	Client         vault.Client
	Vip            *viper.Viper
	Enabled        bool
	CurrentSecrets *vault.Secrets
}