README
¶
Dogma Persistence Toolkit
Abstract persistence primitives for use in Dogma engines, projections, etc.
The persistence toolkit provides a set of relatively low-level persistence abstractions that can be used to build higher-level storage systems.
The interfaces are designed to be easy to implement by placing a minimal set of requirements on each implementation.
Abstractions
Journal- an append-only log of binary records with optimistic concurrency controlKeyspace- a non-transactional binary key/value store
Drivers
Implementations of the above primitives are called "driver". Several built-in
drivers are included, each in their own package within the driver directory.
- Amazon DynamoDB
- PostgreSQL and compatible databases
- In-memory reference/testing implementation
Documentation
¶
Overview ¶
Package persistencekit abstract persistence primitives for use in [Dogma](https://github.com/dogmatiq/dogma) engines, projections, etc.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
driver
|
|
|
aws/dynamojournal
Package dynamojournal provides an implementation of journal.BinaryStore that persists to a DynamoDB table.
|
Package dynamojournal provides an implementation of journal.BinaryStore that persists to a DynamoDB table. |
|
aws/dynamokv
Package dynamokv provides a kv.BinaryStore implementation that persists to a DynamoDB table.
|
Package dynamokv provides a kv.BinaryStore implementation that persists to a DynamoDB table. |
|
aws/internal/awsx
Package awsx contains general purpose AWS utilities.
|
Package awsx contains general purpose AWS utilities. |
|
aws/internal/dynamox
Package dynamox contains DynamoDB utilities.
|
Package dynamox contains DynamoDB utilities. |
|
aws/internal/s3x
Package s3x contains S3 utilities.
|
Package s3x contains S3 utilities. |
|
aws/s3journal
Package s3journal provides an implementation of journal.BinaryStore that persists to an S3 bucket.
|
Package s3journal provides an implementation of journal.BinaryStore that persists to an S3 bucket. |
|
memory/internal/clone
Package clone provides a protocol-buffers-aware deep clone function.
|
Package clone provides a protocol-buffers-aware deep clone function. |
|
memory/memoryjournal
Package memoryjournal provides an in-memory implementation of journal.BinaryStore.
|
Package memoryjournal provides an in-memory implementation of journal.BinaryStore. |
|
memory/memorykv
Package memorykv provides an in-memory implementation of kv.BinaryStore.
|
Package memorykv provides an in-memory implementation of kv.BinaryStore. |
|
sql/postgres/internal/bigint
Package unsigned provides a type maps an unsigned 64-bit integer to a signed 64-bit integer for use in SQL statements and scan operations.
|
Package unsigned provides a type maps an unsigned 64-bit integer to a signed 64-bit integer for use in SQL statements and scan operations. |
|
sql/postgres/internal/pgerror
Package pgerror provides utilities for working with PostgreSQL errors.
|
Package pgerror provides utilities for working with PostgreSQL errors. |
|
sql/postgres/pgjournal
Package pgjournal provides an implementation of journal.BinaryStore that persists to a PostgreSQL database.
|
Package pgjournal provides an implementation of journal.BinaryStore that persists to a PostgreSQL database. |
|
sql/postgres/pgkv
Package pgkv provides an implementation of kv.BinaryStore that persists to a PostgreSQL database.
|
Package pgkv provides an implementation of kv.BinaryStore that persists to a PostgreSQL database. |
|
internal
|
|
|
errorx
Package errorx provides utilities for working with errors.
|
Package errorx provides utilities for working with errors. |
|
telemetry
Package telemetry is an internal API for observability/instrumentation.
|
Package telemetry is an internal API for observability/instrumentation. |
|
testx
Package testx contains utilities for testing.
|
Package testx contains utilities for testing. |
|
Package journal provides an abstraction of an append-only log with optimistic concurrency control.
|
Package journal provides an abstraction of an append-only log with optimistic concurrency control. |
|
Package kv provides an abstraction of a non-transactional key/value store.
|
Package kv provides an abstraction of a non-transactional key/value store. |
|
Package marshaler provides marshalers for converting values to and from their binary representations.
|
Package marshaler provides marshalers for converting values to and from their binary representations. |
Click to show internal directories.
Click to hide internal directories.