kater admin connection test

Signed in to Kater, it tests the sign-in that Kater stores, as Test connection on the connection’s page does, and Kater keeps the test as the connection’s last test. Run it after you change a connection’s settings or its sign-in.

Examples

# Check that Kater can reach the Snowflake warehouse
kater admin connection test snowflake_prod_connection

Arguments

Options

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

What it reports

Each stage of a Snowflake test prints a line as it passes: find the account, sign in, use the warehouse and read the role. Then a sentence gives the account, the role and the warehouse of the session. A test that fails stops at its stage, says why, and exits with 2.

With --json, it prints the answer:

• ok is true. A test that fails prints an error instead.
• session gives what the warehouse said of the session, such as Snowflake’s account, warehouse, role and version.
• elapsed_ms says how long the test took, in milliseconds.
• warning is there when the stored sign-in has a different account, warehouse or role from connection.yaml. The connection’s page shows this as Sign-in does not match. Run kater admin connection sign-in to store a sign-in that agrees.

A connection with no stored sign-in stops before the test. Run kater admin connection sign-in to add one. The test needs the settings:manage permission.

In a shell with no Kater API, the command stops. Run kater login. Your computer never holds a warehouse credential, so it cannot test a connection on its own.

See also

• kater admin connection
• All commands