persist

README

Persist

Persist is a simple package that reduces boilerplate code when getting a pool of connections for a database.

This project does nothing particularly spectacular; it exists simply to save me writing the same 100 lines of code every time I need to connect to a database.

Currently, this project supports Postgres, MariaDB/MySQL, and sqlite.

Example usage

package main

import (
	"github.com/tsawler/persist"
	"log"
)

func main() {
	// Specify your connection string.
	dsn := "host=localhost port=5433 user=postgres password=password dbname=foo sslmode=disable"

	// Get a pool of connections. The first parameter can be "postgres", "mariadb", "mysql", or "sqlite".
	conn, err := persist.New("postgres", dsn, nil)
	if err != nil {
		log.Panic(err)
	}
	defer conn.Close()

	log.Println("Connected to db successfully.")
}

Documentation

Index

• Variables
• func BuildConnectionString(cd ConnectionData) (string, error)
• func New(db, dsn string, ops *Options) (*sql.DB, error)
• func NewMariaDB(dsn string, ops *Options) (*sql.DB, error)
• func NewPostgres(dsn string, ops *Options) (*sql.DB, error)
• func NewSQLite(dsn string, ops *Options) (*sql.DB, error)
• type ConnectionData
• type Options

Variables

var (
	MaxOpenConns    = 12              // Maximum number of open connections in our pool.
	MaxIdleConns    = 6               // Maximum idle connections in our pool.
	ConnMaxLifetime = 0 * time.Second // Max lifetime for a connection (how long before it expires). 0 is forever.
)

Functions

func BuildConnectionString

func BuildConnectionString(cd ConnectionData) (string, error)

BuildConnectionString takes information stored in a ConnectionData variable and builds a connection string for postgres/mysql.

func New

func New(db, dsn string, ops *Options) (*sql.DB, error)

New is a factory method which takes a db type, a DSN and options and attempts to open a connection to the database and return a pool of connections.

func NewMariaDB

func NewMariaDB(dsn string, ops *Options) (*sql.DB, error)

NewMariaDB is a convenience function for getting a pool of MariaDB/MySQL connections.

func NewPostgres

func NewPostgres(dsn string, ops *Options) (*sql.DB, error)

NewPostgres is a convenience function for getting a pool of Postgres connections.

func NewSQLite

func NewSQLite(dsn string, ops *Options) (*sql.DB, error)

NewSQLite is a convenience function for getting a pool of sqlite connections.

Types

type ConnectionData

type ConnectionData struct {
	DBType   string
	UserName string
	Password string
	Host     string
	Database string
	SSL      string
	Port     int
}

ConnectionData is the type used to hold information required to build a connection string.

type Options

type Options struct {
	MaxOpen     int
	MaxIdle     int
	MaxLifetime time.Duration
}

Options holds useful options for a pool of connections.