Officially out now: The TypeDB 3.0 Roadmap >>

TypeDB Manual

Welcome to the TypeDB Manual. Here you’ll find practice oriented guides on TypeDB operations and configuration, as well as Studio and Console manuals.

You can run TypeDB database servers in the following environments:

TypeDB Cloud

The fully managed service for TypeDB deployments in the cloud.

TypeDB Community Edition

The self-hosted, open-source, free-to-use version of TypeDB.

TypeDB Enterprise

The subscription-based, self-hosted version of TypeDB, designed for enterprise usage.

Standalone clients

Standalone clients can be used to conveniently work and develop with TypeDB.

TypeDB Studio

An IDE that facilitates the development process for TypeDB databases.

TypeDB Console

A powerful CLI client for TypeDB.

Using TypeDB

Learn how to perform common tasks with TypeDB.

Connecting to TypeDB

Connect to a TypeDB server and create a new database.

Defining schemas

Set and modify the schema of a database with a TypeQL query or driver API call.

Writing data

Insert, delete, or update (replace) data in a TypeDB database with TypeQL queries.

Reading data

Retrieve data as JSONs or stateful objects with TypeQL queries.

Using drivers

TypeDB Drivers can be used to query TypeDB directly from within your application. For the TypeDB drivers documentation, see the Drivers category.

Programming objects

Use stateful objects to alter data and schema, as well as explain inferred data.

Bulk loading

Best practices for bulk-loading data, during prototyping or migrations.

Configuring TypeDB

Learn how to configure, migrate, and upgrade TypeDB.

Config file

TypeDB configuration via config file parameters.

CLI arguments

TypeDB configuration via CLI arguments.

Logs

Logs configuration and storage.

Export and Import

Exporting and importing databases in TypeDB.

Upgrades

Upgrading TypeDB version.

Users

User management operations.