journal

Documentation

Index

• Constants
• func NewJournal(opts ...Option)
• type Journal
  • func (j *Journal) Append(ctx context.Context, r *Record) error
• type Option
  • func SetMongoDBClient(client *mongo.Client) Option
  • func SetMongoDBCollection(database, collection string) Option
  • func SetName(name string) Option
  • func SetRedisClient(rdb *redis.Client) Option
• type Options
• type Record
• type StorageBackend

Constants

const (
	DefaultMongoDBDatabase   = "journal"
	DefaultMongoDBCollection = "collection"
)

Defaults

Functions

func NewJournal

func NewJournal(opts ...Option)

NewJournal create journal writer

Types

type Journal

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

Journal : ...

func (*Journal) Append

func (j *Journal) Append(ctx context.Context, r *Record) error

Append record to journal

type Option

type Option func(o *Options)

Option : ...

func SetMongoDBClient

func SetMongoDBClient(client *mongo.Client) Option

SetMongoDBClient set mongodb connector

func SetMongoDBCollection

func SetMongoDBCollection(database, collection string) Option

SetMongoDBCollection set database & collection

func SetName

func SetName(name string) Option

SetName sets journal name

func SetRedisClient

func SetRedisClient(rdb *redis.Client) Option

SetRedisClient set redis client

type Options

type Options struct {
	Name string

	// May not user
	Backend StorageBackend
	// contains filtered or unexported fields
}

Options : Journal options

type Record

type Record struct {
	TS    time.Time
	Event string
	Data  interface{}
}

Record : Journal record

type StorageBackend

type StorageBackend int8

StorageBackend : Enum of backend

const (
	GORMBackend    StorageBackend = 0
	MongoDBBackend StorageBackend = 1
)

Backends