ark

README

go-ark

Go data mapper providing a familiar API for internally supported database providers.

Installation

go-ark may be installed using the go get command:

go get github.com/pghq/go-ark

Usage

A typical usage scenario:

import (
    "context"
    
    "github.com/pghq/go-ark/database"
    "github.com/pghq/go-ark"
)

//go:embed schema
var schema embed.FS

// Open a postgres connection
db, err := ark.New("postgres://user:pass@postgres/db", database.Migrate(schema))
if err != nil{
    panic(err)
}

// Create a transaction
tx := db.Txn(context.Background())
defer tx.Rollback()

// Commit some data
if err := tx.Insert("foos", map[string]interface{}{"id": "foo"}); err != nil{
    panic(err)
}

if err := tx.Commit(); err != nil{
    panic(err)
}

Supported Providers

• Postgres
• Redshift

Documentation

Index

• type DocumentDecoder
• type DocumentEncoder
• type Mapper
  • func New(dsn string, opts ...database.Option) (*Mapper, error)
  • func (m *Mapper) Do(ctx context.Context, fn func(tx Txn) error, opts ...database.TxnOption) error
  • func (m *Mapper) Txn(ctx context.Context, opts ...database.TxnOption) Txn
  • func (m *Mapper) View(ctx context.Context, fn func(tx Txn) error, opts ...database.TxnOption) error
• type Txn
  • func (tx Txn) Commit() error
  • func (tx Txn) Context() context.Context
  • func (tx Txn) Get(table string, query database.Query, v interface{}) error
  • func (tx Txn) Insert(table string, v interface{}) error
  • func (tx Txn) List(table string, query database.Query, v interface{}) error
  • func (tx Txn) Remove(table string, query database.Query) error
  • func (tx Txn) Rollback() error
  • func (tx Txn) Update(table string, query database.Query, v interface{}) error

Types

type DocumentDecoder

type DocumentDecoder interface {
	Decode(fn func(v interface{}) error) error
}

DocumentDecoder decodes a database document.

type DocumentEncoder

type DocumentEncoder interface {
	Encode() interface{}
}

DocumentEncoder encodes a database document

type Mapper

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

Mapper Data mapper for various backends

func New

func New(dsn string, opts ...database.Option) (*Mapper, error)

New Create a new mapper

func (*Mapper) Do

func (m *Mapper) Do(ctx context.Context, fn func(tx Txn) error, opts ...database.TxnOption) error

Do Write and or read using a callback

func (*Mapper) Txn

func (m *Mapper) Txn(ctx context.Context, opts ...database.TxnOption) Txn

Txn Begin or fork a transaction

func (*Mapper) View

func (m *Mapper) View(ctx context.Context, fn func(tx Txn) error, opts ...database.TxnOption) error

View Read using a callback

type Txn

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

Txn A unit of work

func (Txn) Commit

func (tx Txn) Commit() error

Commit Submit a unit of work

func (Txn) Context

func (tx Txn) Context() context.Context

Context gets the context of the transaction

func (Txn) Get

func (tx Txn) Get(table string, query database.Query, v interface{}) error

Get Retrieve a value

func (Txn) Insert

func (tx Txn) Insert(table string, v interface{}) error

Insert insert a value

func (Txn) List

func (tx Txn) List(table string, query database.Query, v interface{}) error

List Retrieve a listing of values

func (Txn) Remove

func (tx Txn) Remove(table string, query database.Query) error

Remove Delete a value by key

func (Txn) Rollback

func (tx Txn) Rollback() error

Rollback Cancel a unit of work

func (Txn) Update

func (tx Txn) Update(table string, query database.Query, v interface{}) error

Update Replace an existing value