Skip to content

vaticle/typedb-studio

Repository files navigation

TypeDB Studio

Factory GitHub release Discord Discussion Forum Stack Overflow Stack Overflow

Introducing TypeDB Studio

TypeDB Studio is an Integrated Development Environment (IDE) that facilitates the development process for TypeDB databases. It provides a consistent experience across different operating systems, including macOS, Linux, and Windows. With TypeDB Studio, developers can efficiently manage databases, execute queries, and explore query results, all within a unified environment.

Manage Database Schemas

Features

GUI for data modeling

On top of the ability to model your data with TypeQL, TypeDB Studio includes a type browser and a type editor with a graphical user interface, making it convenient to edit, visualize, and maintain data models. The user-friendly interface simplifies the process of creating, extending, exploring, and managing schemas, enabling developers to easily define the structure and relationships of their data.

Type editor

Data and schema visualization

One of the key features of TypeDB Studio is its interactive visualizer, which allows developers to visualize query results and explore inferred data. The visualizer presents data in a hypergraph format, making it easy to navigate and visualize TypeDB responses.

Response Visualisation

Fully-fledged IDE for developing with TypeDB

TypeDB Studio covers all steps of the development process with TypeDB:

  • Graphical user interface for connecting to TypeDB without the use of command line tools, libraries, or Driver API.
  • Database manager to create and delete databases.
  • Type browser for exploring type hierarchy of a database's schema.
  • Type editor for adjusting existing types in a database.
  • Project file management to store your favorite queries.
  • Convenient multi-tab query editor with TypeQL syntax highlighting, auto-saving, query execution, response output, and pop-up notifications for warnings and error messages that may occur during runtime/query execution.
  • Graph visualization engine for visualizing query results using user-modifiable, force-directed graph drawings.
  • Local syntax validation before sending instructions and queries to the server.
  • Automatic transaction management with full GUI control, including read/write transactions, schema/data sessions, as well as transaction control (commit/rollback/close) and transaction options.
  • Rule-based inference enabled with a click of a button (infer).
  • Explanations visualization displays the deductive reasoning behind inferred data for root cause analysis.

Download TypeDB Studio

You can download TypeDB Studio from the GitHub Releases page. For more information on how to install and run TypeDB Studio, see the Installation guide.

Compile 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 "Download TypeDB Studio" section above.

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

  2. You can build TypeDB with either one of the following commands, depending on the targeted architecture and operating system:

    $ bazel run //:studio-bin-mac-arm64
    $ bazel run //:studio-bin-mac-x86_64
    $ bazel run //:studio-bin-windows-x86_64
    $ bazel run //:studio-bin-linux-arm64
    $ bazel run //:studio-bin-linux-x86_64

    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-x86_64.jar or similar directory, with respect to the chosen OS and architecture.

Useful links

If you want to begin your journey with TypeDB, you can explore the following resources:

Contributions

TypeDB Studio has been built using various open-source frameworks, technologies and communities throughout its evolution. Today TypeDB Studio is built using Kotlin, Compose Multiplatform, and Bazel.

Thank you!

Licensing

This software is developed by Vaticle. It's released under the Mozilla Public License 2.0 (MPL 2.0). For license information, please see LICENSE.

Copyright (C) 2023 Vaticle.