Skip to content

Sql Server

PM> Install-Package Shuttle.Recall.Sql.Storage

A Sql Server implementation of the Shuttle.Recall event sourcing EventStore.

Configuration

c#
services.AddSqlEventStorage();

Database

In order to create the relevant database structures execute the relevant EventStoreCreate.sql script:

%userprofile%\.nuget\packages\shuttle.recall.sql.storage\{version}\scripts\{provider}\EventStoreCreate.sql

Supported providers

  • Microsoft.Data.SqlClient
  • System.Data.SqlClient

If you'd like support for another SQL-based provider please feel free to give it a bash and send a pull request if you do go this route. You are welcome to create an issue and assistance will be provided where possible.

IKeyStore

You are bound to run into situations where you have a business or other key that is required to be unique. Given that the IEventStore makes use of only surrogate keys the IKeyStore is used to create a unique list of keys associated with a given aggregate identifier.

Since the keys used in the key store have to be unique you should ensure that they contain enough information to be unique and have the intended meaning.

A key could be something such as [order-number]:ord-001/2016, [customer-onboarding]:id-number=0000005555089, or [system-name/profile]:672cda1c-c3ec-4f81-a577-e64f9f14e141.

Contains

c#
bool Contains(string key);

Returns true if the given key has an associated aggregate identifier.


c#
bool Contains(Guid id);

Returns true if the given id is present in the key store.


Get

c#
Guid? Get(string key);

Returns the Guid associated with the given key; else null.


Remove

c#
void Remove(string key);
void Remove(Guid id);

When specifying the key the assocation with the identifier will be removed. When specifying the id all keys associated with the given id will be removed.


Add

c#
void Add(Guid id, string key);

Creates an association between the id and the key.


Add

c#
void Rekey(string key, string rekey);

Changes key to a new key specified by rekey.