datastax/dse-studio repository overview

⁠Short Description

DataStax Studio is official tooling for DataStax Enterprise⁠. DataStax Studio is an interactive tool for CQL (Cassandra Query Language) and DataStax Enterprise Graph.

⁠Quick Reference

⁠Where to get help:

DataStax Docker Docs⁠, DataStax Discord⁠, Github⁠, Contact Us for more information on becoming a DataStax Customer⁠

Advanced tutorials are located within DataStax Academy⁠

Featured Tutorial - DataStax Enterprise 6 Guided Tour⁠

⁠Where to file issues:

https://github.com/datastax/docker-images/issues⁠

⁠Maintained by

DataStax⁠

⁠What is DataStax Studio

DataStax Studio is an interactive tool for CQL (Cassandra Query Language) and DataStax Enterprise⁠ Graph.

⁠Getting Started with DataStax and Docker

DataStax Docker images are licensed only for Development purposes in non-production environments. You can use these images to learn DSE⁠, OpsCenter⁠ and DataStax Studio⁠, to try new ideas, to test and demonstrate your application.

⁠Creating a Studio Container

Follow these steps to create a DataStax Studio container that is connected to a DataStax Enterprise (DSE) server⁠ container on the same Docker host.

To create and connect the containers:

1. Create a DataStax Studio container:

docker run -e DS_LICENSE=accept --link my-dse --name my-studio -p 9091:9091 -d datastax/dse-studio

1. Open a browser and go to http://DOCKER_HOST_IP:9091

2. Create the new connection using my-dse as the hostname, see DataStax Studio User Guide > Creating a new connection⁠ for further instructions.

Studio is ready to use with DSE. See DataStax Studio User Guide⁠ for detailed usage and configuration instructions.

⁠Managing the configuration

Manage the Studio configuration using one of the following options:

• DSE configuration volume⁠ For configuration management, we’re providing a simple mechanism to let you provide custom configuration file(s) without customizing the containers or over using host volumes. You can add any of the approved config files⁠ to a single mounted host volume and we’ll handle the hard work of mapping them within the container.

• Docker file/directory volume mounts

• Docker overlay file system

⁠Using the DSE config volume

To use this feature:

1. Create a directory on your local host.
2. Download and customize the configuration files you want to use from the config-templates⁠ page.
3. Add the custom configuration files to the host directory you created.
   • The file name must match a corresponding configuration file in the image and include all the required values, for example configuration.yaml.
4. Mount the exposed Volume /config to the local directory.
5. Start the container. For example to start a database node:

docker run -e DS_LICENSE=accept --link my-dse --name my-studio  -v /studio/config:/config -p 9091:9091 -d datastax/dse-studio

Note When you make changes to or add config files to the /config volume, you will need to restart your container with docker restart container_name for studio to pickup the changes. Restarting the container will restart studio.

⁠Volumes and data

To persist data, pre-create directories on the local host and map the directory to the corresponding volume using the docker run -v flag.

NOTE: If the volumes are not mounted from the local host, all data is lost when the container is removed.

Studio images expose the following volumes.

• /var/lib/datastax-studio

docker run -v <local_directory>:<container_volume>

See Docker docs > Use volumes⁠ for more information.

⁠Opening an interactive bash shell

If the container is running in the background (using the -d), use the following command to open an interactive bash shell.

docker exec -it <container_name> bash

To exit the shell without stopping the container type exit.

⁠Viewing logs

You can view the Studio logs using the Docker log command. For example:

docker logs my-studio

⁠Next Steps

Head over to the DataStax Docker Docs⁠ and DataStax Academy⁠ for advanced documentation including

• Apache Cassandra™/Datastax configuration management
• Using environment variables
• Persisting data
• Exposing public ports
• Volumes and data directories
• Docker Compose examples to spin up connected clusters of DataStax Enterprise, Studio, and Opscenter (also on github⁠)
• Step-by-step tutorials and examples
• How to build applications using Apache Cassandra™/ DataStax

⁠Licensing

Use the following links to review the license: Studio License Terms⁠ | DataStax License Terms⁠