DataStax Studio

Overview

DataStax Studio is an interactive developer tool for CQL (Cassandra Query Language), Spark SQL, and DSE Graph. Developers and analysts collaborate by mixing code, documentation, query results, and visualizations in self-documenting notebooks.

• ℹ️ Introduction to DataStax Studio
• 📥 DataStax Studio Quick Install

Prerequisites

DataStax Studio Prerequisites

• You should have a supported browser
• You should have a supported version of Java
• Recommended: OpenJDK 8
• Supported: Oracle Java SE 8 (JRE or JDK)

Astra Prerequisites

• You should have an Astra account
• You should Create an Astra Database
• You should Have an Astra Token

Installation and Setup

As mentioned in the Prerequisites above, you must have DataStax Studio already installed. You can follow the quick installation steps here. Once you have successfully installed DataStax Studio, you may proceed to the following steps.

1. Start up DataStax Studio by running the Studio Server shell script:
   • Linux:

     cd installation_location/datastax-studio-6.8.0
     ./bin/server.sh
     

   • Windows:

     C:/> cd installation_location\datastax-studio-6.8.0\bin\
     C:/> server.bat
     

     Once Studio is running, your output should look something similar to this:

     Studio is now running at: http://127.0.0.1:9091
     

2. You may now use the localhost URL provided in your terminal or command line to navigate to the DataStax Studio UI. This should look something like this:

3. For this example, we will use the Getting Started with Astra notebook. A notebook is essentially a workspace used to visualize queries from your database, test and run different commands, and more.

4. On the top right corner of the notebook, click default localhost and then Add Connection to configure a new connection for the notebook.

5. A screen should appear with the options Standard Connection and Astra Connection. For this example, you will select Astra Connection.

6. Here, you will need the credentials that you gathered in the Astra Prerequisites.

   Name: <Your Database Name>
   Secure Connection Bundle path: <The path to your SCB locally>
   Client ID: <Your Client ID>
   Client Secret: <Your Client Secret>
   

   

7. Once you have filled this information out, you can select Test in the bottom right corner. If this is successful, you should see a message that says CQL connected successfully. Once this is completed, click Save.

8. In the upper right hand corner, you should be able to switch the connection to the name of the database you just configured.

Test and Validate

Finally, we will test and validate once more that the connection is validated by submitting a couple test queries.

1. Click the + symbol in the top-middle of the screen to add a new cell.

2. In the cell, you can select which Keyspace that you want to query from.

3. Run the following queries to confirm that the connection to your Astra Database is successful.

describe tables;
select * from <YOUR_TABLE>;

Once you have received the correct results back, that's it! You have successfully connected DataStax Studio to Astra DB and can use this as a tool to help model your queries. You may also scroll down within the Getting Started with Astra notebook for more examples and recommendations.

---

Last update: 2023-10-13