Skip to main content

# kater explore use-case plan

Shows a question's saved plan, or plans the question from cards you select.

{/* 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 see which cards answer a question before you run them. Nothing runs on the warehouse, and nothing is saved.

## Examples

```bash
# Show the saved plan of the question that plan.json names
kater explore use-case plan --request-file plan.json
# List the questions, with the ids and the revision a request needs
kater explore use-case list --model semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling
```

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | Required. The question as JSON, from a file. `-` reads stdin. See [What the request holds](#what-the-request-holds). |

</div>

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

## What the request holds

- **`namespace` and `source`.** The shared model, as [The request file](https://kater.ai/docs/cli-reference/explore/#the-request-file) shows.
- **`id`.** The question's id, from `kater explore use-case list`.
- **`revision`.** The `revision` that the list gave. When the Explore file changed since, the plan is refused: list the questions again.
- **`selected_cards`.** Optional: up to 4 cards that answer the question, from the same model, with at most three different queries. Kater plans the question from them in place of its saved plan.
- **`parameters`.** Values for the plan's shared parameters, by their shared names.

## What it gives

The plan's cards and queries, each step with its SQL, and why a card does not plan. The plan is `ready_to_preview` when every card plans, and `partial` otherwise. Without `selected_cards`, a question with no saved plan is refused. Plan it with `kater explore definition generate` and `--question`, or send the cards that answer it as `selected_cards`.

## See also

- [`kater explore use-case`](https://kater.ai/docs/cli-reference/explore/use-case/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Options
What the request holds
What it gives
See also

Kater CLI Explore and try ideas explore use-case

kater explore use-case plan

Shows a question's saved plan, or plans the question from cards you select.

Use it to see which cards answer a question before you run them. Nothing runs on the warehouse, and nothing is saved.

Examples

# Show the saved plan of the question that plan.json names
kater explore use-case plan --request-file plan.json
# List the questions, with the ids and the revision a request needs
kater explore use-case list --model semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling

Options

Option	Description
`--request-file <file>`	Required. The question as JSON, from a file. `-` reads stdin. See What the request holds.

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

What the request holds

namespace and source. The shared model, as The request file shows.
id. The question’s id, from kater explore use-case list.
revision. The revision that the list gave. When the Explore file changed since, the plan is refused: list the questions again.
selected_cards. Optional: up to 4 cards that answer the question, from the same model, with at most three different queries. Kater plans the question from them in place of its saved plan.
parameters. Values for the plan’s shared parameters, by their shared names.

What it gives

The plan’s cards and queries, each step with its SQL, and why a card does not plan. The plan is ready_to_preview when every card plans, and partial otherwise. Without selected_cards, a question with no saved plan is refused. Plan it with kater explore definition generate and --question, or send the cards that answer it as selected_cards.

See also