vaticle/typedb-studio

TypeDB Studio

TypeDB Studio is a fully-featured Integrated Development Environment (IDE) for TypeDB.

You can utilise Studio as you would TypeDB Console and the TypeDB Clients: to connect to your TypeDB instance and perform queries.

Studio is an IDE designed for the end-to-end development of TypeDB databases, database queries, and data exploration, via a clean and intuitive UI that gives you a top-down view of your entire database.

Usage

Connect to TypeDB

Upon launching Studio, you'll be asked for your TypeDB server details and to choose or create a database.

Manage TypeDB Projects

After connecting to TypeDB and selecting a database, Studio will prompt you to open (or create) a project directory. This is where Studio will load and save query files, but you can also freely edit text files in the project directory using Studio. The project browser maintains a live view of the directory contents on the filesystem.

Manage Database Schemas

The Type Browser provides a structured tree view of the connected database's type hierarchy. Double-clicking on any of the listed types will bring up a page that lists their properties in detail — supertype, roles played, attributes owned and more.

Run TypeQL Queries

Studio's text editor comes equipped with rich developer tooling, like syntax highlighting for TypeQL files (*.tql), with more advanced features currently under development. Studio's intuitive and self-explanatory interface enables a rapid, iterative workflow.

TypeDB Studio brings session and transaction configuration to the forefront, providing greater visibility to the user about the state of the system. Studio allows you to run any TypeQL query, pretty-printing results to the Log Output window which is easily searchable (and supports regex matching.)

Graph Visualisation

Reasoning about text outputs in TypeDB Console or through the various TypeDB Clients can be difficult to do for large datasets. Studio's advanced force-graph visualisation makes the underlying structure of data immediately apparent.

Reasoning and Explanations

Select infer and explain, then double-click highlighted inferred concepts to retrieve their explanations and visualise how the fact was inferred.

Download TypeDB Studio

You can download TypeDB Studio from the Download Centre or GitHub Releases.

Developer Resources

• Documentation: https://docs.vaticle.com
• Discussion Forum: https://forum.vaticle.com
• Discord Chat Server: https://vaticle.com/discord
• Community Projects: https://github.com/typedb-osi

Compiling and Running TypeDB Studio from Source

Note: You DO NOT NEED to compile TypeDB Studio "from source" if you just want to use TypeDB Studio. You can simply download TypeDB Studio following the section above.

1. Make sure you have the following dependencies installed on your machine:

   • Java JDK 11 or higher
   • Bazel 5 or higher. We use Bazelisk to manage multiple Bazel versions transparently. Bazelisk runs the appropriate Bazel version for any bazel command as specified in .bazelversion file. In order to install it, follow the platform-specific guide:
     • MacOS: brew install bazelbuild/tap/bazelisk
     Linux: wget https://github.com/bazelbuild/bazelisk/releases/download/v1.4.0/bazelisk-linux-amd64 -O /usr/local/bin/bazel

2. Depending on your Operating System, you can compile and run TypeDB Studio with either one of the following commands.

   $ bazel run //:studio-bin-mac

   $ bazel run //:studio-bin-windows

   $ bazel run //:studio-bin-linux

   You can also replace run with build in the command above, and Bazel will simply produce the JAR for TypeDB Studio under bazel-bin/studio-bin-<mac|windows|linux>.jar.

Contributions

TypeDB Studio has been built using various open-source frameworks throughout its evolution. Today TypeDB Studio is built using Kotlin, Compose Multiplatform, and Bazel. Thank you to the developers!

Licensing

This software is developed by Vaticle. It's released under the GNU Affero GENERAL PUBLIC LICENSE, Version 3, 19 November 2007. For license information, please see LICENSE. Vaticle also provides a commercial license for TypeDB Studio - get in touch with our team at [email protected].

Copyright (C) 2022 Vaticle