connections

Manage data warehouse connections (BigQuery, Snowflake, Redshift, PostgreSQL, Databricks, …).

carto connections list

List all connections.

carto connections list

carto connections get <connection-id>

Get details for a specific connection.

carto connections get conn_xyz789

carto connections create <json-body>

Create a new connection. The body's shape depends on the provider.

carto connections create '{
  "name": "my-snowflake",
  "type": "snowflake",
  "parameters": {
    "account": "myaccount",
    "warehouse": "compute_wh"
  }
}'

carto connections update <connection-id> <json-body>

Update a connection.

carto connections update conn_xyz789 '{ "parameters": { "warehouse": "new_wh" } }'

carto connections delete <connection-id>

Delete a connection.

carto connections delete conn_xyz789

carto connections browse <name> [path]

Browse the resource tree exposed by a connection (databases, schemas, tables, tilesets). Useful for picking source paths when authoring maps or workflows without leaving the terminal.

# Top-level tree for a connection
carto connections browse carto_dw

# Drill into a specific subtree
carto connections browse carto_dw "carto-demo-data"

Options:

Option	Description
--depth <n>	Max tree depth to expand (default: server default).
--max-items <n>	Max total items to return (default: server default of 30).
--max-children <n>	Max children per node (default: server default).

carto connections describe <name> <table-path>

Get the schema and details for a single table on a connection (column names, types, partitioning, row count when available).

carto connections describe carto_dw "carto-demo-data.demo_tables.nyc_collisions"

carto connections search <name> <query>

Free-text search across the tables and views reachable through a connection.

carto connections search my-conn "customers"
carto connections search my-conn "orders" --scope "mydb.public" --type table

Options:

Option	Description
--type <kind>	Filter by resource type: table or view.
--limit <n>	Max results, 1–100 (default: 20).
--scope <fqn>	Narrow the search to a subtree (e.g. "mydb.public").