-
Notifications
You must be signed in to change notification settings - Fork 492
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
67 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,39 @@ | ||
|
||
# Microsoft Azure Cosmos DB .NET SDK Version 3.0 | ||
This project provides a client tools or utilities in .NET that makes it easy to interact with Azure Cosmos DB. Azure cosmos DB is published with nuget name [Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/). | ||
|
||
## SDK Public Preview announcement | ||
The .NET SDK 3.0 is currently in [Public Preview](https://azure.microsoft.com/blog/azure-cosmos-dotnet-sdk-version-3-0-now-in-public-preview/). | ||
|
||
## SDK release notes | ||
https://github.com/Azure/azure-cosmos-dotnet-v3/blob/master/changelog.md | ||
This client library enables client applications to connect to Azure Cosmos via the SQL API. Azure Cosmos is a globally distributed, multi-model database service. For more information, refer to https://azure.microsoft.com/services/cosmos-db/. | ||
|
||
```csharp | ||
CosmosClient client = new CosmosClient("https://mycosmosaccount.documents.azure.com:443/", "mysupersecretkey"); | ||
Database database = await client.CreateDatabaseIfNotExistsAsync("MyDatabaseName"); | ||
Container container = await database.CreateContainerIfNotExistsAsync( | ||
"MyContainerName", | ||
"/partitionKeyPath", | ||
400); | ||
|
||
dynamic testItem = new { id = "MyTestItemId", partitionKeyPath = "MyTestPkValue", details = "it's working" }; | ||
ItemResponse<dynamic> response = await container.CreateItemAsync(testItem); | ||
``` | ||
|
||
### SDK API | ||
https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmos?view=azure-dotnet-preview | ||
## Install via [Nuget.org](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/) | ||
|
||
## Samples | ||
Our [Samples folder](https://github.com/Azure/azure-cosmos-dotnet-v3/tree/master/Microsoft.Azure.Cosmos.Samples/CodeSamples) is a good starting point. | ||
`Install-Package Microsoft.Azure.Cosmos` | ||
|
||
## Diagnose and troubleshooting issues | ||
https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk | ||
## Useful links | ||
|
||
# Contributing | ||
- [Get Started APP](https://docs.microsoft.com/azure/cosmos-db/sql-api-get-started) | ||
- [Github samples](https://github.com/Azure/azure-cosmos-dotnet-v3/tree/master/Microsoft.Azure.Cosmos.Samples/CodeSamples) | ||
- [MultiMaster samples](https://github.com/markjbrown/azure-cosmosdb-dotnet/tree/master/samples/MultiMaster) | ||
- [Resource Model of Azure Cosmos DB Service](https://docs.microsoft.com/azure/cosmos-db/sql-api-resources) | ||
- [Cosmos DB Resource URI](https://docs.microsoft.com/rest/api/documentdb/documentdb-resource-uri-syntax-for-rest) | ||
- [Partitioning](https://docs.microsoft.com/azure/cosmos-db/partition-data) | ||
- [Introduction to SQL API of Azure Cosmos DB Service](https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query) | ||
- [SDK API](https://docs.microsoft.com/dotnet/api/microsoft.azure.cosmos?view=azure-dotnet) | ||
- [Using emulator](https://github.com/Azure/azure-documentdb-dotnet/blob/master/docs/documentdb-nosql-local-emulator.md) | ||
- [Capture traces](https://github.com/Azure/azure-documentdb-dotnet/blob/master/docs/documentdb-sdk_capture_etl.md) | ||
- [Release notes](https://github.com/Azure/azure-cosmos-dotnet-v3/blob/master/changelog.md) | ||
- [Diagnose and troubleshooting](https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk) | ||
|
||
## Contributing | ||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
|
@@ -30,3 +46,4 @@ provided by the bot. You will only need to do this once across all repos using o | |
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,30 @@ | ||
## Changes in [3.1.0](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.0.0) : ## | ||
|
||
* Fixes [#544](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/544) Adding continuation token support for LINQ | ||
* Fixes [#561](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/561) GetItemLinqQueryable now works with null query | ||
|
||
## Changes in [3.0.0](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.0.0) : ## | ||
|
||
* General availability of [Version 3.0.0](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/) of the .NET SDK | ||
* Targets .NET Standard 2.0, which supports .NET framework 4.6.1+ and .NET Core 2.0+ | ||
* New object model, with top-level CosmosClient and methods split across relevant Database and Container classes | ||
* New highly performant stream APIs | ||
* Built-in support for Change Feed processor APIs | ||
* Fluent builder APIs for CosmosClient, Container, and Change Feed processor | ||
* Idiomatic throughput management APIs | ||
* Granular RequestOptions and ResponseTypes for database, container, item, query and throughput requests | ||
* Ability to scale non-partitioned containers | ||
* Extensible and customizable serializer | ||
* Extensible request pipeline with support for custom handlers | ||
# Changelog | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## Unreleased | ||
|
||
### Added | ||
|
||
- [#544](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/544) Added continuation token support for LINQ | ||
|
||
### Fixed | ||
|
||
- [#548](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/548) Fixed mis-typed message in CosmosException.ToString(); | ||
- [#558](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/558) LocationCache ConcurrentDict lock contention fix | ||
- [#561](https://github.com/Azure/azure-cosmos-dotnet-v3/pull/561) GetItemLinqQueryable now works with null query | ||
|
||
## [3.0.0](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/3.0.0) - 2019-07-15 | ||
|
||
- General availability of [Version 3.0.0](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/) of the .NET SDK | ||
- Targets .NET Standard 2.0, which supports .NET framework 4.6.1+ and .NET Core 2.0+ | ||
- New object model, with top-level CosmosClient and methods split across relevant Database and Container classes | ||
- New highly performant stream APIs | ||
- Built-in support for Change Feed processor APIs | ||
- Fluent builder APIs for CosmosClient, Container, and Change Feed processor | ||
- Idiomatic throughput management APIs | ||
- Granular RequestOptions and ResponseTypes for database, container, item, query and throughput requests | ||
- Ability to scale non-partitioned containers | ||
- Extensible and customizable serializer | ||
- Extensible request pipeline with support for custom handlers |