Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tryardent.com/llms.txt

Use this file to discover all available pages before exploring further.

A connector links Ardent to one of your Postgres databases. You need at least one before creating branches.

​
ardent connector create

Connect a Postgres database. Ardent replicates your data during initial setup. This may take a few minutes depending on data size. After setup, branches create in under 6 seconds regardless of data size. Shell quoting: Wrap the connection URL in single quotes. Otherwise the shell may treat characters in real strings (for example ?, &, #, !, $, parentheses, or spaces inside passwords) as globs, history expansion, or variable substitution, and the command can fail or connect to the wrong place. 
ardent connector create postgresql 'postgresql://user:password@host:5432/mydb'
Give it a name with -n: 
ardent connector create postgresql 'postgresql://user:password@host:5432/mydb' -n prod-db

✓ Connector created and ready
  ID: conn_abc123
  Ready to branch:
  ardent branch create <name>
Self-hosted / customer-cloud deployment: 
ardent connector create postgresql '<url>' \
  --deployment-model customer-cloud \
  --aws-role-arn <arn> \
  --aws-external-id <id> \
  --aws-region us-east-1 \
  --aws-cluster-name <cluster>

​
ardent connector list

List all connectors in the current project. In the terminal, the active connector is highlighted in green and prefixed with *; other rows use default/dim text. The expandable example uses green and dim styling the same way. ● means healthy, ○ means not healthy. The service type (for example postgresql) prints on the line below each name. Warnings appear in yellow with a count on the name line and full text indented below. 
ardent connector list
Connectors:
* ● prod-db
postgresql
○ staging-db
postgresql

​
ardent connector switch

Switch the active connector without changing projects. 
ardent connector switch staging-db

Switched from 'prod-db' to 'staging-db'

​
ardent connector delete

ardent connector delete staging-db

✓ Connector deleted