Skip to content
This repository was archived by the owner on Jul 13, 2026. It is now read-only.

README.md

Latest commit

 

History

History
101 lines (75 loc) · 4.65 KB

README.md

File metadata and controls

101 lines (75 loc) · 4.65 KB
Raw
page_type sample
languages
java
products
java sdk
description Sample code repo for Azure Cosmos DB Java SDK for SQL API
urlFragment

Azure Cosmos DB Java SQL API Samples

Sample code repo for Azure Cosmos DB Java SDK for SQL API. By cloning and running these samples, and then studying their implementations, you will have an example for sending various requests to Azure Cosmos DB from Java SDK via the SQL API.

Contents

File/folder Description
src Java sample source code. Many samples have 'sync' and 'async' variants
.gitignore Define what to ignore at commit time.
CHANGELOG.md List of changes to the sample.
CONTRIBUTING.md Guidelines for contributing to the sample.
README.md This README file.
LICENSE The license for the sample.
pom.xml Maven Project Object Model File

Prerequisites

  • A Java IDE such as IntelliJ IDEA or VSCode
  • Maven
  • Java SE JRE 8
  • Setting up an Azure Cosmos DB account through the Azure Portal. The Create a database account section of this guide walks you through account creation.
  • The hostname and master key for your Azure Cosmos DB account

Setup

Clone the sample to your PC. Using your Java IDE, open pom.xml as a Maven project.

Running the sample

If you are using Intellij IDEA as your Java IDE: Once you have opened the project, go to the Run/Debug Configurations drop-down and choose Edit Configurations. In the Edit Configurations dialog, click the + (Add New Configuration) button, select Application as the configuration type, and give the new configuration a name. Once you are looking at the settings for your new Configuration, find Environment variables and paste

ACCOUNT_HOST=your account hostname;ACCOUNT_KEY=your account master key

which gives the sample read/write access to your account.

To choose which sample will run, populate the Main class field of the Configuration with

com.azure.cosmos.examples.sample.synchronicity.MainClass

where sample.synchronicity.MainClass can be

  • crudquickstart.sync.SampleCRUDQuickstart
  • crudquickstart.async.SampleCRUDQuickstartAsync
  • indexmanagement.sync.SampleIndexManagement
  • indexmanagement.async.SampleIndexManagementAsync
  • storedprocedure.sync.SampleStoredProcedure
  • storedprocedure.async.SampleStoredProcedureAsync
  • changefeed.SampleChangeFeedProcessor (Changefeed has only an async sample, no sync sample.)

Build and execute from command line without an IDE: From top-level directory of repo:

mvn clean package
mvn exec:java -Dexec.mainClass="com.azure.cosmos.examples.changefeed.sample" -DACCOUNT_HOST=your account hostname -DACCOUNT_KEY=your account master key

where sample, your account hostname, and your account master key are to be filled in as above. This will rebuild and run the selected sample.

Key concepts

These samples cover a range of Azure Cosmos DB usage topics from more to less basic:

  • Basic management of databases, containers and items
  • Indexing, stored procedures
  • Change Feed

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 the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.