database

Documentation

Overview

Package database helps with SQL database interactions.

Index

• func Open(cfg Config) (*sqlx.DB, error)
• func StatusCheck(ctx context.Context, db *sqlx.DB) error
• type Config

Functions

func Open

func Open(cfg Config) (*sqlx.DB, error)

Open knows how to open a database connection based on the configuration.

func StatusCheck

func StatusCheck(ctx context.Context, db *sqlx.DB) error

StatusCheck returns nil if it can successfully talk to the database. It returns a non-nil error otherwise.

Types

type Config

type Config struct {
	User       string
	Password   string
	Host       string
	Name       string
	DisableTLS bool
}

Config is the required properties to use the database.