postgres

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

• Variables
• type Adapter
  • func New(database *db.DB) *Adapter
  • func Open(dsn string) (*Adapter, error)
  • func (adapter *Adapter) Begin(ctx context.Context) (rel.Adapter, error)
  • func (adapter *Adapter) Insert(ctx context.Context, query rel.Query, primaryField string, ...) (interface{}, error)
  • func (adapter *Adapter) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, ...) ([]interface{}, error)

Variables

var (

	// Config for postgres adapter.
	Config = sql.Config{
		Placeholder:         "$",
		EscapeChar:          "\"",
		Ordinal:             true,
		InsertDefaultValues: true,
		ErrorFunc:           errorFunc,
		MapColumnFunc:       mapColumnFunc,
	}
)

Types

type Adapter

type Adapter struct {
	*sql.Adapter
}

Adapter definition for postgres database.

func New

func New(database *db.DB) *Adapter

New postgres adapter using existing connection.

func Open

func Open(dsn string) (*Adapter, error)

Open postgres connection using dsn.

func (*Adapter) Begin

func (adapter *Adapter) Begin(ctx context.Context) (rel.Adapter, error)

Begin begins a new transaction.

func (*Adapter) Insert

func (adapter *Adapter) Insert(ctx context.Context, query rel.Query, primaryField string, mutates map[string]rel.Mutate) (interface{}, error)

Insert inserts a record to database and returns its id.

func (*Adapter) InsertAll

func (adapter *Adapter) InsertAll(ctx context.Context, query rel.Query, primaryField string, fields []string, bulkMutates []map[string]rel.Mutate) ([]interface{}, error)

InsertAll inserts multiple records to database and returns its ids.