Skip to content
GitLab

akili connection

Manage external data connections. Connections define how the platform connects to external data sources and sinks such as PostgreSQL, MySQL, S3, and other systems. Each connection stores the connector type and configuration needed to access the external system.

Create a new connection.

Flags:

FlagShortDefaultDescription
--nameConnection name (required)
--connector-typeConnector type, e.g., postgres, mysql, s3 (required)
--configConnection configuration as a JSON string (required)

Examples:

Terminal window
# Create a PostgreSQL connection
akili connection create \
--name warehouse-pg \
--connector-type postgres \
--config '{"host":"db.example.com","port":5432,"database":"warehouse","user":"reader"}'
# Create an S3 connection
akili connection create \
--name data-lake \
--connector-type s3 \
--config '{"bucket":"my-data-lake","region":"eu-central-1","prefix":"raw/"}'

List all connections for the current tenant.

Examples:

Terminal window
# List all connections
akili connection list
# As JSON
akili connection list --json

Show detailed information about a specific connection.

Arguments:

ArgumentTypeRequiredDescription
idstringyesConnection ID

Examples:

Terminal window
# Get connection details
akili connection get conn-abc-123
# As JSON
akili connection get conn-abc-123 --json

Update an existing connection. Only provided fields are updated.

Arguments:

ArgumentTypeRequiredDescription
idstringyesConnection ID

Flags:

FlagShortDefaultDescription
--nameNew connection name
--configNew configuration as a JSON string

Examples:

Terminal window
# Update connection name
akili connection update conn-abc-123 --name production-pg
# Update connection config
akili connection update conn-abc-123 \
--config '{"host":"new-db.example.com","port":5432,"database":"warehouse","user":"reader"}'

Delete a connection. Requires the --confirm flag.

Arguments:

ArgumentTypeRequiredDescription
idstringyesConnection ID

Flags:

FlagShortDefaultDescription
--confirmfalseConfirm the deletion (required)

Examples:

Terminal window
# Delete a connection
akili connection delete conn-abc-123 --confirm

Test a connection by attempting to connect to the external system. Reports success/failure and latency.

Arguments:

ArgumentTypeRequiredDescription
idstringyesConnection ID

Examples:

Terminal window
# Test a connection
akili connection test conn-abc-123
# Connection test passed: Connected successfully
# Latency: 45ms

Discover available resources (tables, schemas, buckets, etc.) in a connection.

Arguments:

ArgumentTypeRequiredDescription
namestringyesConnection name

Examples:

Terminal window
# Discover resources
akili connection discover warehouse-pg
# As JSON
akili connection discover warehouse-pg --json

Get the schema (columns, types, nullability) for a specific discovered resource.

Arguments:

ArgumentTypeRequiredDescription
namestringyesConnection name
resourcestringyesResource name (e.g., public.orders)

Examples:

Terminal window
# Get schema for a table
akili connection schema warehouse-pg public.orders
# As JSON
akili connection schema warehouse-pg public.orders --json