TypeDB Studio
Setting up
To start querying, first complete the following steps:
-
Select a project directory to use as a workspace.
-
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 Open Project Directory button in the top toolbar.
Connect to TypeDB
Select TypeDB edition below, and follow the instructions:
-
Cloud
-
Enterprise
-
Community Edition
-
In the TypeDB Cloud website, navigate to your cluster and click Connect. Then, click TypeDB Studio.
-
The Connect to your cluster dialog will display the connection URI for your cluster, with a placeholder:
<db_password>
. -
In TypeDB Studio, click Connect to TypeDB in the top right corner.
-
Select
TypeDB Cloud
. Copy in the Connection URI, and replace<db_password>
with your actual password. Consider saving this connection URI in a secure location. . -
Select
TypeDB Cloud
. -
Click Manage Cloud Addresses button.
-
Add address and port for at least one server from your TypeDB Cloud deployment, then close the Address Management window.
-
Fill in the
Username
andPassword
fields with valid user credentials. -
Turn on the
Enable TLS
option and leave theCA Certificate
field empty. For self-hosted deployments, encryption parameters may vary. -
Click
Connect
.
-
Click Connect to TypeDB on the right side of the top toolbar.
-
Switch the
Server
field drop-down toTypeDB Cloud
. -
Click Manage Cloud Addresses button.
-
Add address and port for at least one server from your TypeDB Cloud deployment, then close the Address Management window.
-
Fill in the
Username
andPassword
fields with valid user credentials. -
Turn on the
Enable TLS
option and leave theCA Certificate
field empty. For self-hosted deployments, encryption parameters may vary. -
Click
Connect
.
-
Click Connect to TypeDB on the right side of the top toolbar.
-
Make sure the
TypeDB Core
option is selected in theServer
field. -
Enter the address and port of the server to connect to (e.g.
localhost:1729
). -
Fill in the
Username
andPassword
fields with valid user credentials. -
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. 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
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.
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.0+ |
3.0.0+ |
2.x and 3.x versions are not compatible. |