sql

README

SQL Snapshot Store

The sql is a module containing multiple sql based snapshot stores that are all based on the database/sql interface in go standard library. The different snapshot stores has specific database schemas that support the different databases.

SQLite

Supports the SQLite database https://www.sqlite.org/

Database Schema

CREATE TABLE IF NOT EXISTS snapshots (
    id              VARCHAR NOT NULL,
    type            VARCHAR,
    version         INTEGER,
    global_version  INTEGER,
    state           BLOB
);

CREATE UNIQUE INDEX IF NOT EXISTS id_type ON snapshots (id, type);

Constructor

// NewSQLite connection to database
func NewSQLite(db *sql.DB) (*SQLite, error) {

Example of use

import (
	sqldriver "database/sql"
	"github.com/hallgren/eventsourcing/snapshotstore/sql"
	_ "github.com/mattn/go-sqlite3"
)

db, err := sqldriver.Open("sqlite3", "file::memory:?locked.sqlite?cache=shared")
if err != nil {
	return nil, nil, err
}

sqliteSnapshotStore, err := sql.NewSQLite(db)
if err != nil {
	return nil, nil, err
}

Postgres

Supports the Postgres database https://www.postgresql.org

Database Schema

CREATE TABLE IF NOT EXISTS snapshots (
    id VARCHAR NOT NULL,
    type VARCHAR,
    version INTEGER,
    global_version INTEGER,
    state BYTEA
);

CREATE UNIQUE INDEX IF NOT EXISTS id_type ON snapshots (id, type);

Constructor

// NewPostgres connection to database
func NewPostgres(db *sql.DB) (*Postgres, error) {

Example of use

import (
	gosql "database/sql"
	_ "github.com/lib/pq"
	"github.com/hallgren/eventsourcing/snapshotstore/sql"
)

db, err := gosql.Open("postgres", dsn)
if err != nil {
  return err
}


postgreSnapshotStore, err := sql.NewPostgres(db)
if err != nil {
	return err
}

Documentation

Index

• type Postgres
  • func NewPostgres(db *sql.DB) (*Postgres, error)
  • func (s *Postgres) Close()
  • func (s *Postgres) Get(ctx context.Context, aggregateID, aggregateType string) (core.Snapshot, error)
  • func (s *Postgres) Save(snapshot core.Snapshot) error
• type SQLite
  • func NewSQLite(db *sql.DB) (*SQLite, error)
  • func (s *SQLite) Close()
  • func (s *SQLite) Get(ctx context.Context, aggregateID, aggregateType string) (core.Snapshot, error)
  • func (s *SQLite) Save(snapshot core.Snapshot) error

Types

type Postgres

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

func NewPostgres

func NewPostgres(db *sql.DB) (*Postgres, error)

NewPostgres connection to database

func (*Postgres) Close

func (s *Postgres) Close()

Close the connection

func (*Postgres) Get

func (s *Postgres) Get(ctx context.Context, aggregateID, aggregateType string) (core.Snapshot, error)

Get return the snapshot data from the database

func (*Postgres) Save

func (s *Postgres) Save(snapshot core.Snapshot) error

Save persists the snapshot

type SQLite

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

func NewSQLite

func NewSQLite(db *sql.DB) (*SQLite, error)

NewSQLite connection to database

func (*SQLite) Close

func (s *SQLite) Close()

Close the connection

func (*SQLite) Get

func (s *SQLite) Get(ctx context.Context, aggregateID, aggregateType string) (core.Snapshot, error)

Get return the snapshot data from the database

func (*SQLite) Save

func (s *SQLite) Save(snapshot core.Snapshot) error

Save persists the snapshot