Chapter Zero: Setup

Run TypeDB, connect TypeDB Studio, and create an empty database

Run TypeDB

Already have a running TypeDB server? Skip to Create a database.

Create a free cluster

  1. Create a TypeDB Cloud account. Your first cluster is free.

  2. On the dashboard, click Deploy a cluster.

  3. Configure your cluster, then click Deploy. Your cluster will be created in a few seconds.

Alternatively, you can run TypeDB Community Edition in your own environment. If you would like to do this, visit the Install CE page.

Connect TypeDB Studio

TypeDB Studio is a browser-based interface for TypeDB. We’ll use it to run the queries in this course, and to view the schema as it grows.

  • Cloud

  • Enterprise

  • Community Edition

  1. In the TypeDB Cloud website, navigate to your cluster and click Connect. Then, click Connect with TypeDB Studio. This will launch TypeDB Studio.

  2. Fill in your password and hit Connect. Your password can be found in your downloaded credentials file (if you have one).

  1. Launch TypeDB Studio (https://studio.typedb.com, or the desktop app)

  2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000.

  3. Enter your username and password.

  4. Click Connect.

  1. Launch TypeDB Studio (https://studio.typedb.com, or the desktop app)

  2. Enter the address of the HTTP endpoint of your cluster. By default, this is at port 8000 and for local instances you can use http://localhost:8000.

  3. Enter your username and password - defaults are admin and password.

  4. Click Connect.

Create a database

  1. In the top bar, open the database selector, which shows 'No database selected'.

  2. Select '+ New Database'.

  3. Name it palm_oil and leave the sample dataset field blank.

The course assumes this database starts empty.

Run a query

Open the Query page, and check that the transaction mode toggle in its toolbar is set to auto. In auto mode, Studio detects whether a query changes the schema, writes data or only reads, opens the matching transaction, and commits it if the query succeeds. Paste each query from the course into the editor and run it.

The Schema page draws the current schema as a graph. Open it after each chapter to compare it with the ER diagrams in the course.