TypeDB 3.0 is live! Get started for free.

TypeDB Studio

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.

Open TypeDB Studio

Launch TypeDB Studio directly from your web browser.

GitHub

The GitHub repository with the source code and release notes.

Desktop builds will be published soon, powered by Tauri.

Quickstart

Connect to TypeDB

Select TypeDB edition below, and follow the instructions:

  • Cloud

  • Enterprise

  • Community Edition

  1. In the TypeDB Cloud website, navigate to your cluster and click Connect. Then, click Connect with TypeDB Studio. This will launch TypeDB Studio.

  2. Fill in your password and hit Connect. Your password can be found in your downloaded credentials file (if you have one).

  1. Launch TypeDB Studio.

  2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000.

  3. Enter your username and password.

  4. Click Connect.

  1. Launch TypeDB Studio.

  2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000 and for local instances you can use http://localhost:8000.

  3. Enter your username and password.

  4. Click Connect.

Select a database

To select a database to work with, use the dropdown menu on the right of the database icon in the top toolbar. You can also create new databases here.

TypeDB Studio will automatically select a default database if there are no others present.

Querying

You can run queries against the connected TypeDB server using TypeDB Studio’s query tool.

Write a query

You can write TypeQL queries in the Query pane.

The Query pane contains a code editor that offers TypeQL highlighting and simple autocompletion.

Run a query

When your query is ready to run, hit "Run query" in the Query pane.

Results are printed to the Run pane.

Query results

The Run pane offers three different views of results - you can choose between Log, Table and Raw.

The Log contains textual output, similar to TypeDB Console, as well as input log, and error messages.

Table view is well suited for visualising the answers of match and fetch queries in a tabular format, where each row represents an answer, and each column represents a variable.

Raw output allows you to see the raw HTTP response from TypeDB.

History pane

All queries and transaction operations are timestamped and logged to the History pane. Any errors that occur can be retrieved from this pane.

Transaction controls

By default, transactions are fully managed by TypeDB Studio. A transaction opens when you start running a query, and commits when a schema/write query is done or closes when a read query is done.

For more fine-grained control, you can use the top bar to change the transaction mode from auto to manual. This allows you to open transactions, and perform multiple queries within a transaction before closing or committing.

Only one transaction can be open concurrently within a single instance of TypeDB Studio.

Connection management

To connect, disconnect, or change connection settings, use the connection button in the top bar. While connected to TypeDB, the button changes its label to the server’s address or the custom name provided when setting up the connection.

Error handling

Query-level errors are printed to Log Output. These are typically errors returned directly from TypeDB, and will contain detailed error codes and explanations of the problem (e.g: illegal TypeQL semantics)

Transaction-level errors will trigger an error popup notification.

Both types of errors can be viewed and copied to the clipboard by visiting the History pane on the Query page.

Version Compatibility

If you’re using TypeDB 3.0 or 3.1, you can still access the (unmaintained) legacy TypeDB Studio application in Cloudsmith.

Support for the legacy application was dropped in TypeDB 3.2; we encourage users to upgrade to TypeDB 3.2 to access the new TypeDB Studio.