TypeDB Studio

TypeDB Studio stores queries you create as TypeQL files in a local project directory. To select a project directory, click either Open Project in the Project panel, or the Open Project Directory button in the top toolbar.

Select TypeDB edition below, and follow the instructions:

TypeDB can work with one database at a time. To select a database to work with, use the dropdown menu on the right from the database icon in the top toolbar.

If there are no databases yet, see how to create a new one.

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

TypeDB has a Text editor that can edit most text files and has a built-in syntax highlighting for TypeQL. It can also run TypeQL queries from .tql and .typeql files. Each file can have one or more queries.

To create a new file, open a new tab in the Text editor panel. The file will be created and saved with temporary name in a hidden folder ./typedb-studio inside the selected project directory. There is an autosave feature that persists all the changes made in a file to disk. It can be disabled in settings. By manually saving a temporary file you can rename and move it from the hidden folder.

Select a session type () and a transaction type () in the top Toolbar.

To run a query file, open it in a tab of the Text editor panel and click the Run Query button from the top Toolbar.

For a write transaction type wait for a query to complete its execution and select one of the transaction control actions: Commit, Close, etc.

If a write transaction committed successfully — a blue pop-up with confirmation is displayed. If any error occurs during a transaction, it is shown as a red pop-up.

For more information on different control elements for query execution, see the Transaction controls section below.

Under the Text editor panel there is the Results panel. The Results panel is collapsed by default if no query has been run yet.

This panel has two sets of tabs: Run and Output. Run tabs represent separate runs of a query file. You can pin a tab to preserve it. Otherwise, it will be rewritten with the next run.

Output tabs represent different output formats for the results: Log and Graph. Log tab contains textual output, similar to TypeDB Console, as well as input log, and error messages. Graph tab is available for Get queries only. It uses Studio’s Graph Visualizer to build a graphical representation of query results.

To control query execution, we have the top Toolbar elements located to the right from the database selection drop-down menu.

To run a query with explanation, turn the explain button on before executing a query. To be able to do that, the infer and snapshot buttons must be enabled.

If the explain button is inactive, double-check that Studio is connected to TypeDB, a database is selected with a drop-down list in the toolbar, and the infer and snapshot buttons are on.

To see an explanation, find an inferred result in Graph Visualizer (should be highlighted in green) on the Graph tab and double-click on the highlighted result. If there is an explanation for the inferred result, it spawns in visualization as new concepts. If there is no additional explanation available for the selected result, or all explanations have already been spawned, a pop-up notification appears.

You can export all type definitions of a schema by clicking the Export Schema Types button on the top of the Type Browser panel. Exporting rules is not supported by this button yet.

The button creates a new tab with inserted TypeQL Define query that creates the schema of the database.

To rename a type:

You can also do the same by right-clicking on the type in the Type Browser panel and choosing the Rename Type option.

Renaming a type in any of these two ways updates the relevant type references in the schema and does not lead to loosing existing data. All existing instances of the type will be available under the new label.

To delete a type:

You can also do the same by right-clicking on the type in the Type browser panel and choosing the Delete option, then clicking the Confirm button.

In some cases, the Delete option and button can be unavailable. That means there are some conditions that prevent you from deleting this type. For example, we can’t delete a type that has a subtype.