Class CdcBuilderFirestoreExtensions
Extension methods for configuring Firestore CDC provider on ICdcBuilder.
public static class CdcBuilderFirestoreExtensions
- Inheritance
-
CdcBuilderFirestoreExtensions
- Inherited Members
Remarks
These extensions provide fluent provider selection by adding provider-specific configuration to the core ICdcBuilder interface.
Methods
UseFirestore(ICdcBuilder, Action<FirestoreCdcOptions>)
Configures the CDC processor to use Google Cloud Firestore.
public static ICdcBuilder UseFirestore(this ICdcBuilder builder, Action<FirestoreCdcOptions> configure)
Parameters
builderICdcBuilderThe CDC builder.
configureAction<FirestoreCdcOptions>Action to configure Firestore CDC options.
Returns
- ICdcBuilder
The builder for fluent chaining.
Examples
services.AddCdcProcessor(cdc =>
{
cdc.UseFirestore(options =>
{
options.ProjectId = "my-project";
options.CollectionPath = "orders";
})
.EnableBackgroundProcessing();
});
Remarks
Requires FirestoreDb to be registered in the service collection.
Exceptions
- ArgumentNullException
Thrown when
builderorconfigureis null.
UseFirestore(ICdcBuilder, Action<FirestoreCdcOptions>, Action<FirestoreCdcStateStoreOptions>)
Configures the CDC processor to use Google Cloud Firestore with a state store.
public static ICdcBuilder UseFirestore(this ICdcBuilder builder, Action<FirestoreCdcOptions> configureCdc, Action<FirestoreCdcStateStoreOptions> configureStateStore)
Parameters
builderICdcBuilderThe CDC builder.
configureCdcAction<FirestoreCdcOptions>Action to configure Firestore CDC options.
configureStateStoreAction<FirestoreCdcStateStoreOptions>Action to configure Firestore CDC state store options.
Returns
- ICdcBuilder
The builder for fluent chaining.
Examples
services.AddCdcProcessor(cdc =>
{
cdc.UseFirestore(
cdc =>
{
cdc.ProjectId = "my-project";
cdc.CollectionPath = "orders";
},
state =>
{
state.CollectionName = "cdc-positions";
});
});
Exceptions
- ArgumentNullException
Thrown when
builderorconfigureCdcis null.
UseFirestore(ICdcBuilder, Action<IFirestoreCdcBuilder>)
Configures the CDC processor to use Google Cloud Firestore with fluent builder configuration.
[UnconditionalSuppressMessage("AOT", "IL2026:RequiresUnreferencedCode", Justification = "Options validation/binding uses reflection by design. AOT consumers should use source-generated alternatives.")]
[UnconditionalSuppressMessage("AOT", "IL3050:RequiresDynamicCode", Justification = "Configuration binding uses reflection by design. AOT consumers should use source-generated alternatives.")]
public static ICdcBuilder UseFirestore(this ICdcBuilder builder, Action<IFirestoreCdcBuilder> configure)
Parameters
builderICdcBuilderThe CDC builder.
configureAction<IFirestoreCdcBuilder>Action to configure Firestore CDC settings via the fluent builder.
Returns
- ICdcBuilder
The builder for fluent chaining.
Examples
services.AddCdcProcessor(cdc =>
{
cdc.UseFirestore(firestore =>
{
firestore.CollectionPath("orders")
.ProcessorName("order-cdc")
.MaxBatchSize(200)
.WithStateStore(state =>
{
state.ConnectionString("my-state-project") // maps to project ID
.TableName("cdc-positions"); // maps to CollectionName
});
});
});
Remarks
This overload provides the fluent builder pattern with
WithStateStore(Action<ICdcStateStoreBuilder>)
support for configuring a separate Firestore project for state persistence.
Firestore uses project IDs instead of connection strings;
use ConnectionString to set the project ID.
Exceptions
- ArgumentNullException
Thrown when
builderorconfigureis null.