Skip to main content

How to Connect to the Reporting Database

Azumuta Support

Beta. The reporting database is currently in beta; the details on this page may still change.

What You'll Need

After enabling the reporting database, Azumuta provides the following connection details:

  • Host — the address of your reporting database.
  • Port — the port to connect on.
  • Database name — the database to connect to.
  • Username and password — read-only credentials for your workspace.
  • Schema name — the area inside the database that holds your workspace's data. It looks like company_<your-workspace-id>.

Treat these credentials like a password. Anyone with them can read your reporting data. Share them only with the people who need them, and store them in a secrets manager rather than in shared documents or source code.

Secure Connections (SSL) Are Required

The reporting database only accepts encrypted connections. When you connect, make sure SSL/TLS is enabled. In most tools this means setting the SSL mode to require (or enabling an "Use SSL" checkbox).

Connect With a SQL Client

You can use any PostgreSQL-compatible client, such as psql, DBeaver, TablePlus, or pgAdmin. A connection string looks like this:

postgresql://<username>:<password>@<host>:<port>/<database>?sslmode=require

After connecting, point your session at your workspace's schema so you can refer to tables by their short names:

set search_path to "company_<your-workspace-id>";

To confirm everything works, list the available tables:

select table_name
from information_schema.tables
where table_schema = 'company_<your-workspace-id>'
order by table_name;

Connect With a BI Tool

Tools like Power BI, Tableau, Metabase, Looker, and Grafana all support PostgreSQL. In general:

  1. Add a new data source and choose the PostgreSQL connector.
  2. Enter the host, port, database name, username, and password from Azumuta.
  3. Enable SSL (set SSL mode to require).
  4. When asked for a schema, select your workspace schema (company_<your-workspace-id>).

Once connected, your tables appear in the tool and you can start building dashboards. See Example Analytics Queries for ideas to get started.

A Note on Performance

The reporting database is a copy, so heavy queries won't slow down your live Azumuta workspace. Even so, it's good practice to filter and aggregate in SQL rather than pulling entire tables into your BI tool.