Skip to main content

# kater execution stop

Stops runs, compiles, Sandbox samples or join checks that are in progress.

{/* 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. */}

Name one kind, or one request id, or give neither to stop them all. `--scope` stops only the work on one workspace or folder.

## Examples

```bash
# Stop every run, compile, Sandbox sample and join check in progress
kater execution stop
# Stop only the runs
kater execution stop run
# Stop one, by the request id that kater execution list gives
kater execution stop --request-id 0f3c9a6e2b8d4f17a5c1e9b04d72a6c3
# Stop the work on the ad_reporting workspace
kater execution stop --scope connections/snowflake_prod_connection/workspaces/ad_reporting
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<operation>` | Optional. The kind of work to stop: `run` for runs of saved queries and charts, such as `kater run`, and `compile` for compiles. `sample` stops a Sandbox statement that `kater show` runs, and `check` a join check from `kater model check-join`. Leave it out to stop every kind. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-id <id>` | Stops only the work with this request id, from `kater execution list`. |

</div>

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

## What it gives

`status` is `stopping`, with the work it asked to stop under `executions`. It is `no_match` when nothing in progress matched.

## See also

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

On this page

Examples
Arguments
Options
What it gives
See also

Kater CLI Run Kater's services execution

kater execution stop

Stops runs, compiles, Sandbox samples or join checks that are in progress.

Name one kind, or one request id, or give neither to stop them all. --scope stops only the work on one workspace or folder.

Examples

# Stop every run, compile, Sandbox sample and join check in progress
kater execution stop
# Stop only the runs
kater execution stop run
# Stop one, by the request id that kater execution list gives
kater execution stop --request-id 0f3c9a6e2b8d4f17a5c1e9b04d72a6c3
# Stop the work on the ad_reporting workspace
kater execution stop --scope connections/snowflake_prod_connection/workspaces/ad_reporting

Arguments

Argument	Description
`<operation>`	Optional. The kind of work to stop: `run` for runs of saved queries and charts, such as `kater run`, and `compile` for compiles. `sample` stops a Sandbox statement that `kater show` runs, and `check` a join check from `kater model check-join`. Leave it out to stop every kind.

Options

Option	Description
`--request-id <id>`	Stops only the work with this request id, from `kater execution list`.

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

What it gives

status is stopping, with the work it asked to stop under executions. It is no_match when nothing in progress matched.

See also