Table of Contents

Interface ICdcRelationalStateStoreBuilder

Namespace
Excalibur.Cdc
Assembly
Excalibur.Cdc.dll

Extends ICdcStateStoreBuilder with relational-specific settings (schema name, connection string) for SQL Server and Postgres CDC state stores.

public interface ICdcRelationalStateStoreBuilder : ICdcStateStoreBuilder

Examples

cdc.UseSqlServer(sql =>
{
    sql.ConnectionString(sourceConnectionString)
       .WithStateStore(state =>
       {
           state.ConnectionString(stateConnectionString)
                .SchemaName("dbo")
                .TableName("CdcProcessingState");
       });
});

Remarks

Non-relational providers (DynamoDB, Firestore, CosmosDB, MongoDB) use ICdcStateStoreBuilder directly and do not implement these methods.

Methods

BindConfiguration(string)

Binds state store options from an IConfiguration section, narrowing the inherited return type so relational-only members remain chainable after this call.

ICdcRelationalStateStoreBuilder BindConfiguration(string sectionPath)

Parameters

sectionPath string

The configuration section path.

Returns

ICdcRelationalStateStoreBuilder

The builder for fluent chaining, typed as ICdcRelationalStateStoreBuilder.

ConnectionString(string)

Sets the state store connection string directly.

ICdcRelationalStateStoreBuilder ConnectionString(string connectionString)

Parameters

connectionString string

The state store connection string.

Returns

ICdcRelationalStateStoreBuilder

The builder for fluent chaining.

Exceptions

ArgumentException

Thrown when connectionString is null or whitespace.

ConnectionStringName(string)

Resolves the state store connection string from IConfiguration.GetConnectionString(name) at DI resolution time.

ICdcRelationalStateStoreBuilder ConnectionStringName(string name)

Parameters

name string

The connection string name in the ConnectionStrings section.

Returns

ICdcRelationalStateStoreBuilder

The builder for fluent chaining.

Exceptions

ArgumentException

Thrown when name is null or whitespace.

SchemaName(string)

Sets the database schema for the CDC checkpoint table.

ICdcRelationalStateStoreBuilder SchemaName(string schema)

Parameters

schema string

The schema name.

Returns

ICdcRelationalStateStoreBuilder

The builder for fluent chaining.

Exceptions

ArgumentException

Thrown when schema is null or whitespace.

TableName(string)

Sets the table name for CDC checkpoint persistence, narrowing the inherited return type from ICdcStateStoreBuilder so relational-only members (e.g. ConnectionString(string), SchemaName(string)) remain chainable after this call.

ICdcRelationalStateStoreBuilder TableName(string tableName)

Parameters

tableName string

The table name.

Returns

ICdcRelationalStateStoreBuilder

The builder for fluent chaining, typed as ICdcRelationalStateStoreBuilder.