Skip to main content
Version: v2.x

Get Started with Docker (Hasura & Citus - Hyperscale)



Step 1: Get the docker-compose file

Get the Hasura docker-compose file:

# in a new directory run
# or run
curl -o docker-compose.yaml

Step 2: Run Hasura GraphQL Engine

The following command will run Hasura along with a Postgres database required for its functioning.

$ docker compose up -d

Check if the containers are running:

$ docker ps

097f58433a2b hasura/graphql-engine ... 1m ago Up 1m 8080->8080/tcp ...
b0b1aac0508d postgres ... 1m ago Up 1m 5432/tcp ...

Please do note that you will see a Postgres database running, which is used by Hasura to store its configuration (Hasura Metadata).

Step 3: Open the Hasura Console

Head to http://localhost:8080/console to open the Hasura Console.

Step 4: Add your Citus database as a source to Hasura

In the Data > Data Manager > Connect Existing Database section on the Console, select Citus from the Data Source Driver dropdown and add the connection string directly or through an environment variable. As Citus speaks the same protocol as Postgres, the connection string will start with postgres://, i.e, there is no difference between Citus’s connection strings and Postgres’s connection strings.

Add source

If you're testing Hasura with Citus running locally, read this guide on Docker networking in case you're not sure how to make sure that your Citus database is reachable from the Hasura docker container on Linux, Mac or Windows.

Once you add the database, you'll see your database pop up on the sidebar.

Step 5: Track existing tables or create new tables

If you have existing tables, head to the database page by clicking on the database name on the sidebar. You should see a list of tables.

Track tables selectively or all of them so that Hasura can introspect the tables and create the corresponding GraphQL schema.

If you have foreign keys, you'll also see suggested relationships. Again, you can choose to track them selectively or all at once.

If you don't have existing tables, go ahead and add new tables and data and try out some queries, just like with a regular Postgres database.

Step 6: Try out a GraphQL query

Head to the API tab in the Console and try running a GraphQL query! Use the explorer sidebar on GraphQL to get help in creating a GraphQL query.

Make GraphQL query

Keep up to date

Hasura supports queries, subscriptions, relationships and permissions on Citus - Hyperscale.

Please watch this space to get the latest docs on how you can try these features out via the Console or by manipulating Metadata in JSON/YAML directly.

If you'd like to stay informed about the status of Citus support, subscribe to our newsletter and join our discord!