Skip to main content

# kater admin connection objects

Lists the tables in a connection's warehouse, with each table's type and number of columns.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

Use it to find the schemas and tables to add with `kater admin connection update`. It reads the databases that the connection selects, or the one that `--database` names. With `--all`, it lists every database that the connection's role can read, or the schemas of one, as the Schemas step of New connection does.

## Examples

```bash
# List the tables in each database that the connection selects
kater admin connection objects --connection snowflake_prod_connection
# List the tables in one schema
kater admin connection objects --connection snowflake_prod_connection --database DEMO_DB --schema ANALYTICS_AD_REPORTING
# List every database that the role can read
kater admin connection objects --connection snowflake_prod_connection --all
# List the schemas of one database, with their table and column counts
kater admin connection objects --connection snowflake_prod_connection --all --database DEMO_DB
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--connection <name>` | Required. The connection whose warehouse to read, such as `snowflake_prod_connection`. |
| `--database <database>` | Lists only this database, such as `DEMO_DB`. It can be a database that the connection does not select yet. |
| `--schema <schema>` | Lists only this schema, by its name alone, such as `ANALYTICS_AD_REPORTING`. Not with `--all`. |
| `--all` | Lists every database that the role can read, or with `--database`, each of its schemas with its table and column counts. Only through Kater's API, so not with `--kater-root` or `--scope`. |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## Before it reads

It checks that the credential on Kater's server matches `connection.yaml`. When it does not, the command stops before it reads the warehouse. For a Snowflake connection, it needs the `connections:query` permission. With `--all`, it needs the `settings:manage` permission instead.

## See also

- [`kater admin connection`](https://kater.ai/docs/cli-reference/admin/connection/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Options
Before it reads
See also

Kater CLI Share and administer admin connection

kater admin connection objects

Lists the tables in a connection's warehouse, with each table's type and number of columns.

Use it to find the schemas and tables to add with kater admin connection update. It reads the databases that the connection selects, or the one that --database names. With --all, it lists every database that the connection’s role can read, or the schemas of one, as the Schemas step of New connection does.

Examples

# List the tables in each database that the connection selects
kater admin connection objects --connection snowflake_prod_connection
# List the tables in one schema
kater admin connection objects --connection snowflake_prod_connection --database DEMO_DB --schema ANALYTICS_AD_REPORTING
# List every database that the role can read
kater admin connection objects --connection snowflake_prod_connection --all
# List the schemas of one database, with their table and column counts
kater admin connection objects --connection snowflake_prod_connection --all --database DEMO_DB

Options

Option	Description
`--connection <name>`	Required. The connection whose warehouse to read, such as `snowflake_prod_connection`.
`--database <database>`	Lists only this database, such as `DEMO_DB`. It can be a database that the connection does not select yet.
`--schema <schema>`	Lists only this schema, by its name alone, such as `ANALYTICS_AD_REPORTING`. Not with `--all`.
`--all`	Lists every database that the role can read, or with `--database`, each of its schemas with its table and column counts. Only through Kater’s API, so not with `--kater-root` or `--scope`.

It also takes the global options --json, --kater-root, --scope and --help.

Before it reads

It checks that the credential on Kater’s server matches connection.yaml. When it does not, the command stops before it reads the warehouse. For a Snowflake connection, it needs the connections:query permission. With --all, it needs the settings:manage permission instead.

See also