Playground

This repository contains the example queries used across all our documentation and blogs, it also contains the script to set up the users.

Users can raise UI issues in this repository and suggest example queries.

What is the Playground?

The Playground powers the example you see when reading the ClickHouse documentation or blogs.

Each time you see in the blogs a widget showing a SQL query with the icon, you can click on it to open the Playground where you can run the query or build a simple visualization.

Contributing example queries

Fork this repository and raise a PR on the queries.json file. Once the PR is approved, this query will be deployed to the ClickHouse instance (currently manually).

Make sure to not modify the id of existing queries.

Reporting UI or Performance issues with Playground

Raise an issue in this repository using the relevant template.

Direct connections

Users can connect directly to the ClickHouse instance using the ClickHouse Client.

clickhouse client --host sql-clickhouse.clickhouse.com --secure --user demo --password ''

Load scripts [WIP]

This folder contains the scripts use to keep the data in the playground up to date. We rely on Google Cloud Run to execute the scripts.

Each folder contains a Dockerfile, a bash script to ingest the data and a cloudbuild.yaml that describe how to deploy to Cloud Run job. Each job relies on environment variables to run that are listed in the individual folder.

If you interested in reproducing in your own Cloud Run instance, you can use the following command to deploy a new version.

cd load_scripts/<dataset-name>
# Make sure you are logged in with gcloud and the env variable PROJECT_ID is set
gcloud builds submit --config cloudbuild.yaml .

This can also be used locally.