Interface IDatabaseOptions
Represents the configuration settings for a database used in Change Data Capture (CDC) processing.
public interface IDatabaseOptions
Properties
CaptureInstanceToTableNameMap
Gets a mapping from capture instance name to logical table name.
IReadOnlyDictionary<string, string> CaptureInstanceToTableNameMap { get; }
Property Value
- IReadOnlyDictionary<string, string>
A read-only dictionary mapping capture instance names (e.g.,
dbo_Customers) to their logical table names (e.g.,dbo.Customers). When a capture instance has no explicit table name, the capture instance itself is the value.
Remarks
This map is used to translate capture instance names back to logical table names so that TableName contains the consumer-configured table name rather than the SQL Server CDC implementation detail.
CaptureInstances
Gets the list of CDC capture instances to process.
string[] CaptureInstances { get; }
Property Value
- string[]
The list of CDC capture instances to process.
Remarks
Each capture instance corresponds to a table or set of tables tracked by CDC in the database.
ConsumerBatchSize
Gets the batch size used in the consumer loop.
int ConsumerBatchSize { get; }
Property Value
- int
The batch size used in the consumer loop.
DatabaseConnectionIdentifier
Gets the unique identifier for the database connection.
string DatabaseConnectionIdentifier { get; }
Property Value
- string
The unique identifier for the database connection.
Remarks
This identifier is used to differentiate between multiple database connections.
DatabaseName
Gets the name of the database being processed.
string DatabaseName { get; }
Property Value
- string
The name of the database being processed.
ProducerBatchSize
Gets the batch size used in the producer loop.
int ProducerBatchSize { get; }
Property Value
- int
The batch size used in the producer loop.
QueueSize
Gets the size of the in-memory data queue.
int QueueSize { get; }
Property Value
- int
The size of the in-memory data queue.
RecoveryOptions
Gets the recovery options for handling stale CDC position scenarios.
CdcRecoveryOptions? RecoveryOptions { get; }
Property Value
- CdcRecoveryOptions
The recovery options, or null to propagate stale-position failures.
Remarks
When null, stale checkpoints and source-history changes raise errors without resetting the saved position. Supply explicit options to enable a recovery strategy.
StateConnectionIdentifier
Gets the unique identifier for the connection to the state store database.
string StateConnectionIdentifier { get; }
Property Value
- string
The unique identifier for the connection to the state store database.
Remarks
The state store database is used to persist CDC processing state.
StopOnMissingTableHandler
Gets a value indicating whether processing should stop when a table handler is missing.
bool StopOnMissingTableHandler { get; }
Property Value
Remarks
If true , the processing will stop and throw an exception when a table does not have a registered handler. If false
, processing will continue despite missing table handlers.