postgres

README

postgres

Postgres adapter for REL.

Example

package main

import (
	"context"

	_ "github.com/lib/pq"
	"github.com/go-rel/postgres"
	"github.com/go-rel/rel"
)

func main() {
	// open postgres connection.
	adapter, err := postgres.Open("postgres://postgres@localhost/rel_test?sslmode=disable")
	if err != nil {
		panic(err)
	}
	defer adapter.Close()

	// initialize REL's repo.
	repo := rel.New(adapter)
	repo.Ping(context.TODO())
}

Example Replication (Master/Standby)

package main

import (
	"context"

	"github.com/go-rel/primaryreplica"
	_ "github.com/lib/pq"
	"github.com/go-rel/postgres"
	"github.com/go-rel/rel"
)

func main() {
	// open postgres connections.
	adapter := primaryreplica.New(
		postgres.MustOpen("postgres://postgres@master/rel_test?sslmode=disable"),
		postgres.MustOpen("postgres://postgres@standby/rel_test?sslmode=disable"),
	)
	defer adapter.Close()

	// initialize REL's repo.
	repo := rel.New(adapter)
	repo.Ping(context.TODO())
}

Supported Driver

• github.com/lib/pq
• github.com/jackc/pgx/v5/stdlib

Supported Database

• PostgreSQL 11, 12, 13, 14, 15 and 16

Testing

Start PostgreSQL server in Docker

docker run -it --rm -p 25432:5432 -e "POSTGRES_USER=rel" -e "POSTGRES_PASSWORD=rel" -e "POSTGRES_DB=rel_test" postgres:14-alpine

Run tests

go test -p 1 ./...

Documentation

Overview

Package postgres wraps postgres (pq) driver as an adapter for REL.

Usage:

// open postgres connection.
adapter, err := postgres.Open("postgres://postgres@localhost/rel_test?sslmode=disable")
if err != nil {
	panic(err)
}
defer adapter.Close()

// initialize REL's repo.
repo := rel.New(adapter)

Index

• Constants
• func FormatTime(t time.Time) string
• func MustOpen(dsn string) rel.Adapter
• func New(database *db.DB) rel.Adapter
• func Open(dsn string) (rel.Adapter, error)
• type Postgres
  • func (p Postgres) Begin(ctx context.Context) (rel.Adapter, error)
  • func (p Postgres) Insert(ctx context.Context, query rel.Query, primaryField string, ...) (interface{}, error)
  • func (p Postgres) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, ...) ([]interface{}, error)
  • func (Postgres) Name() string
• type Quote
  • func (q Quote) ID(name string) string
  • func (q Quote) Value(v interface{}) string
• type ValueConvert
  • func (c ValueConvert) ConvertValue(v interface{}) (driver.Value, error)

Constants

const Name string = "postgres"

Name of database type this adapter implements.

const TimeLayout = "2006-01-02 15:04:05.999999999Z07:00:00"

TimeLayout used by PostgreSQL adapter.

Functions

func FormatTime

func FormatTime(t time.Time) string

FormatTime formats time to PostgreSQL format.

func MustOpen

func MustOpen(dsn string) rel.Adapter

MustOpen postgres connection using dsn.

func New

func New(database *db.DB) rel.Adapter

New postgres adapter using existing connection.

func Open

func Open(dsn string) (rel.Adapter, error)

Open postgres connection using dsn.

Types

type Postgres

type Postgres struct {
	sql.SQL
}

Postgres adapter.

func (Postgres) Begin

func (p Postgres) Begin(ctx context.Context) (rel.Adapter, error)

Begin begins a new transaction.

func (Postgres) Insert

func (p Postgres) Insert(ctx context.Context, query rel.Query, primaryField string, mutates map[string]rel.Mutate, onConflict rel.OnConflict) (interface{}, error)

Insert inserts a record to database and returns its id.

func (Postgres) InsertAll

func (p Postgres) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, bulkMutates []map[string]rel.Mutate, onConflict rel.OnConflict) ([]interface{}, error)

InsertAll inserts multiple records to database and returns its ids.

func (Postgres) Name

func (Postgres) Name() string

Name of database adapter.

type Quote

type Quote struct{}

Quote PostgreSQL identifiers and literals.

func (Quote) ID

func (q Quote) ID(name string) string

func (Quote) Value

func (q Quote) Value(v interface{}) string

type ValueConvert

type ValueConvert struct{}

ValueConvert converts values to PostgreSQL literals.

func (ValueConvert) ConvertValue

func (c ValueConvert) ConvertValue(v interface{}) (driver.Value, error)