StreamStore.Sql.PostgreSql 0.4.0

StreamStore.Sql.PostgreSql

PostgreSQL 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.PostgreSql

or from Nuget Package Manager Console:

  Install-Package StreamStore

  Install-Package StreamStore.Sql.PostgreSql

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 public.Events (
     Id text NOT NULL,
     StreamId text NOT NULL,
     Timestamp timestamp NOT NULL,
     Revision integer NOT NULL,
     Data bytea NOT NULL,
     PRIMARY KEY (Id, StreamId)
 );

 CREATE INDEX IF NOT EXISTS ix_events_stream_id ON Events(StreamId);
 CREATE INDEX IF NOT EXISTS ix_events_stream_revision ON Events(Revision);
 CREATE UNIQUE INDEX IF NOT EXISTS ix_events_stream_id_revision ON Events(StreamId, Revision);

Configuration

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

{
  "ConnectionStrings": {
    "StreamStore": "Host=localhost;Port=5432;Database=streamstore;Username=streamstore;Password=streamstore" // Required for single tenant configuration
  },
  "StreamStore": {             // Optional
    "PostgreSql": {
      "SchemaName": "public",  // Optional
      "TableName": "Events",   // Optional
      "ProvisionSchema": true, // Optional
    }
  }
}

Register in DI container

services.ConfigureStreamStore(x =>...
  
  // Register single database implementation
  x.WithSingleDatabase(c => ...
      c.UsePostgresDatabase(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 "public".
            x.WithTableName("your-table-name");                // Optional. Table name, default is "Events".
      )
  )

  // Or enable multitenancy
  x.WithMultitenancy(c => ...
      c.UsePostgresDatabase(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.

Testing

In order to run tests placed in StreamStore.Sql.Tests/PostgreSql, you need to have a running PostgreSQL instance. You can use docker-compose docker-compose.yaml to run it.

License

MIT License