Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Delete and restore

kater retire

Retires a field or a model of the shared layer, in one change.

What reads it keeps working, and Kater hides it from new work: pickers, search, completions, the New dialogs and the MCP’s lists leave it out. It does not go to the Trash.

Examples

Terminal window
# Go to the snowflake_prod_connection connection
cd connections/snowflake_prod_connection
# Retire the sessions field of the MARKETING_SESSIONS model
kater retire modeling/kater_objects/semantic_models/marketing/MARKETING_SESSIONS.sql#sessions
# Use it again
kater retire modeling/kater_objects/semantic_models/marketing/MARKETING_SESSIONS.sql#sessions --use-again

Arguments

ArgumentDescription
<path>A model of the shared layer by its .sql file, or PATH#FIELD for one of its fields, by its path from the folder you are in, or from --kater-root.

Options

OptionDescription
--use-againTake Retired away, so Kater shows it in new work again.

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

What it answers

It gives what it retired, and the kater undo command that takes the change back.

See also