TypeDB Studio

Select TypeDB edition below, and follow the instructions:

TypeDB Studio remembers the server addresses and usernames you have previously used and offers them as suggestions the next time you connect.

Saved connections are stored locally in your browser or desktop app. See Data storage for details.

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, optionally with sample data preloaded.

See Databases for the full set of database management features, and Sample datasets for more details about sample datasets.

The query tool supports multiple query tabs, so you can keep several queries open at once. Tabs can be renamed, pinned, duplicated, and closed (including close others / close to the right). Open query tabs are remembered between sessions.

In addition to writing and running queries, the query tool gives you access to a schema pane, an inline history pane, transaction controls, result export, and the ability to save queries for later reuse.

You can write TypeQL queries in the Query pane.

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

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

Results are printed to the Results pane.

The Results pane offers four different views of results - you can choose between Log, Table, Graph 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.

Graph (network) output is appropriate for visualising and understanding the connections in your dataset.

Raw output allows you to see the raw HTTP response from TypeDB and is useful for debugging.

Query results can be exported directly from the Results pane:

Raw output can likewise be copied or downloaded as JSON.

The Schema pane lists your schema objects and their capabilities - e.g. owned attributes and played roles.

It acts as a reference panel indicating what you can query.

You can configure its view mode (flat or hierarchical) by clicking the options button in its top bar. Flat layout is typically better for simple schemas, while the hierarchical view is better for more complex schemas with subtyping.

The options pane also allows you to filter what capabilities are displayed. For example, you can set it to only display owned attributes, or to only display roleplayers of relations.

You can also view the full schema text from this pane.

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

This inline pane mirrors the dedicated Query history tool.

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.

In manual mode, you also choose the transaction type (read, write, or schema) before opening a transaction. Transaction options, such as the transaction timeout, can be adjusted from the same control.

The transaction inspector shows the details of the currently open (or most recently closed) transaction, including its status, type (read, write, or schema), and the times it was opened and closed, along with low-level metadata such as the transaction ID and timeout. When a transaction is open, you can close it directly from the inspector.

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.

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.

Agent mode is powered by OpenAI. Because using it shares your database schema and chat messages with OpenAI, AI features are off by default and require explicit, one-time opt-in the first time you use them. You can withdraw consent at any time, and optionally delete your local chat history when doing so.

Once you’re in the data explorer, start exploring by selecting any type from the schema. This will bring up a table of instances of that type, as well as:

Selecting any instance from this table will take you to Instance Details.

Instance tables support standard table functionality (filtering, sorting, pagination, column picker …​) Filtering, sorting and pagination are all handled server-side using TypeQL queries.

Instance details show the same info as tables in much more detail. In particular, roleplayers, attribute owners and linked relations include their attributes so that data is clearly labelled.

You can jump to connected instances using the "Explore" buttons on instance details, allowing you to traverse your dataset. Explorations leave behind a breadcrumb that indicates the exploration chain you’ve taken to get to a specific instance. Thus, breadcrumbs form a chain of connected concepts.

Data Explorer tabs support standard tab functionality (close, close others, close all, pin …​) and are restored (but perform fresh queries) when you reopen TypeDB Studio.

In manual transaction mode the user can work with a fixed snapshot of their data for stable exploration.

Click a node to inspect its attributes and connections in the side panel. Using the right-click context menu or the side panel’s "Explore" controls, you can load additional relations and attributes for an instance - or for every instance of a type - on demand, without re-running a query. The explorer works in both auto and manual transaction modes.

The side panel offers extensive styling controls:

The side panel can be docked to the right or bottom of the view.

Provide a database name (letters, digits, hyphens, and underscores only). Studio checks that the name is not already in use. You can optionally choose a sample dataset to load into the new database on creation.

Switch between databases using the database dropdown. You can also refresh the database list and create new databases from here.

Deleting a database is irreversible and permanently removes all of its data. To prevent accidents, you must type the database name to confirm deletion.

To create a new user, click the "Create user" button in the User Manager.

To change a user’s password, click the "Change password" button in the row corresponding to that user.

To delete a user, click the "Delete user" button in the row corresponding to that user.