Officially out now: The TypeDB 3.0 Roadmap >>

Using TypeDB Studio

TypeDB Studio hero image

 
TypeDB Studio is a graphical tool for managing and querying TypeDB databases.

With Studio, developers can efficiently manage databases, execute queries, and explore query results, all within a unified environment. It has a first-class TypeQL support, as well as a type browser, type editor, and query result visualizer.

GitHub

The GitHub repository with the source code and release notes.

Install

The TypeDB Studio installation guide.

Setting up

To start querying, first complete the following steps:

  1. Select a project directory to use as a workspace.

  2. Connect to a TypeDB deployment.

  3. Select a database to work with.

Select a project directory

TypeDB Studio stores TypeQL files you create in a local project directory. To select a directory, click the studio projects Open Project Directory button in the top toolbar.

Connect to TypeDB

Select TypeDB edition below, and follow the instructions:

  • Cloud

  • Core

TypeDB Studio connect window

  1. Click Connect to TypeDB on the right side of the top toolbar.

  2. Switch the Server field drop-down to TypeDB Cloud.

  3. Click Manage Cloud Addresses button.

  4. Add address and port for at least one server from your TypeDB Cloud deployment, then close the Address Management window.

  5. Fill in the Username and Password fields with valid user credentials.

  6. Turn on the Enable TLS option and leave the CA Certificate field empty. For self-hosted deployments, encryption parameters may vary.

  7. Click Connect.

TypeDB Studio connect window

  1. Click Connect to TypeDB on the right side of the top toolbar.

  2. Make sure the TypeDB Core option is selected in the Server field.

  3. Enter the address and port of the server to connect to (e.g. localhost:1729).

  4. Click Connect.

Select a database

To select a database to work with, use the dropdown menu on the right of the studio dbs database icon in the top toolbar. If there are no databases, see how to create a new one first.

If the dropdown menu is greyed out and unresponsive, then check the connection to your TypeDB deployment.

Database management

Database Manager with IAM database

Databases can be created and deleted via the database management window. To access database management controls, ensure TypeDB Studio is connected to a TypeDB deployment.

Create a database

  1. Click on the studio dbs database button in the top toolbar to open the database management window.

  2. Enter the name for the new database.

  3. Click Create.

Delete a database

  1. Click on the studio dbs database button in the top toolbar to open the database management window.

  2. Click the studio trash trashcan button to the right of the database’s name.

  3. Confirm deletion by typing its name and clicking the Delete button.

Version Compatibility

For older TypeDB versions, you’ll need a compatible version of TypeDB Studio. Select the correct TypeDB Studio version from the version compatibility table, and download it from Cloudsmith.

Version compatibility table
TypeDB Studio TypeDB TypeDB Community Edition

3.0.1

3.0.0 to 3.0.2

3.0.0 to 3.0.2