psqlutil

Documentation

Overview

Package psqlutil provides PostgreSQL utility functions, offering the most common operations in the PSQL ecosystem.

Index

• Variables
• func ComposeDSN(host, port, user, password, dbName, sslMode string) string
• func GormOpen(ctx context.Context, zapLogger *zap.Logger, driver string, postgresDSN string) (*gorm.DB, error)
• func MustNewSQL(db *sql.DB, err error) *sql.DB
• func ReadSchema(projectDirectoryName string) (string, error)
• func SQLOpen(ctx context.Context, driver, postgresDSN string) (*sql.DB, error)

Variables

var ErrDirectoryNotFound = errors.New("wallee directory not found")

ErrDirectoryNotFound is returned when the project directory is not found.

var ErrUnableToResolveCaller = errors.New("unable to resolve caller")

ErrUnableToResolveCaller is returned when the caller CWD cannot be retrieved.

Functions

func ComposeDSN

func ComposeDSN(
	host,
	port,
	user,
	password,
	dbName,
	sslMode string,
) string

ComposeDSN returns a PostgreSQL Data Source Name.

func GormOpen

func GormOpen(
	ctx context.Context,
	zapLogger *zap.Logger,
	driver string,
	postgresDSN string,
) (*gorm.DB, error)

GormOpen opens a new db connection and returns a *gorm.DB.

func MustNewSQL

func MustNewSQL(db *sql.DB, err error) *sql.DB

MustNewSQL panics if err is not nil, otherwise it returns db.

func ReadSchema

func ReadSchema(projectDirectoryName string) (string, error)

ReadSchema reads schema dynamically based on the CWD of the caller.

func SQLOpen

func SQLOpen(
	ctx context.Context,
	driver,
	postgresDSN string,
) (*sql.DB, error)

SQLOpen opens a new db connection and returns a *sql.DB with a gorm driver.