StreamStore.Sql.Sqlite 0.5.0

StreamStore.Sql.Sqlite

SQLite backend database for StreamStore asynchronous event sourcing library.

Installation

To install the package, you can use the following command from the command line:

  dotnet add package StreamStore

  dotnet add package StreamStore.Sql.Sqlite

or from Nuget Package Manager Console:

  Install-Package StreamStore

  Install-Package StreamStore.Sql.Sqlite

Usage

Storage

By default the library provisioning tables automatically, however you must create database or provide connection string to existing database.

If you want to create table manually, you can use the following script:

  CREATE TABLE IF NOT EXISTS main.Events (
      Id TEXT NOT NULL,
      StreamId TEXT NOT NULL,
      Timestamp datetime2 NOT NULL, 
      Revision INTEGER NOT NULL,
      Data BLOB NOT NULL,
      PRIMARY KEY (Id, StreamId)
  );

  CREATE INDEX IF NOT EXISTS main.ix_streams_stream_id ON Events(StreamId);
  CREATE INDEX IF NOT EXISTS main.ix_streams_stream_revision ON Events(Revision);
  CREATE UNIQUE INDEX IF NOT EXISTS main.ix_streams_stream_id_revision ON Events(StreamId, Revision);

Configuration

You can define configuration of the library in appsettings.json file:

{
  "ConnectionStrings": {
    "StreamStore": "Data Source=streamstore.db" // Required for single tenant configuration
  },
  "StreamStore": { // Optional
    "Sqlite": {
      "SchemaName": "main", // Optional
      "TableName": "Events", // Optional
      "ProvisionSchema": true, // Optional
    }
  }
}

Register in DI container

services.ConfigureStreamStore(x =>...

  // Register single database implementation
  x.WithSingleDatabase(c => ...
      c.UseSqliteDatabase(x =>
          c => c.ConfigureDatabase(x =>                        // Configure database options.
            x.WithConnectionString("your-connection-string")   // Required. Connection string.
            x.WithSchema("your-schema-name");                  // Optional. Schema name, default is "main".
            x.WithTableName("your-table-name");                // Optional. Table name, default is "Events".
      )
  )

  // Or enable multitenancy
  x.WithMultitenancy(c => ...
      c.UseSqliteDatabase(x => 
          x.WithConnectionStringProvider<Provider>()          // Required. Register your 
                                                              // ISqlTenantConnectionStringProvider implementation.
          c => c.ConfigureDatabase(x =>...)                   // Optional. Configure database options will be used as 
                                                              // template for tenant database configuration, optional.
      )
  )
); 

Use in application code

How to use StreamStore in your application code you can find on StreamStore page.

Example

You can find an example of usage in the StreamStore.Sql.Example project.

License

MIT License