raizel

README

raizel

A persistence helper library that supports Firestore and PostgreSQL

Cassandra and MySQL support will be avaiable soon

dependencies

tools (you must provide the installation)

• Docker

libraries

• firestore
• gocql
• mysql-go-sql-driver
• psql-libpq
• l
• migi
• yggdrasil

tests and coverage

• run unit tests: make docker.test
• run coverage: make docker.coverage.text
• run html coverage: make docker.coverage.html

raizel usage

Find some samples in the test files. A better usage section will be avaiable soon ...

Documentation

Index

• Variables
• type Entity
• type EntityKey
  • func NewDynamicKey(entityName, keyName string, keyValue interface{}) EntityKey
• type Repository

Variables

var (
	ErrNotFound = errors.New("err_notfound")
)

Types

type Entity

type Entity interface{}

type EntityKey

type EntityKey interface {
	EntityName() string
	Value() interface{}
	Name() string
}

func NewDynamicKey

func NewDynamicKey(entityName, keyName string, keyValue interface{}) EntityKey

type Repository

type Repository interface {
	Get(ctx context.Context, key EntityKey, entity Entity) error
	Set(ctx context.Context, key EntityKey, entity Entity) error
	Delete(ctx context.Context, key EntityKey) error
	Close(ctx context.Context) error
}