Two modes of access
CauseFlow Relay (recommended)
The Relay is a lightweight Docker agent you deploy inside your own private network. It is the recommended approach for PostgreSQL and MongoDB databases that are not publicly reachable. Why use Relay:- Your database never needs to be exposed to the internet
- No inbound firewall rules required — the Relay opens a single outbound WebSocket connection
- PII is masked inside your network before results are returned to CauseFlow
- A policy engine controls exactly which tables and operations are permitted
AWS API (for AWS-managed databases)
For DynamoDB and other AWS-managed databases, CauseFlow uses STS AssumeRole to access data through the AWS API. This requires:- An IAM role in your AWS account with read-only permissions on the target databases
- A trust policy allowing CauseFlow’s AWS account to assume the role
- The role ARN configured in Dashboard > Settings > AWS Integration
DB Analyst agent activation
The DB Analyst agent is automatically activated when:- A CauseFlow Relay connection is detected, or
- AWS database access is configured in your tenant settings
Read-only enforcement
CauseFlow enforces read-only access at multiple layers:| Layer | Enforcement |
|---|---|
| PostgreSQL via Relay | SET TRANSACTION READ ONLY on every connection |
| MongoDB via Relay | Only find and aggregation operations permitted; write operations blocked by the Relay policy engine |
| DynamoDB via AWS API | IAM role restricted to dynamodb:GetItem, dynamodb:Query, dynamodb:Scan |
Getting started
Deploy CauseFlow Relay
Set up the privacy-preserving Relay for PostgreSQL and MongoDB in your private network.
Relay architecture
Understand how the Relay communicates with CauseFlow and handles PII masking.