golazy.dev – golazy.dev / pg / addon / postgres Index | Files | Directories

package postgres 

import "golazy.dev/pg/addon/postgres"

Package postgres registers the base PostgreSQL add-on for GoLazy apps.

Most applications install the add-on and its generated wiring from the project root: 

lazy add postgres

Applications that construct their add-on selection manually can use: 

app := lazyapp.New(lazyapp.Config{
	Addons: lazyaddon.Select(postgres.AddonID),
})

The add-on reads the connection URL from DATABASE_URL by default. To use a different environment variable, configure its name rather than placing the connection URL in add-on configuration: 

selection := lazyaddon.Selection{Addons: []lazyaddon.Use{{
	ID: postgres.AddonID,
	Config: map[string]string{
		"database_url_variable": "APP_DATABASE_URL",
	},
}}}
app := lazyapp.New(lazyapp.Config{Addons: selection})

During application initialization the add-on opens the pool, adds it to the dependency context, and configures the PostgreSQL migration backend. After lazyapp.New returns, another selected add-on can obtain the pool with: 

pool, err := lazyaddon.Require(app.Addons, postgres.PoolCapability)

Constants

const AddonID 

const (
	// AddonID is the stable manifest and runtime identity of the base
	// PostgreSQL add-on.
	AddonID = "postgres"
)

Variables

var PoolCapability, MigrationBackendCapability 

var (
	// PoolCapability publishes the application-owned PostgreSQL pool to other
	// selected add-ons without relying on a process-global singleton.
	PoolCapability	= lazyaddon.DefineCapability[*pgxpool.Pool](addonRegistration, "golazy.dev/pg/postgres/pool", 1)
	// MigrationBackendCapability publishes the PostgreSQL migration backend
	// after the migrations lifecycle hook has run.
	MigrationBackendCapability	= lazyaddon.DefineCapability[lazymigrate.Backend](addonRegistration, "golazy.dev/pg/postgres/migration-backend", 1)
)

var Version 

var (

	// Version is the add-on version shipped by this module release. The embedded
	// package manifest is the single version source updated by release tooling.
	Version = addonDefinition.Version
)

Directories

PathSynopsis
pg/addon/postgres/jobsPackage jobs registers the PostgreSQL-backed jobs add-on for GoLazy apps.