Create a notebook in DataStax Studio

After you install DataStax Studio, you can create connections to your clusters and build notebooks.

Notebooks provide an intuitive interface for developers and analysts to collaborate by mixing code, documentation, and visualizations for query results. A notebook consists of the following:

One or more cells with executable code and explanatory text.
A web browser user interface combined with a connection to a database, such as a DataStax Enterprise (DSE) cluster.
Inputs and outputs of an interactive session and descriptive text that accompanies the code.

Built-in notebooks

To help you get started, your DataStax Studio installation includes the following notebooks:

What’s New in Studio v6.8.0?

Overview of new features:

+ * Support for DSE Native Graphs * Export data results to CSV or JSON * Direct Cell Links * Highlighted Statement Execution * Improved Navigation

Working with CQL v6.8.0

Tutorial to create and interact with data in a DSE cluster by writing and executing CQL code in a notebook. Learn about viewing the CQL schema with DESCRIBE commands. Learn to use content assist, syntax validation, and domain validation. View results in table view or different styles of charts. See the CQL documentation.

Working with Graph v6.8.0

Introduces the DSE Graph-centric features of Studio and provides a basic introduction to vertices sizes, edge colors, and using interactive graph features:

+ * Use display name templates to improve the display names shown in graph view * Dynamically view results in multiple views such as JSON, table, charts, and graph * Examine a subset of a graph based on an edge label, a set of edge labels, or a set of edges * Select vertices and edges, learn about vertices sizes and colors * Use full screen * Hide the code editor * Use content assist and schema-aware content assist for Gremlin code * Use schema view to see what is connected and how Learn about charting to visualize data results. * Learn how to view help for efficient keyboard shortcuts.

Working with Spark SQL v6.0.0

Quick tips and brief tutorial for working with Spark SQL in Studio. Learn to use content assist while writing a Spark SQL statement. Use schema view for a tree view of schema elements in a database. If you are new to DSE Analytics, see About DSE Analytics.

DSE Graph QuickStart v6.8.0

Introduction tutorial for using Studio to learn about DataStax Graph (core). The tutorial provides steps to insert data and run traversals. Also, see the DataStax Graph QuickStart documentation.

Create your first notebook

Start DataStax Studio if it isn’t already running.
On the Notebooks page, click Add Notebook.
Enter the notebook name.
Click Add New Connection, and then enter the connection details:
- Standard connection
- Astra connection
Use a Standard Connection to connect to a DSE cluster.
Name: Name of the connection from the notebook to a DSE cluster, such as DSE Notebook Connection

Host/IP (comma delimited): The host names or IP addresses of the DSE cluster to connect to, such as 127.0.0.1. All hosts must be in a single datacenter. Default: localhost.

Username: Optional DSE username for logging in.

Password: Optional DSE password for logging in.

Port: IP connection port, such as 9091. Default: 9042.

Use SSL: Optional configuration for encrypted connections. If selected, you must also configure the Truststore and Keystore settings. For more information, see Use SSL connections in DataStax Studio.
Use an Astra Connection to connect to an Astra DB Serverless database.
Name: Name of the connection from the notebook to an Astra DB Serverless database, such as Astra Notebook Connection

Secure Connection Bundle path: The absolute path to a local copy of your database’s Secure Connect Bundle (SCB).

Client ID and Client Secret: Optional client ID and secret values from an Astra application token.
Once you create a connection, you can use that connection for all of your notebooks, and you can switch connections as needed. The connection automatically populates if you have only one connection available. For more information, see Create a connection in DataStax Studio.
Click Test to verify the connection.
Click Save to save the connection.
Click Create to create your notebook.

Add a cell

Initially, the notebook has a single empty cell in CQL edit mode. You can change the cell’s language to Gremlin, SparkSQL, or Markdown.

In the default cell, use the Keyspace setting to set the context for your CQL statements.

For more information, see Use CQL in DataStax Studio.
Enter the following code in the cell:
```
describe tables;
select * from TABLE_NAME;
```
Replace TABLE_NAME with the name of a table in your keyspace.
Click Run Cell to run the command.
Click Add Cell to add another cell to the notebook.
Set the Language to Markdown.

Add some Markdown-formatted text to the cell, for example:

My Notebook
-----------
Schema-aware content-assist improves productivity. Studio inspects your schema to make smart suggestions based on your data model. When you work with properties of a person, then you'll see suggestions for name and date_of_birth.

Click Run Cell to render the text.
Continue creating cells to populate your notebook with code snippets and text.

Create a notebook in DataStax Studio

Built-in notebooks

Create your first notebook

Add a cell

Next steps

Was this helpful?

Give Feedback