Querybook

Querybook supports querying and visualizing both internal data and external data in CelerData Cloud Serverless.

Prerequisites

Installation

Make sure that you have finished the following preparations:

  1. Clone and download the Querybook repository.

    git clone git@github.com:pinterest/querybook.git
    cd querybook
  2. Create a file named local.txt under the requirements folder in the project's root directory.

    touch requirements/local.txt
  3. Add the required packages.

    echo -e "starrocks\nmysqlclient" > requirements/local.txt 
  4. Start the container.

    make

Connectivity

Make sure that your CelerData cloud account's inbound rules allow query requests from your Querybook server.

Integration

Visit the following website in your browser and add a new query engine:

https://localhost:10001/admin/query_engine/

Querybook

Take note of the following points:

  • For Language, select Starrocks.

  • For Executor, select sqlalchemy.

  • For Connection_string, enter a URI in the StarRocks SQLAlchemy URI format as below:

    starrocks://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>

    The parameters in the URI are described as follows:

    • User: the username that is used to log in to your CelerData cloud account, for example, admin.
    • Password: the password that is used to log in to your CelerData cloud account.
    • Host: the account endpoint of your CelerData cloud account.
    • Port: the query port of your CelerData cloud account, for example, 9030.
    • Catalog: the target catalog in your CelerData cloud account. Both internal and external catalogs are supported.
    • Database: the target database in your CelerData cloud account. Both internal and external databases are supported.