Getting Started

This SDK gives you seamless access to Genesis DB from any Swift environment. Stream events, commit new ones, observe events and query events - all over an simple HTTP interface. Fully type-safe, zero boilerplate, and CloudEvents-native. Whether you're building backends, CLIs, or reactive frontends, this SDK gets out of your way and lets you focus on the event-driven logic that matters.

Requirements

iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+, Swift 5.9+, Xcode 15.0+

Installation

To install the SDK, run the following command:

Configuration

The SDK requires the following environment variables to be set:

Usage

To use the SDK, you need to create a client and connect to the Genesis DB instance. The client will handle the connection and the authentication.

Instantiate the client

Stream Events

Stream Events from lower bound

Stream Events with latest by event type

Commit Events

Commit events with preconditions

Usage of referenced data (GDPR)

Deleting referenced data (GDPR)

Observe Events

Observe Events from lower bound (Message queue)

Query Events

Health Checks

Event Model

Precondition Model

Error Handling

Async/Await Support

Thread Safety

The GenesisDBClient is thread-safe and can be used from multiple threads concurrently. However, individual client instances should not be shared across different threads without proper synchronization.