Interface ICloudNativePersistenceProvider
- Namespace
- Excalibur.Data.CloudNative
- Assembly
- Excalibur.Data.Abstractions.dll
Defines core persistence operations for cloud-native document databases.
public interface ICloudNativePersistenceProvider : IDocumentPersistenceProvider, IPersistenceProvider, IAsyncDisposable, IDisposable
- Inherited Members
Remarks
This interface extends IDocumentPersistenceProvider with cloud-native specific capabilities including partition key management and configurable consistency levels.
Advanced features are available as ISP sub-interfaces via GetService(Type):
- ICloudNativeProviderInfo -- cloud provider type metadata
- ICloudNativePersistenceQueryOperations -- partition-scoped queries
- ICloudNativePersistenceBatchOperations -- transactional batch execution
- ICloudNativePersistenceChangeFeed -- change feed subscriptions and capability flags
Supported Providers:
- Azure Cosmos DB
- AWS DynamoDB
- Google Cloud Firestore
Methods
CreateAsync<TDocument>(TDocument, IPartitionKey, CancellationToken)
Creates a new document with partition key.
Task<CloudOperationResult<TDocument>> CreateAsync<TDocument>(TDocument document, IPartitionKey partitionKey, CancellationToken cancellationToken) where TDocument : class
Parameters
documentTDocumentThe document to create.
partitionKeyIPartitionKeyThe partition key for the document.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<CloudOperationResult<TDocument>>
The operation result with cost information.
Type Parameters
TDocumentThe document type.
DeleteAsync(string, IPartitionKey, string?, CancellationToken)
Deletes a document with optimistic concurrency using ETag.
Task<CloudOperationResult> DeleteAsync(string id, IPartitionKey partitionKey, string? etag, CancellationToken cancellationToken)
Parameters
idstringThe document ID to delete.
partitionKeyIPartitionKeyThe partition key for the document.
etagstringThe ETag for optimistic concurrency (null to skip check).
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<CloudOperationResult>
The operation result with cost information.
GetByIdAsync<TDocument>(string, IPartitionKey, IConsistencyOptions?, CancellationToken)
Gets a document by ID with partition key and consistency options.
Task<TDocument?> GetByIdAsync<TDocument>(string id, IPartitionKey partitionKey, IConsistencyOptions? consistencyOptions, CancellationToken cancellationToken) where TDocument : class
Parameters
idstringThe document ID.
partitionKeyIPartitionKeyThe partition key for the document.
consistencyOptionsIConsistencyOptionsConsistency options for the read.
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<TDocument>
The document if found, null otherwise.
Type Parameters
TDocumentThe document type.
UpdateAsync<TDocument>(TDocument, IPartitionKey, string?, CancellationToken)
Updates a document with optimistic concurrency using ETag.
Task<CloudOperationResult<TDocument>> UpdateAsync<TDocument>(TDocument document, IPartitionKey partitionKey, string? etag, CancellationToken cancellationToken) where TDocument : class
Parameters
documentTDocumentThe document to update.
partitionKeyIPartitionKeyThe partition key for the document.
etagstringThe ETag for optimistic concurrency (null to skip check).
cancellationTokenCancellationTokenCancellation token.
Returns
- Task<CloudOperationResult<TDocument>>
The operation result with new ETag and cost information.
Type Parameters
TDocumentThe document type.