title | description | services | ms.service | author | ms.author | ms.component | ms.custom | ms.devlang | ms.topic | ms.date |
---|---|---|---|---|---|---|---|---|---|---|
Quickstart: Cassandra API with Java - Azure Cosmos DB |
This quickstart shows how to use the Azure Cosmos DB Cassandra API to create a profile application with the Azure portal and Java |
cosmos-db |
cosmos-db |
SnehaGunda |
sngun |
cosmosdb-cassandra |
quick start connect, mvc |
java |
quickstart |
09/24/2018 |
[!div class="op_single_selector"]
This quickstart shows how to use Java and the Azure Cosmos DB Cassandra API to build a profile app by cloning an example from GitHub. This quickstart also shows you how to use the web-based Azure portal to create an Azure Cosmos DB account.
Azure Cosmos DB is Microsoft's globally distributed multi-model database service. You can quickly create and query document, table, key-value, and graph databases, all of which benefit from the global distribution and horizontal scale capabilities at the core of Azure Cosmos DB.
[!INCLUDE quickstarts-free-trial-note] Alternatively, you can Try Azure Cosmos DB for free without an Azure subscription, free of charge and commitments.
In addition, you need:
- Java Development Kit (JDK) 1.7+
- On Ubuntu, run
apt-get install default-jdk
to install the JDK. - Be sure to set the JAVA_HOME environment variable to point to the folder where the JDK is installed.
- On Ubuntu, run
- Download and install a Maven binary archive
- On Ubuntu, you can run
apt-get install maven
to install Maven.
- On Ubuntu, you can run
- Git
- On Ubuntu, you can run
sudo apt-get install git
to install Git.
- On Ubuntu, you can run
Before you can create a document database, you need to create a Cassandra account with Azure Cosmos DB.
[!INCLUDE cosmos-db-create-dbaccount-cassandra]
Now let's switch to working with code. Let's clone a Cassandra app from GitHub, set the connection string, and run it. You'll see how easy it is to work with data programmatically.
-
Open a command prompt. Create a new folder named
git-samples
. Then, close the command prompt.md "C:\git-samples"
-
Open a git terminal window, such as git bash, and use the
cd
command to change to the new folder to install the sample app.cd "C:\git-samples"
-
Run the following command to clone the sample repository. This command creates a copy of the sample app on your computer.
git clone https://github.com/Azure-Samples/azure-cosmos-db-cassandra-java-getting-started.git
This step is optional. If you're interested to learn how the code creates the database resources, you can review the following snippets. Otherwise, you can skip ahead to Update your connection string. These snippets are all taken from the src/main/java/com/azure/cosmosdb/cassandra/util/CassandraUtils.java
file.
-
The Cassandra host, port, user name, password, and SSL options are set. The connection string information comes from the connection string page in the Azure portal.
cluster = Cluster.builder().addContactPoint(cassandraHost).withPort(cassandraPort).withCredentials(cassandraUsername, cassandraPassword).withSSL(sslOptions).build();
-
The
cluster
connects to the Azure Cosmos DB Cassandra API and returns a session to access.return cluster.connect();
The following snippets are from the src/main/java/com/azure/cosmosdb/cassandra/repository/UserRepository.java
file.
-
Create a new keyspace.
public void createKeyspace() { final String query = "CREATE KEYSPACE IF NOT EXISTS uprofile WITH replication = {'class': 'SimpleStrategy', 'replication_factor': '3' } "; session.execute(query); LOGGER.info("Created keyspace 'uprofile'"); }
-
Create a new table.
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'"); }
-
Insert user entities using a prepared statement object.
public PreparedStatement prepareInsertStatement() { final String insertStatement = "INSERT INTO uprofile.user (user_id, user_name , user_bcity) VALUES (?,?,?)"; return session.prepare(insertStatement); } public void insertUser(PreparedStatement statement, int id, String name, String city) { BoundStatement boundStatement = new BoundStatement(statement); session.execute(boundStatement.bind(id, name, city)); }
-
Query to get all user information.
public void selectAllUsers() { final String query = "SELECT * FROM uprofile.user"; List<Row> rows = session.execute(query).all(); for (Row row : rows) { LOGGER.info("Obtained row: {} | {} | {} ", row.getInt("user_id"), row.getString("user_name"), row.getString("user_bcity")); } }
-
Query to get a single user's information.
public void selectUser(int id) { final String query = "SELECT * FROM uprofile.user where user_id = 3"; Row row = session.execute(query).one(); LOGGER.info("Obtained row: {} | {} | {} ", row.getInt("user_id"), row.getString("user_name"), row.getString("user_bcity")); }
Now go back to the Azure portal to get your connection string information and copy it into the app. The connection string details enable your app to communicate with your hosted database.
-
In the Azure portal, select Connection String.
-
Use the
button on the right side of the screen to copy the CONTACT POINT value.
-
Open the
config.properties
file fromC:\git-samples\azure-cosmosdb-cassandra-java-getting-started\java-examples\src\main\resources
folder. -
Paste the CONTACT POINT value from the portal over
<Cassandra endpoint host>
on line 2.Line 2 of config.properties should now look similar to
cassandra_host=cosmos-db-quickstart.cassandra.cosmosdb.azure.com
-
Go back to portal and copy the USERNAME value. Past the USERNAME value from the portal over
<cassandra endpoint username>
on line 4.Line 4 of config.properties should now look similar to
cassandra_username=cosmos-db-quickstart
-
Go back to portal and copy the PASSWORD value. Paste the PASSWORD value from the portal over
<cassandra endpoint password>
on line 5.Line 5 of config.properties should now look similar to
cassandra_password=2Ggkr662ifxz2Mg...==
-
On line 6, if you want to use a specific SSL certificate, then replace
<SSL key store file location>
with the location of the SSL certificate. If a value is not provided, the JDK certificate installed at <JAVA_HOME>/jre/lib/security/cacerts is used. -
If you changed line 6 to use a specific SSL certificate, update line 7 to use the password for that certificate.
-
Save the
config.properties
file.
-
In the git terminal window,
cd
to theazure-cosmosdb-cassandra-java-getting-started\java-examples
folder.cd "C:\git-samples\azure-cosmosdb-cassandra-java-getting-started\java-examples"
-
In the git terminal window, use the following command to generate the
cosmosdb-cassandra-examples.jar
file.mvn clean install
-
In the git terminal window, run the following command to start the Java application.
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. It then selects and returns all users in the table and displays the output, and then selects a row by ID and displays the value.
Press CTRL + C to stop execution of the program and close the console window.
-
In the Azure portal, open Data Explorer to query, modify, and work with this new data.
[!INCLUDE cosmosdb-tutorial-review-slas]
[!INCLUDE cosmosdb-delete-resource-group]
In this quickstart, you've learned how to create an Azure Cosmos DB account, Cassandra database, and container using the Data Explorer, and run an app to do the same thing programmatically. You can now import additional data into your Azure Cosmos DB container.
[!div class="nextstepaction"] Import Cassandra data into Azure Cosmos DB