Build the schema

Before you can load data into ThoughtSpot, you must build a database schema to receive it.

You can build a schema by writing a SQL script that creates the objects in your schema. ThoughtSpot provides the ThoughtSpot SQL Command Line (TQL) for creating, viewing, and managing a schema using SQL. Your script can use any statements that are supported in ThoughtSpot SQL Command Line (TQL). The TQL syntax is similar to the SQL used in other relational databases, but with some important differences.

You can use DDL (data definition language) to create the schema into which you can load the data. We recommend placing all your DDL statements into a single script for creating the schema.

Upload the script through the browser

You can upload your SQL script directly through the browser in the ThoughtSpot application. You can edit the script or add to it right within the browser, too. The steps to build a schema through the browser are:

Use TQL on the SQL command line

You can choose to run your SQL script within the Linux shell instead. You can run TQL in interactive command line mode, or you can write a script and use TQL to run it. The SQL syntax in ThoughtSpot is called TQL for ThoughtSpot SQL. The ThoughtSpot SQL Command Line (TQL) runs in an interactive mode. To invoke TQL, log in to the Linux shell using SSH and type tql. At the prompt, type h or help to see a list of supported commands.

The steps to build a schema using TQL include:

  1. Connect to the database with the ThoughtSpot SQL Command Line (TQL).

  2. Write a SQL script to create the schema.

  3. Type your SQL commands on the command line, terminating each command with a semicolon (;).

    Commands can span multiple lines. ThoughtSpot supports a limited number of SQL commands, plus some custom SQL extensions. For example, you can specify the number of shards and the distribution key as part of the CREATE TABLE syntax. A full list of supported SQL in TQL is available in the TQL reference.

Where to go next

  • Connect with TQL and create a schema

    Having examined the structure of the data to be loaded and become familiar with the ThoughtSpot SQL Command Line (TQL), you are now ready to create the schema.

  • Write a SQL script to create the schema

    Using a SQL script to create your schema is a recommended best practice.

    This makes it easier to adjust the schema definitions and recreate the schema quickly, if needed.

  • Schema creation examples

    These examples demonstrate the steps involved in creating a schema using the ThoughtSpot SQL Command Line (TQL).

    After the schema is created, you can load data into it with ThoughtSpot Loader.

  • Upload and run a SQL script

    You can run a SQL script to create your database schema through the browser, without having to sign in to the shell on the ThoughtSpot instance.

    You can edit the script and run it directly in the browser to create the schema.

Was this page helpful?