API reference

Generated reference for every public type in Microsoft.Azure.CosmosRepository and Microsoft.Azure.CosmosRepository.AspNetCore.

A complete reference for every public type in the Microsoft.Azure.CosmosRepository and Microsoft.Azure.CosmosRepository.AspNetCore packages — pick a namespace to dive in.

Microsoft.Azure.CosmosRepository

• EtagItem
  A base helper class that implements IItemWithEtag
• FullItem
  A base helper class that implements IItemWithEtag
• IBatchRepository<TItem>
  This is the batch enabled repository interface for any implementation of
• IItem
  The base interface used for all repository object or object graphs.
• IItemWithEtag
  The base interface used for all repository object or object graphs.
• IItemWithTimeStamps
  An implementation of IItem with the additional property “CreatedTime”.
• IItemWithTimeToLive
  An implementation of IItem with the additional property “TimeToLive”.
• IQueryResult<TItem>
  Represent a full set of data from a cosmos query
• IReadOnlyRepository<TItem>
  This is the read-only repository interface for any implementation of
• IRepository<TItem>
  This is the repository interface for any implementation of
• IRepositoryFactory
  A factory abstraction for a component that can
• Item
  A base helper class that implements IItem
• IWriteOnlyRepository<TItem>
  This is the write-only repository interface for any implementation of
• QueryResult<T>
  
• TimeStampedItem
  A base helper class that implements IItemWithTimeStamps
• TimeToLiveItem
  A base helper class that implements IItemWithTimeToLive

Microsoft.Azure.CosmosRepository.AspNetCore

• CosmosRepositoryChangeFeedHostedService
  A BackgroundService to start and stop the IChangeFeedService

Microsoft.Azure.CosmosRepository.AspNetCore.Extensions

• HealthChecksBuilderExtensions
  
• ServiceCollectionExtensions
  Extension methods for adding and configuring the Azure Cosmos DB services when running on ASP.NET CORE.
• ServiceProviderExtensions
  Extension methods for IServiceProvider to support Cosmos Repository operations.

Microsoft.Azure.CosmosRepository.Attributes

• ContainerAttribute
  The container attribute exposes the ability to declaratively
• PartitionKeyPathAttribute
  The partition key path attribute exposes the ability to declaratively
• UniqueKeyAttribute
  The unique key attribute exposes the ability to declaratively

Microsoft.Azure.CosmosRepository.Builders

• ContainerOptionsBuilder
  Options for a container
• IItemContainerBuilder
  A builder to configure a container for an item
• IPatchOperationBuilder<TItem>
  Allows a collection of PatchOperation’s to built./&gt;

Microsoft.Azure.CosmosRepository.ChangeFeed

• ChangeFeedOptions
  The options for monitoring the change feed.
• IChangeFeedService
  Allows for change feed monitoring.
• IContainerChangeFeedProcessor
  A processor that can process changes from the changed feed.
• IItemChangeFeedProcessor<TItem>
  A processor to process changes for the given IItem

Microsoft.Azure.CosmosRepository.ChangeFeed.InMemory

• InMemoryChangeFeed<TItem>
  Represents a change feed for a given IItem

Microsoft.Azure.CosmosRepository.ChangeFeed.Providers

• IChangeFeedContainerProcessorProvider
  Allows an external library to provide its own set of IContainerChangeFeedProcessor’s
• ILeaseContainerProvider
  Provides access to the lease container.

Microsoft.Azure.CosmosRepository.Exceptions

• BatchOperationException<TItem>
  Details an error when performing a batch operation for a given TItem
• InvalidEtagConfigurationException
  An exception stating that the mix of verifyEtag and the Etag value on the item were incompatible.
• MissMatchedChangeFeedOptionsException
  An exception stating that IItem’s sharing a container have configured different change feed options.
• MissMatchedTypeDiscriminatorException
  This exception is thrown when the type field does not match the IItem’s type.

Microsoft.Azure.CosmosRepository.Extensions

• ConfigurationExtensions
  Some useful extensions to pull values that will ve populated into RepositoryOptions from configuration
• ValueTaskExtensions
  A set of useful extension methods for a ValueTask

Microsoft.Azure.CosmosRepository.Options

• RepositoryOptions
  A repository options class, representing
• RepositorySerializationOptions
  The serialization options for the Cosmos DB repository.

Microsoft.Azure.CosmosRepository.Paging

• IPage<T>
  Represents a page of data from a cosmos query
• IPageQueryResult<T>
  Represents a page of data from a cosmos query
• Page<T>
  Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all
• PageQueryResult<T>
  Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all

Microsoft.Azure.CosmosRepository.Providers

• ICosmosClientOptionsProvider
  The cosmos client options provider exposes a means of providing
• ICosmosClientProvider
  The cosmos client provider exposes a means of providing
• ICosmosContainerProvider<TItem>
  The cosmos container provider exposes a means of providing

Microsoft.Azure.CosmosRepository.Services

• ICosmosContainerService
  Responsible for providing functions to work with containers
• ICosmosContainerSyncService
  Allows containers properties to be sunk.

Microsoft.Azure.CosmosRepository.Specification

• BaseSpecification<TItem, TResult>
  defines a specification
• ContinuationTokenSpecification<TItem>
  defines a specification
• DefaultSpecification<TItem>
  A specification used for getting all results in a QueryResult
• ISpecification<TItem, TResult>
  defines a specification
• OffsetByPageNumberSpecification<TItem>
  A specification used for the Offset and Limit pattern
• OrderExpressionInfo<TItem>
  
• OrderTypeEnum
  Whether to (subsequently) sort ascending or descending.
• WhereExpressionInfo<TItem>
  Container class for a where predicate

Microsoft.Azure.CosmosRepository.Specification.Builder

• IOrderedSpecificationBuilder<TItem, TResult>
  Defines a builder that can build a specification
• ISpecificationBuilder<TItem, TResult>
  Defines a builder that can build a specification

Microsoft.Extensions.DependencyInjection

• ServiceCollectionExtensions
  Extension methods for adding and configuring the Azure Cosmos DB services.

Microsoft.Extensions.Hosting

• HostApplicationBuilderExtensions
  Extension methods for IHostApplicationBuilder to add Cosmos DB repository client.