Documentation Index
Fetch the complete documentation index at: https://docs.clarityq.ai/llms.txt
Use this file to discover all available pages before exploring further.
Setup
Step 1: Create a dedicated database user
Connect to your PostgreSQL database and create a service account for ClarityQ:Step 2: Configure schema and table permissions
Grant the necessary permissions for ClarityQ to discover schemas, query data, and perform analytics:Step 3: Configure network access
Ensure your PostgreSQL database allows connections from the following ClarityQ IP addresses:- 44.218.213.75
- 54.161.37.107
- 54.208.212.67
Step 5: Add connection in ClarityQ
In the ClarityQ interface, fill out the connection form with the following fields:- Connection Name: Choose a name for this connection (e.g., “Production PostgreSQL”)
- Host: Your PostgreSQL server hostname or IP address (e.g.,
db.example.com) - Port:
5432(default, pre-filled) - Database: Your database name (e.g.,
analytics_db) - User:
clarityq_user(the user you created in Step 1) - Password: The password you set for
clarityq_user
Connection parameters reference
Required parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
connection_name | string | Unique identifier for this connection | Production DB |
host | string | Database server hostname or IP address | db.example.com |
database | string | Target database name | analytics_db |
user | string | PostgreSQL username | clarityq_user |
password | string | User password | secure_password |
Optional parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
port | number | 5432 | PostgreSQL server port |
schema | string | public | Default schema |