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.
Commands
Section titled “Commands”akili connection create
Section titled “akili connection create”Create a new connection.
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--name | Connection name (required) | ||
--connector-type | Connector type, e.g., postgres, mysql, s3 (required) | ||
--config | Connection configuration as a JSON string (required) |
Examples:
# Create a PostgreSQL connectionakili connection create \ --name warehouse-pg \ --connector-type postgres \ --config '{"host":"db.example.com","port":5432,"database":"warehouse","user":"reader"}'
# Create an S3 connectionakili connection create \ --name data-lake \ --connector-type s3 \ --config '{"bucket":"my-data-lake","region":"eu-central-1","prefix":"raw/"}'akili connection list
Section titled “akili connection list”List all connections for the current tenant.
Examples:
# List all connectionsakili connection list
# As JSONakili connection list --jsonakili connection get <id>
Section titled “akili connection get <id>”Show detailed information about a specific connection.
Arguments:
| Argument | Type | Required | Description |
|---|---|---|---|
id | string | yes | Connection ID |
Examples:
# Get connection detailsakili connection get conn-abc-123
# As JSONakili connection get conn-abc-123 --jsonakili connection update <id>
Section titled “akili connection update <id>”Update an existing connection. Only provided fields are updated.
Arguments:
| Argument | Type | Required | Description |
|---|---|---|---|
id | string | yes | Connection ID |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--name | New connection name | ||
--config | New configuration as a JSON string |
Examples:
# Update connection nameakili connection update conn-abc-123 --name production-pg
# Update connection configakili connection update conn-abc-123 \ --config '{"host":"new-db.example.com","port":5432,"database":"warehouse","user":"reader"}'akili connection delete <id>
Section titled “akili connection delete <id>”Delete a connection. Requires the --confirm flag.
Arguments:
| Argument | Type | Required | Description |
|---|---|---|---|
id | string | yes | Connection ID |
Flags:
| Flag | Short | Default | Description |
|---|---|---|---|
--confirm | false | Confirm the deletion (required) |
Examples:
# Delete a connectionakili connection delete conn-abc-123 --confirmakili connection test <id>
Section titled “akili connection test <id>”Test a connection by attempting to connect to the external system. Reports success/failure and latency.
Arguments:
| Argument | Type | Required | Description |
|---|---|---|---|
id | string | yes | Connection ID |
Examples:
# Test a connectionakili connection test conn-abc-123# Connection test passed: Connected successfully# Latency: 45msakili connection discover <name>
Section titled “akili connection discover <name>”Discover available resources (tables, schemas, buckets, etc.) in a connection.
Arguments:
| Argument | Type | Required | Description |
|---|---|---|---|
name | string | yes | Connection name |
Examples:
# Discover resourcesakili connection discover warehouse-pg
# As JSONakili connection discover warehouse-pg --jsonakili connection schema <name> <resource>
Section titled “akili connection schema <name> <resource>”Get the schema (columns, types, nullability) for a specific discovered resource.
Arguments:
| Argument | Type | Required | Description |
|---|---|---|---|
name | string | yes | Connection name |
resource | string | yes | Resource name (e.g., public.orders) |
Examples:
# Get schema for a tableakili connection schema warehouse-pg public.orders
# As JSONakili connection schema warehouse-pg public.orders --json