plain

README

lesiw.io/plain

A micro-framework for building applications with plain, simple, SQL.

Currently, only pgx/v5 (PostgreSQL) is supported.

Structure

Statements go in sql/statements. One statement per file. Only files ending in .sql will be used.

Migrations go in sql/migrations. Refer to the golang-migrate documentation.

Configuration

Use the libpq environment variables to configure your database connection. These are automatically understood by pgx.

Usage

Add this to the top of your application's main.go:

//go:generate go run lesiw.io/plain/cmd/plaingen@latest

Run go generate.

Use plain.ConnectPgx(context.Context) *pgxPool.pool to establish a connection to the database.

Import internal/stmt as access the SQL statements written in sql/statements.

Example

See lesiw.io/smol.

Documentation

Index

• Variables
• func ConnectPgx(ctx context.Context) (pool *pgxpool.Pool)

Variables

var MigrationFS fs.FS

Functions

func ConnectPgx

func ConnectPgx(ctx context.Context) (pool *pgxpool.Pool)

ConnectPgx connects to the database.

Database connection information should be specified by setting standard PostgreSQL environment variables, e.g. PGHOST, PGUSER, PGPASSWORD, PGDATABASE.

Blocks until a connection has been achieved to prevent application thrashing.