YesSql.Provider.CosmosDb
0.1.5
See the version list below for details.
dotnet add package YesSql.Provider.CosmosDb --version 0.1.5
NuGet\Install-Package YesSql.Provider.CosmosDb -Version 0.1.5
<PackageReference Include="YesSql.Provider.CosmosDb" Version="0.1.5" />
<PackageVersion Include="YesSql.Provider.CosmosDb" Version="0.1.5" />
<PackageReference Include="YesSql.Provider.CosmosDb" />
paket add YesSql.Provider.CosmosDb --version 0.1.5
#r "nuget: YesSql.Provider.CosmosDb, 0.1.5"
#:package YesSql.Provider.CosmosDb@0.1.5
#addin nuget:?package=YesSql.Provider.CosmosDb&version=0.1.5
#tool nuget:?package=YesSql.Provider.CosmosDb&version=0.1.5
NOTICE: AI GENERATED SLOP. KNOWN TO WORK, BUT BARELY REVIEWED. TAKE APPROPRIATE PERCAUTIONS IN YOUR DOWNSTREAM WORKS.
YesSql.Provider.CosmosDb
A YesSql storage provider for Azure Cosmos DB (NoSQL API). It lets YesSql, and applications built on it such as Orchard Core, keep their documents and indexes in a Cosmos DB container.
YesSql ships providers for SQL Server, PostgreSQL, MySQL and SQLite. This package adds Cosmos DB without forking YesSql.
Status
Preview (0.1.x). Interfaces and behavior may still change.
- YesSql's own test suite (
CoreTests) passes in full against the Cosmos DB emulator on both partition strategies: 249 of 249 tests for YesSql 5.4.7, and the 6.0.0 suite (the tests that do not need a database server). The 5.4.7 suite also passes 249 of 249 against a real serverless account on both strategies. See docs/CONFORMANCE.md. - A minimal Orchard Core 3.0.1 site runs its setup recipe and serves requests with this provider as its only data store. See docs/ORCHARD-INTEGRATION.md.
- Read Limitations before using this with real data.
Installation
dotnet add package YesSql.Provider.CosmosDb
Targets net8.0 and net10.0.
Compatibility
| Orchard Core | YesSql | Sample status |
|---|---|---|
| 3.0.x (stable) | 5.4.7 | Sets up and serves from Cosmos. Run in CI. |
4.0.0 preview (4.0.0-preview-19175) |
6.0.0 | Sets up and serves from Cosmos. Run in CI as a non-gating check, because previews change. |
The package is built against YesSql 5.4.7 and works with YesSql 6.0.0: YesSql 6.0.0's own tests pass against it on both partition strategies. No stable Orchard Core release uses YesSql 6 yet.
Orchard Core and YesSql versions have to match. Orchard Core 3.0.x was built against YesSql 5.4.7 and calls overloads that YesSql 6.0.0 removed. Adding YesSql 6.0.0 to a project that uses Orchard Core 3.0.x fails at startup with a MissingMethodException (for example on IStore.InitializeCollectionAsync), thrown from Orchard Core's own data access setup. Without an explicit YesSql reference, Orchard Core 3.0.x and this package both resolve YesSql 5.4.7. If you see this exception, check which YesSql version your application actually restores (dotnet list package --include-transitive), and use 5.4.7 with Orchard Core 3.0.x.
samples/OrchardSmokeTest builds against either line. Select one with -p:OrchardCoreVersion=<version>; the default is 3.0.1. See Orchard Core integration.
Usage
using Microsoft.Azure.Cosmos;
using YesSql;
using YesSql.Provider.CosmosDb;
var configuration = new Configuration()
.UseCosmosDb(new CosmosDbOptions
{
AccountEndpoint = "https://my-account.documents.azure.com:443/",
AccountKey = "<key>",
DatabaseId = "myapp",
})
.UseDefaultIdGenerator();
var store = await StoreFactory.CreateAndInitializeAsync(configuration);
await using var session = store.CreateSession();
await session.SaveAsync(new Person { Name = "Alice" });
await session.SaveChangesAsync();
The database and container are created on first use unless CreateIfNotExists is false.
Options
| Option | Default | Description |
|---|---|---|
AccountEndpoint, AccountKey |
required | Cosmos account endpoint and key. |
DatabaseId |
required | Database that holds the store. |
ContainerId |
yessql |
Container for all documents and index rows. |
PartitionKeyPath |
/pk |
Single-level path such as /pk or /tenantId. Items store their partition key in that property. An existing container must use the same path. |
PartitionStrategy |
PerTable |
How items map to logical partitions. See below. |
PartitionScope |
store |
Partition key value used by PerStore, for example a tenant name. |
CreateIfNotExists |
true |
Create the database and container if they do not exist. |
ClientOptions |
null |
CosmosClientOptions passed to the SDK client. Needed for the emulator. |
Partition strategies
Cosmos DB can only commit atomically within a single logical partition. A YesSql unit of work writes several items (the document, its index rows and any bridge rows), so the partitioning choice decides what rollback can guarantee.
| Strategy | Partition key | Rollback of a unit of work | Scale limit |
|---|---|---|---|
PerTable (default) |
YesSql table name | Best effort, item by item | None beyond Cosmos itself |
PerStore |
PartitionScope |
One transactional batch per 100 items changed | 20 GB and 10,000 RU/s per store |
PerStore fits workloads with bounded data per store, such as one Orchard Core tenant per PartitionScope. A rollback is atomic only while it fits in one batch and the batch is accepted; the exact guarantee and its limits are in docs/PARTITIONING.md.
Limitations
- The provider is not a SQL engine. YesSql talks to it through ADO.NET and SQL text, and it recognizes the statement shapes that YesSql and Orchard Core generate. A statement outside the SQL it understands is rejected with a
DbExceptionthat names the position of the problem, and one it parses but cannot run throwsNotSupportedException. - There is no isolation between sessions. Writes are applied as they happen, so another session can read changes from a unit of work that has not committed. On rollback the provider restores the previous version of each item, which can overwrite a concurrent writer's changes to the same item.
- With
PerTable, a failed unit of work is rolled back item by item, and a crash during rollback can leave partial writes. - A count, a first match, or a page ordered by document id (the order YesSql gives a paged query that has no order of its own) over one map index is answered by Cosmos from the distinct document ids. Orders on an index column, queries through a reduce index or several indexes, and queries that filter on the document type read every matching index row to the client, then order and page there, so their request unit cost grows with the number of matching index rows. At 500 rows per key on a real account, a count cost 7 RU and an ordered page of 20 documents cost 24 RU.
- A save makes about 6 requests for a document with a map and a reduce index (50 RU before ids were reserved in blocks, 38 RU now), so its latency is several round trips. Over a real network that is roughly 400 ms.
PerStorelimits the whole store to 20 GB of data and 10,000 RU/s.- The automated tests in CI run against the emulator. The 5.4.7 conformance suite has also been run against one real serverless account (West US); that run found a date comparison the emulator does not reproduce (see the changelog). Behavior and request unit cost on a live account at scale have not been measured.
Running against the emulator
Development uses the Linux emulator image (vnext-preview). It serves plain HTTP on port 8081, so use http://localhost:8081/. Use gateway mode. Emulators that serve HTTPS present a self-signed certificate, which has to be accepted explicitly:
docker run -d --name cosmos-emu -p 8081:8081 -p 10250-10255:10250-10255 \
mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview
ClientOptions = new CosmosClientOptions
{
ConnectionMode = ConnectionMode.Gateway,
LimitToEndpoint = true,
// Emulator only. Skip certificate validation for a loopback endpoint and never for a real account.
HttpClientFactory = Uri.TryCreate(endpoint, UriKind.Absolute, out var uri) && uri.IsLoopback
? () => new HttpClient(new HttpClientHandler
{
ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator,
})
: null,
}
Do not use DangerousAcceptAnyServerCertificateValidator with a real Cosmos DB account. It turns off certificate validation for the connection that carries the account key.
The account key in this repository's tests and sample is the emulator's published default key. It is not a secret.
Building and testing
dotnet build YesSql.Provider.CosmosDb.slnx
# Provider tests (emulator must be running)
dotnet test test/YesSql.Provider.CosmosDb.Tests
# YesSql's CoreTests against Cosmos. Fetch the YesSql sources first.
pwsh scripts/clone-yessql.ps1
dotnet test test/Conformance/YesSql.Provider.CosmosDb.Conformance.csproj
See docs/CONFORMANCE.md for how the conformance project works, including the PerStore run.
Documentation
- Architecture: storage model and how SQL is translated to Cosmos operations
- Partitioning and transactions
- Conformance and tests
- Orchard Core integration
- Changelog
Contributing
Issues and pull requests are welcome. Run both test projects against the emulator before submitting a change that touches CosmosDbCommand, since that is where SQL is translated and run.
License
MIT. See LICENSE.
This is an independent project and is not affiliated with Microsoft, the YesSql project or the Orchard Core project.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Microsoft.Azure.Cosmos (>= 3.60.0)
- Newtonsoft.Json (>= 13.0.4)
- YesSql.Core (>= 5.4.7)
-
net8.0
- Microsoft.Azure.Cosmos (>= 3.60.0)
- Newtonsoft.Json (>= 13.0.4)
- YesSql.Core (>= 5.4.7)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.