Skip to content
  • Quick Start

Quick Start

A quick start to the RKGMS using the RAI Console.

This quick start guide describes how you can begin working with our Relational Knowledge Graph Management System (RKGMS) using the RelationalAI Console. The Console has everything you need to use the RKGMS.

Logging into the RAI Console

Before beginning this tutorial, the account manager needs to set up a user account for you. Once this is done, you need only access to your registered email account.

To access the Console:

  1. Go to and click Login.
  2. In the page that opens, enter your email address.
log into console
  1. Confirm your email credentials. This is normally just the password of your email account, but may vary depending on your organization.

    1. The first time you access the RAI Console, you will need to set up a two-step verification process and enter a code generated by your one-time password application (like Duo Mobile or Google Authenticator). On this first use, you will need to open the authentication application and point your phone’s camera at the QR code on the screen.

    2. Once you do so, your authentication application will give you a code that you must enter to finish the setup process for your two-step verification. This is separate from confirming your credentials on the RAI Console.

  2. Enter the one-time password code from your two-step verification application to complete the login process.

The first time you login, you will receive an email asking that you verify your RAI account.

  1. Open the email and click Verify Your Account

  2. Return to

After you have completed logging in, the RAI Console homepage opens:

console home page

The homepage lists any databases that have been previously created under this account. Note, multiple users can have access to the same account.

Choosing or Creating an Engine

The RKGMS separates data storage from computation to achieve unlimited scaling. In the RAI Console, data storage is represented by databases, and computation by engines. An engine is a virtual machine running in a cloud service provider, such as Microsoft Azure, which executes your database transactions. At the top of the Console, you can see your RAI account(s) along with all currently available engines.

All databases require an engine to run. To create or use a database, you must choose or create an engine.

To choose an engine, select it from the pull-down menu at the top of the RAI Console homepage. If no engine is available, you need to create one.

To add a new engine:

  1. Either:
    • Click Create Engine in the Engine pull-down menu in the upper-right corner of the Console.
    • Click the Engine icon on the left-hand side of the Console. A page opens listing any existing engines. Click Create on the right-hand side of the Console.
  2. On the page that opens, enter a name for the new engine, select XS for size, and click Create.
create engine on the console

An engine is ready to use once it is successfully provisioned. Note that engine provisioning might take several minutes.


Don’t forget to select the engine at the top of the RAI Console.

Creating a Database

Now that you have chosen or created an engine, you can open or create a database.

Databases are containers for both data and logic. Databases also contain notebooks, which can be used to write reactive Rel programs in a web browser, with no software required other than the browser itself.

To open an existing database, click its name on the homepage.

To create a new database:

  1. Click the Database icon on the left-hand side of the RAI Console homepage.
  2. On the page that opens, click Create.
  3. Enter a name for the new database.
  4. Select an engine from the Engine pull-down menu at the top right of the RAI Console homepage. If no engines are available, you need to create one following the steps above.
  5. Click Create.

Once the database is successfully created, it will be listed in the Database page with the status CREATED. Note that you also have the option to clone a database. A clone allows you to create a new database as a clone of an already-existing database. There’s no reason to do that now, as you are creating a new database from scratch. But you may find this functionality useful at a later stage in your development process.

creating a database on the console

If you click on the database without having an engine selected, you will be prompted to select one.

Creating a Notebook

Finally, you need to open or create a notebook.

To create a notebook:

  1. Click the Database icon on the left side of the RAI Console homepage.
  2. Select an engine from the Engine pull-down menu at the top right of the RAI Console homepage. If no engines are available, you need to create one following the steps above.
  3. In the page that opens, click the name of a database to open it. If no databases are listed, you need to create one following the steps above.
  4. Right-click on Notebooks at the bottom of the object tree on the left-hand side of the Console and choose Create.
create notebook
  1. In the window that opens, give the notebook a name and click Create.

The notebook opens and you can begin working in Rel.

Start Modeling in Rel

You can test the notebook by entering the following code in the first cell and clicking the Run button — the triangle at the right of the input pane — or pressing SHIFT + ENTER.

// query
def k = 1; 2; 3
def output = k

You should see the output below.


That should be all you need to get started with the RAI Console. Once you’re done working in the Console, you should delete any engines you created, following the steps here.

See Also

Now you know how to access the Console, create a database, and test out notebooks, you can follow the documentation Walkthrough, which shows you where to begin when working with the RKGMS using Rel.

Was this doc helpful?