Tutorial - Create a Local DB

A local DB helps when you need to put a massive document in “cache” giving much faster access to data. You can have a more detailed explanation here Local DB.

As per the sources or the objects, you have the be in the right namespace. Once in it, on the Local DB page by clicking on the button in the side-menu

Once on it, create your Local DB by clicking on the Create button.


A modal will appear


Fill in the information (Alpha only, information cannot be edited after creation)

  • Name
  • Description

When ready, click on Create

You’ll be redirected to the Local DB you just created.


At the very top, you’ll find

  • Name of the Local DB
  • Schema which is the current page
  • Populators in which you’ll find all populators linked to this Local DB, or even start creating a populator (which will be linked automatically to the same Local DB)
  • Settings where you can Delete the Local DB

You’ll also notice that you can set a Primary Key and add Columns.

The Primary Key is optional. It is the unique identifier for each row of data in your table. Ex: If you have

  • Unique ID: 1
  • Name: Paul
  • Last Name: Harvey

The Primary key will be the “Unique ID” since each individual dataset has a value unique to it. (1 is Paul, but 2 is someone else).

For the Local DB to work, you’ll have to name your columns appropriately. Make sure that you write the name of the columns according to the dataset that it represents.

After clicking on the add button, a modal will appear.


Fill in the needed information :

  • Name of the column
  • Type of the column (Int, varchar, boolean or float)
  • The type should match as closely as possible to the type in the source. ex: if the age column only contains integer values, the type of the column you create should be INT
  • Size (in bits)
  • You can even input a Default value if empty

When created, it will be added under the Columns section


You can add as many columns as you need. Once done, we can pass on to the next step: Populator !