postgresstore

Documentation

Index

• func New(config *Config, options ...Option) (*postgresStore, error)
• type Config
  • func NewConfigFromEnvironment() (*Config, error)
  • func (c Config) DataSourceName() string
• type JsonSerializer
• type Option
  • func WithClock(clock clock.Clock) Option
  • func WithPgNotify() Option
  • func WithUUIDGenerator(uuidGenerator shortuuid.Generator) Option
• type PostgresJsonRecord

Functions

func New

func New(config *Config, options ...Option) (*postgresStore, error)

New constructs an postgresStore.

Types

type Config

type Config struct {
	Host       string
	Port       int
	User       string
	Password   string
	DBName     string
	SearchPath string
}

Config holds the state for a PostgreSQL DB config.

func NewConfigFromEnvironment

func NewConfigFromEnvironment() (*Config, error)

NewConfigFromEnvironment loads a Postgres config from environment variables.

func (Config) DataSourceName

func (c Config) DataSourceName() string

DataSourceName returns the DSN for a PostgreSQL DB.

type JsonSerializer

type JsonSerializer interface {
	rangedb.EventBinder
	rangedb.EventTypeIdentifier
}

JsonSerializer defines the interface to bind events and identify event types.

type Option

type Option func(*postgresStore)

Option defines functional option parameters for postgresStore.

func WithClock

func WithClock(clock clock.Clock) Option

WithClock is a functional option to inject a clock.Clock.

func WithPgNotify

func WithPgNotify() Option

WithPgNotify enables pg_notify() for notifying subscribers.

func WithUUIDGenerator

func WithUUIDGenerator(uuidGenerator shortuuid.Generator) Option

WithUUIDGenerator is a functional option to inject a shortuuid.Generator.

type PostgresJsonRecord

type PostgresJsonRecord struct {
	AggregateType        string `json:"aggregatetype"`
	AggregateID          string `json:"aggregateid"`
	GlobalSequenceNumber uint64 `json:"globalsequencenumber"`
	StreamSequenceNumber uint64 `json:"streamsequencenumber"`
	InsertTimestamp      uint64 `json:"inserttimestamp"`
	EventID              string `json:"eventid"`
	EventType            string `json:"eventtype"`
	Data                 string `json:"data"`
	Metadata             string `json:"metadata"`
}

PostgresJsonRecord holds a JSON record sent via pg_notify.