https://github.com/shuttle/shuttle.recall.sql.storage
Event Store implementation backed by any Sql-based database.
https://github.com/shuttle/shuttle.recall.sql.storage
Last synced: about 2 months ago
JSON representation
Event Store implementation backed by any Sql-based database.
- Host: GitHub
- URL: https://github.com/shuttle/shuttle.recall.sql.storage
- Owner: Shuttle
- License: bsd-3-clause
- Created: 2017-06-28T19:07:37.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-25T07:15:53.000Z (4 months ago)
- Last Synced: 2025-02-02T07:28:52.343Z (4 months ago)
- Language: C#
- Size: 234 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
Please reference the `Shuttle.Recall.EntityFrameworkCore.SqlServer.Storage` package and use the Entity Framework Core migration mechanism to create the event store database structures.
## 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`.