Skip to content

Commit 15f43be

Browse files
Added top level README for cosmos SDK (Azure#19457)
* Added top level README for cosmos SDK * Skipping cosmos top level readme from build analyze step
1 parent 043825a commit 15f43be

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

eng/.docsettings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ known_content_issues:
134134
- ['sdk/cosmos/azure-cosmos-examples/README.md', '#3113']
135135
- ['sdk/cosmos/azure-cosmos/README.md', '#3113']
136136
- ['sdk/cosmos/azure-cosmos-encryption/README.md', '#3113']
137+
- ['sdk/cosmos/README.md', '#3113']
137138
- ['sdk/e2e/README.md', '#3113']
138139
- ['sdk/eventgrid/azure-messaging-eventgrid/swagger/README.md', '#3113']
139140
- ['sdk/eventgrid/microsoft-azure-eventgrid/README.md', '#3113']

sdk/cosmos/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Azure CosmosDB Client library for Java
2+
3+
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/17?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=17) [![Build Documentation](https://img.shields.io/badge/documentation-published-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/index.html) [![Dependencies](https://img.shields.io/badge/dependencies-analyzed-blue.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/dependencies.html) [![SpotBugs](https://img.shields.io/badge/SpotBugs-Clean-success.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/spotbugsXml.html) [![CheckStyle](https://img.shields.io/badge/CheckStyle-Clean-success.svg)](https://azuresdkartifacts.blob.core.windows.net/azure-sdk-for-java/staging/checkstyle-aggregate.html)
4+
5+
Azure Cosmos DB is Microsoft’s globally distributed, multi-model database service for operational and analytics workloads. It offers multi-mastering feature by automatically scaling throughput, compute, and storage.
6+
This project provides SDK library in Java for interacting with [SQL API][sql_api_query] of [Azure Cosmos DB Database Service][cosmos_introduction].
7+
8+
## Getting started
9+
10+
To get started with a specific library, see the **README.md** file located in the library's project folder. You can find service libraries in the `/sdk/cosmos/` directory.
11+
- [Azure Cosmos](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-cosmos/README.md) is Microsoft's Azure Cosmos DB Java SDK which provides client-side logical representation to access the Azure Cosmos DB SQL API. The SDK provides Reactor Core based async APIs.
12+
- [Azure Spring Data Cosmos](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-spring-data-cosmos/README.md) provides Spring Data support for Azure Cosmos DB using the SQL API, based on Spring Data framework.
13+
- [Azure Cosmos Encryption](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-cosmos-encryption/README.md) supports encryption for Azure Cosmos DB using SQL API. This plugin library is still under development and not is not ready to be consumed yet.
14+
- [Azure Cosmos Benchmark](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-cosmos-benchmark/README.md) is the benchmarking tool which provides different kinds of benchmarking workloads including but not limited to `readLatency`, `readThroughput`, `writeThroughput`, `readMyWrites`, etc.
15+
- [Azure Cosmos DotNet Benchmark](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-cosmos-dotnet-benchmark/README.md) is the port of CosmosDB .NET benchmarking tool.
16+
- [Azure Cosmos Examples](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/cosmos/azure-cosmos-examples/README.md) provides various examples / samples on how to use Azure Cosmos DB SDK for SQL API.
17+
18+
<!-- LINKS -->
19+
[sql_api_query]: https://docs.microsoft.com/azure/cosmos-db/sql-api-sql-query
20+
[cosmos_introduction]: https://docs.microsoft.com/azure/cosmos-db/
21+
22+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fcosmos%2Fazure-cosmos%2FREADME.png)

0 commit comments

Comments
 (0)