Table of Contents

Class FirestoreCdcStateStore

Namespace
Excalibur.Cdc.Firestore
Assembly
Excalibur.Cdc.Firestore.dll

Firestore-backed state store for CDC position tracking.

public sealed class FirestoreCdcStateStore : IFirestoreCdcStateStore, ICdcStateStore, IAsyncDisposable, IDisposable
Inheritance
FirestoreCdcStateStore
Implements
Inherited Members

Remarks

Stores positions in a dedicated Firestore collection for durability.

Constructors

FirestoreCdcStateStore(FirestoreDb, ILogger<FirestoreCdcStateStore>)

Initializes a new instance of the FirestoreCdcStateStore class.

public FirestoreCdcStateStore(FirestoreDb db, ILogger<FirestoreCdcStateStore> logger)

Parameters

db FirestoreDb

The Firestore database.

logger ILogger<FirestoreCdcStateStore>

The logger.

FirestoreCdcStateStore(FirestoreDb, IOptions<FirestoreCdcStateStoreOptions>, ILogger<FirestoreCdcStateStore>)

Initializes a new instance of the FirestoreCdcStateStore class with options.

public FirestoreCdcStateStore(FirestoreDb db, IOptions<FirestoreCdcStateStoreOptions> options, ILogger<FirestoreCdcStateStore> logger)

Parameters

db FirestoreDb

The Firestore database.

options IOptions<FirestoreCdcStateStoreOptions>

The CDC state store options.

logger ILogger<FirestoreCdcStateStore>

The logger.

FirestoreCdcStateStore(FirestoreDb, string, ILogger<FirestoreCdcStateStore>)

Initializes a new instance of the FirestoreCdcStateStore class.

public FirestoreCdcStateStore(FirestoreDb db, string collectionName, ILogger<FirestoreCdcStateStore> logger)

Parameters

db FirestoreDb

The Firestore database.

collectionName string

The collection name for storing positions.

logger ILogger<FirestoreCdcStateStore>

The logger.

Methods

DeletePositionAsync(string, CancellationToken)

Deletes the checkpoint for the specified consumer.

public Task<bool> DeletePositionAsync(string consumerId, CancellationToken cancellationToken)

Parameters

consumerId string

A unique identifier for the CDC consumer.

cancellationToken CancellationToken

A token to observe for cancellation requests.

Returns

Task<bool>

true if a checkpoint was deleted; false if no checkpoint existed for the consumer.

Remarks

Use this to reset a consumer to start processing from the beginning, or to clean up checkpoints for decommissioned consumers.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

GetPositionAsync(string, CancellationToken)

Gets the last saved position for a processor.

public Task<FirestoreCdcPosition?> GetPositionAsync(string processorName, CancellationToken cancellationToken)

Parameters

processorName string

The unique processor name.

cancellationToken CancellationToken

A token to observe for cancellation requests.

Returns

Task<FirestoreCdcPosition>

The last saved position, or null if no position exists.

SavePositionAsync(string, FirestoreCdcPosition, CancellationToken)

Saves the current position for a processor.

public Task SavePositionAsync(string processorName, FirestoreCdcPosition position, CancellationToken cancellationToken)

Parameters

processorName string

The unique processor name.

position FirestoreCdcPosition

The position to save.

cancellationToken CancellationToken

A token to observe for cancellation requests.

Returns

Task

A task representing the asynchronous operation.