Class CdcBuilderSqlServerExtensions
Extension methods for configuring SQL Server CDC provider on ICdcBuilder.
public static class CdcBuilderSqlServerExtensions
- Inheritance
-
CdcBuilderSqlServerExtensions
- Inherited Members
Remarks
These extensions provide fluent provider selection by adding provider-specific configuration to the core ICdcBuilder interface.
Methods
UseSqlServer(ICdcBuilder, Action<ISqlServerCdcBuilder>)
Configures the CDC processor to use SQL Server.
public static ICdcBuilder UseSqlServer(this ICdcBuilder builder, Action<ISqlServerCdcBuilder> configure)
Parameters
builderICdcBuilderThe CDC builder.
configureAction<ISqlServerCdcBuilder>Action to configure SQL Server-specific options including connection.
Returns
- ICdcBuilder
The builder for fluent chaining.
Examples
// Connection string
services.AddCdcProcessor(cdc =>
{
cdc.UseSqlServer(sql =>
{
sql.ConnectionString(connectionString)
.SchemaName("cdc")
.DatabaseName("MyDb")
.PollingInterval(TimeSpan.FromSeconds(5))
.BatchSize(100);
})
.TrackTable("dbo.Orders", table =>
{
table.MapInsert<OrderCreatedEvent>()
.MapUpdate<OrderUpdatedEvent>()
.MapDelete<OrderDeletedEvent>();
})
.EnableBackgroundProcessing();
});
// From appsettings.json
services.AddCdcProcessor(cdc =>
{
cdc.UseSqlServer(sql =>
{
sql.BindConfiguration("Cdc:SqlServer")
.DatabaseName("MyDb");
});
});
// Named connection string
services.AddCdcProcessor(cdc =>
{
cdc.UseSqlServer(sql =>
{
sql.ConnectionStringName("CdcDatabase")
.DatabaseName("MyDb");
});
});
// Connection factory
services.AddCdcProcessor(cdc =>
{
cdc.UseSqlServer(sql =>
{
sql.ConnectionFactory(sp =>
{
var config = sp.GetRequiredService<IConfiguration>();
var connStr = config.GetConnectionString("CdcDatabase")!;
return () => new SqlConnection(connStr);
})
.DatabaseName("MyDb");
});
});
Remarks
This is the primary method for configuring SQL Server as the CDC provider. It registers the CdcProcessor, CdcStateStore, and related services. Connection can be provided via the builder using ConnectionString(string), ConnectionStringName(string), ConnectionFactory(Func<IServiceProvider, Func<SqlConnection>>), or BindConfiguration(string).
Exceptions
- ArgumentNullException
Thrown when
builderorconfigureis null.