title | description | author | ms.author | ms.reviewer | services | ms.service | ms.component | ms.topic | ms.date |
---|---|---|---|---|---|---|---|---|---|
Create an Azure Cosmos DB Cassandra API account, a database, and a table by using a Java application |
This article shows how to create a Cassandra API account, add a database (also referred as a keyspace) and a table to that account by using a java application. |
kanshiG |
govindk |
sngun |
cosmos-db |
cosmos-db |
cosmosdb-cassandra |
tutorial |
09/24/2018 |
Tutorial: Create an Azure Cosmos DB Cassandra API account, database, and a table by using a Java application
This tutorial describes how to use a Java application to create a Cassandra API account in Azure Cosmos DB, add a database (also referred as a keyspace), and add a table. The Java application uses the Java driver to create a user database that contains details such as user ID, user name, user city.
This tutorial covers the following tasks:
[!div class="checklist"]
- Create a Cassandra database account
- Get the account connection string
- Create Maven project and dependencies
- Add a database and a table
- Run the app
-
If you don't have an Azure subscription, create a free account before you begin. Alternatively, you can Try Azure Cosmos DB for free without an Azure subscription, free of charge and commitments.
-
Get the latest version of Java Development Kit (JDK)
-
Download and install the Maven binary archive
- On Ubuntu, you can run
apt-get install maven
to install Maven.
- On Ubuntu, you can run
-
Sign in to the Azure portal.
-
Select Create a resource > Databases > Azure Cosmos DB.
-
In the New account pane, enter the settings for the new Azure Cosmos DB account.
Setting Suggested value Description ID Enter a unique name Enter a unique name to identify this Azure Cosmos DB account.
Because cassandra.cosmosdb.azure.com is appended to the ID that you provide to create your contact point, use a unique but identifiable ID.API Cassandra The API determines the type of account to create.
Select Cassandra, because in this article you will create a wide-column database that can be queried by using CQL syntax.Subscription Your subscription Select Azure subscription that you want to use for this Azure Cosmos DB account. Resource Group Enter a name Select Create New, then enter a new resource-group name for your account. For simplicity, you can use the same name as your ID. Location Select the region closest to your users Select geographic location in which to host your Azure Cosmos DB account. Use the location that's closest to your users to give them the fastest access to the data. -
Next, select Create.
The account creation takes a few minutes. After the resource is created, you can see the Deployment succeeded notification on the right-hand corner of the portal.
Get the connection string information from Azure portal, and copy it into the Java configuration file. The connection string enables your app to communicate with your hosted database.
-
From the Azure portal, navigate to your Cosmos DB account.
-
Open the Connection String pane.
-
Copy the CONTACT POINT, PORT, USERNAME, and PRIMARY PASSWORD values to use in the next steps.
The Java sample project you use in this article is hosted in GitHub. You can download it from azure-cosmos-db-cassandra-java-getting-started repository.
After downloading the files, update the connection string information within the java-examples\src\main\resources\config.properties
file and run it.
cassandra_host=<FILLME_with_CONTACT POINT>
cassandra_port = 10350
cassandra_username=<FILLME_with_USERNAME>
cassandra_password=<FILLME_with_PRIMARY PASSWORD>
Alternatively, you can also build the sample from scratch.
-
From the terminal or command prompt, create a new Maven project called Cassandra-demo.
mvn archetype:generate -DgroupId=com.azure.cosmosdb.cassandra -DartifactId=cassandra-demo -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
-
Locate the
cassandra-demo
folder. Using a text editor, open thepom.xml
file that was generated.Add the Cassandra dependencies and build plugins required by your project as shown in the pom.xml file.
-
Under the
cassandra-demo\src\main
folder, create a new folder namedresources
. Under the resources folder, add the config.properties and log4j.properties files:-
The config.properties file stores the Azure Cosmos DB Cassandra API connection endpoint and key values.
-
The log4j.properties file defines the level of logging required when interacting with the Cassandra API.
-
-
Next, navigate to the
src/main/java/com/azure/cosmosdb/cassandra/
folder. Within the cassandra folder, create another folder namedutils
. The new folder stores the utility classes required to connect to the Cassandra API account.Add the CassandraUtils class to create the cluster and to open and close Cassandra sessions. The cluster connects to the Azure Cosmos DB Cassandra API and returns a session to access. Use the Configurations class to read connection string information from the config.properties file.
-
The Java sample creates a database with user information such as user name, user ID, user city. You need to define get and set methods to access user details in the main function.
Create a User.java class under
src/main/java/com/azure/cosmosdb/cassandra/
folder with get and set methods.
This section describes how to add a database (keyspace) and a table, using the Cassandra Query Language (CQL). To learn about the CQL syntax for these commands, refer to create keyspace and create table query syntax.
-
Under
src\main\java\com\azure\cosmosdb\cassandra
folder, create a new folder namedrepository
. -
Next, create the
UserRepository
Java class and add the following code to it:package com.azure.cosmosdb.cassandra.repository; import java.util.List; import com.datastax.driver.core.BoundStatement; import com.datastax.driver.core.PreparedStatement; import com.datastax.driver.core.Row; import com.datastax.driver.core.Session; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Create a Cassandra session */ public class UserRepository { private static final Logger LOGGER = LoggerFactory.getLogger(UserRepository.class); private Session session; public UserRepository(Session session) { this.session = session; } /** * Create keyspace uprofile in cassandra DB */ public void createKeyspace() { final String query = "CREATE KEYSPACE IF NOT EXISTS uprofile WITH REPLICATION = { 'class' : 'NetworkTopologyStrategy', 'datacenter1' : 1 }"; session.execute(query); LOGGER.info("Created keyspace 'uprofile'"); } /** * Create user table in cassandra DB */ public void createTable() { final String query = "CREATE TABLE IF NOT EXISTS uprofile.user (user_id int PRIMARY KEY, user_name text, user_bcity text)"; session.execute(query); LOGGER.info("Created table 'user'"); } }
-
Locate the
src\main\java\com\azure\cosmosdb\cassandra
folder, and create a new subfolder namedexamples
. -
Next, create the
UserProfile
Java class. This class contains the main method that calls the createKeyspace and createTable methods you defined earlier:package com.azure.cosmosdb.cassandra.examples; import java.io.IOException; import com.azure.cosmosdb.cassandra.repository.UserRepository; import com.azure.cosmosdb.cassandra.util.CassandraUtils; import com.datastax.driver.core.PreparedStatement; import com.datastax.driver.core.Session; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Example class which will demonstrate following operations on Cassandra Database on CosmosDB * - Create Keyspace * - Create Table * - Insert Rows * - Select all data from a table * - Select a row from a table */ public class UserProfile { private static final Logger LOGGER = LoggerFactory.getLogger(UserProfile.class); public static void main(String[] s) throws Exception { CassandraUtils utils = new CassandraUtils(); Session cassandraSession = utils.getSession(); try { UserRepository repository = new UserRepository(cassandraSession); //Create keyspace in cassandra database repository.createKeyspace(); //Create table in cassandra database repository.createTable(); } finally { utils.close(); LOGGER.info("Please delete your table after verifying the presence of the data in portal or from CQL"); } } }
-
Open a command prompt or terminal window. Paste the following code block.
This code changes directory (cd) to the folder path where you created the project. Then, it runs the
mvn clean install
command to generate thecosmosdb-cassandra-examples.jar
file within the target folder. Finally, it runs the Java application.cd cassandra-demo mvn clean install java -cp target/cosmosdb-cassandra-examples.jar com.azure.cosmosdb.cassandra.examples.UserProfile
The terminal window displays notifications that the keyspace and table are created.
-
Now, in the Azure portal, open Data Explorer to confirm that the keyspace and table were created.
In this tutorial, you've learned how to create an Azure Cosmos DB Cassandra API account, database, and a table by using a Java application. You can now proceed to the next article:
[!div class="nextstepaction"] load sample data to the Cassandra API table.