postgres

Documentation

Overview

Package postgres provides Postgres connection and database helpers.

New code should use explicit construction and core-owned SQL operation types:

import "github.com/InsideGallery/core/db/postgres"

db, err := postgres.NewDatabaseFromOptions(postgres.DatabaseOptions{
	Host: "localhost",
	Database: "app",
})

Prefer Database, DatabaseClient, Statement, DatabaseOptions, and CommandResult when consumer code should not depend directly on sqlx.

Compatibility: NewClient, Set, Get, and Default remain available for existing sqlx-shaped callers. Prefer NewDatabase, NewDatabaseFromOptions, DefaultDatabase, or NewClientStore with explicit lifecycle ownership in new code.

Index

• Constants
• Variables
• func Default() (*sqlx.DB, error)
• func Get() (*sqlx.DB, error)
• func NewClient(config *ConnectionConfig) (*sqlx.DB, error)
• func Set(r *sqlx.DB)
• type ClientStore
  • func NewClientStore(client *sqlx.DB) *ClientStore
  • func (s *ClientStore) Close() error
  • func (s *ClientStore) Get() (*sqlx.DB, error)
  • func (s *ClientStore) GetOrCreate(config *ConnectionConfig) (*sqlx.DB, error)
  • func (s *ClientStore) Set(client *sqlx.DB)
• type CommandResult
• type ConnectionConfig
  • func GetConnectionConfigFromEnv() (*ConnectionConfig, error)
  • func (c *ConnectionConfig) GetDSN() string
• type Database
• type DatabaseClient
  • func DefaultDatabase() (*DatabaseClient, error)
  • func NewDatabase(config *ConnectionConfig) (*DatabaseClient, error)
  • func NewDatabaseFromOptions(options DatabaseOptions) (*DatabaseClient, error)
  • func WrapDatabase(db *sqlx.DB) *DatabaseClient
  • func (d *DatabaseClient) Close() error
  • func (d *DatabaseClient) Exec(ctx context.Context, statement Statement) (CommandResult, error)
  • func (d *DatabaseClient) Ping(ctx context.Context) error
  • func (d *DatabaseClient) Query(ctx context.Context, statement Statement) (*sql.Rows, error)
  • func (d *DatabaseClient) QueryRow(ctx context.Context, statement Statement) *sql.Row
  • func (d *DatabaseClient) SQLDB() *sql.DB
• type DatabaseOptions
• type Statement

Constants

const EnvPrefix = "POSTGRES"

EnvPrefix environment prefix for mongodb config

Variables

var ErrConnectionIsNotSet = errors.New("connection is not set")

Functions

func Default

func Default() (*sqlx.DB, error)

Default returns the legacy sqlx Postgres client.

Deprecated: use DefaultDatabase for new code.

func Get

func Get() (*sqlx.DB, error)

Get returns the legacy sqlx Postgres client.

Deprecated: use DefaultDatabase for new code.

func NewClient

func NewClient(config *ConnectionConfig) (*sqlx.DB, error)

NewClient creates a legacy sqlx Postgres client from explicit config.

func Set

func Set(r *sqlx.DB)

Set stores the legacy sqlx Postgres client.

Deprecated: use NewDatabase, DefaultDatabase, and DatabaseClient for new code.

Types

type ClientStore

type ClientStore struct {
	// contains filtered or unexported fields
}

ClientStore owns a Postgres sqlx client for explicit application composition.

func NewClientStore

func NewClientStore(client *sqlx.DB) *ClientStore

NewClientStore creates a Postgres client store with an optional existing client.

func (*ClientStore) Close

func (s *ClientStore) Close() error

Close closes the stored Postgres client and clears this store.

func (*ClientStore) Get

func (s *ClientStore) Get() (*sqlx.DB, error)

Get returns the Postgres client from this store.

func (*ClientStore) GetOrCreate

func (s *ClientStore) GetOrCreate(config *ConnectionConfig) (*sqlx.DB, error)

GetOrCreate returns or creates a Postgres client from explicit config.

func (*ClientStore) Set

func (s *ClientStore) Set(client *sqlx.DB)

Set stores a Postgres client in this store.

type CommandResult

type CommandResult struct {
	RowsAffected int64
}

CommandResult is the core-owned result for SQL commands.

type ConnectionConfig

type ConnectionConfig struct {
	Host            string `env:"_HOST" envDefault:"localhost"`
	Port            string `env:"_PORT" envDefault:"5432"`
	User            string `env:"_USER" envDefault:"default"`
	Password        string `env:"_PASSWORD" envDefault:"default"`
	DB              string `env:"_DB" envDefault:"default"`
	ApplicationName string `env:"_APPLICATIONNAME" envDefault:""`
	MaxOpenConns    int    `env:"_MAXOPENCONNS" envDefault:"500"`
	ConnMaxLifetime int64  `env:"_CONNMAXLIFETIME" envDefault:"-1"`
}

ConnectionConfig contains required data for gremlin

func GetConnectionConfigFromEnv

func GetConnectionConfigFromEnv() (*ConnectionConfig, error)

GetConnectionConfigFromEnv return aerospike configs bases on environment variables

func (*ConnectionConfig) GetDSN

func (c *ConnectionConfig) GetDSN() string

type Database

type Database interface {
	Ping(ctx context.Context) error
	Exec(ctx context.Context, statement Statement) (CommandResult, error)
	Query(ctx context.Context, statement Statement) (*sql.Rows, error)
	QueryRow(ctx context.Context, statement Statement) *sql.Row
	Close() error
}

Database is the core-owned Postgres contract for new consumers.

type DatabaseClient

type DatabaseClient struct {
	// contains filtered or unexported fields
}

DatabaseClient wraps sqlx behind core-owned operation inputs and results.

func DefaultDatabase

func DefaultDatabase() (*DatabaseClient, error)

DefaultDatabase returns the default Postgres client behind the core-owned DatabaseClient API.

func NewDatabase

func NewDatabase(config *ConnectionConfig) (*DatabaseClient, error)

NewDatabase creates a Postgres database client from core-owned config.

func NewDatabaseFromOptions

func NewDatabaseFromOptions(options DatabaseOptions) (*DatabaseClient, error)

NewDatabaseFromOptions creates a Postgres database client from core-owned construction options.

func WrapDatabase

func WrapDatabase(db *sqlx.DB) *DatabaseClient

WrapDatabase adapts an existing sqlx DB to DatabaseClient.

func (*DatabaseClient) Close

func (d *DatabaseClient) Close() error

Close closes the database client.

func (*DatabaseClient) Exec

func (d *DatabaseClient) Exec(ctx context.Context, statement Statement) (CommandResult, error)

Exec runs a command with core-owned options.

func (*DatabaseClient) Ping

func (d *DatabaseClient) Ping(ctx context.Context) error

Ping verifies connectivity.

func (*DatabaseClient) Query

func (d *DatabaseClient) Query(ctx context.Context, statement Statement) (*sql.Rows, error)

Query runs a query with core-owned options.

func (*DatabaseClient) QueryRow

func (d *DatabaseClient) QueryRow(ctx context.Context, statement Statement) *sql.Row

QueryRow runs a single-row query with core-owned options.

func (*DatabaseClient) SQLDB

func (d *DatabaseClient) SQLDB() *sql.DB

SQLDB returns the standard-library database handle.

type DatabaseOptions

type DatabaseOptions struct {
	Host            string
	Port            string
	User            string
	Password        string
	Database        string
	ApplicationName string
	MaxOpenConns    int
	ConnMaxLifetime time.Duration
}

DatabaseOptions is the core-owned input for constructing a Postgres database client.

type Statement

type Statement struct {
	Query string
	Args  []any
}

Statement is the core-owned input for SQL operations.