Skip to main content

# kater chart snapshot

Gets the rows that the last run of a query kept, for the same inputs, to draw charts from.

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

It does not run the query, so run it first with [`kater run`](https://kater.ai/docs/cli-reference/run/). When no rows are kept, Kater refuses with `snapshot_unavailable`.

## Examples

```bash
# Run the spend_by_platform query on the warehouse
kater run --select connections/snowflake_prod_connection/workspaces/ad_reporting/query_contracts/spend_by_platform.sql
# Get the rows that the run kept
kater chart snapshot --request-file spend_by_platform.json
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<path>` | Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | The query, as JSON, such as `spend_by_platform.json`. Give `-` to read it from standard input. See [The request](#the-request). |

</div>

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

## The request

| Field | What it holds |
| --- | --- |
| `source` | The query: its `name`, and the full `path` of its workspace under `namespace`. |
| `inputs` | Optional. The parameter values and the filters of the run to read. They must be the same as the run's. |
| `own_filters` | Optional. True reads the run that had the query's own optional filters on, as `kater chart execute` with `own_filters` and a dashboard tile run it. |

```json title="spend_by_platform.json"
{"source": {"name": "spend_by_platform", "namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}}
```

## What it shows

The answer's `snapshot` holds the rows, with an `id`. [`kater chart preview`](https://kater.ai/docs/cli-reference/chart/preview/) takes that id as `snapshot_id`, to draw a chart from these rows. You need permission to run the query.

## See also

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

On this page

Examples
Arguments
Options
The request
What it shows
See also

Kater CLI Present and share chart

kater chart snapshot

Gets the rows that the last run of a query kept, for the same inputs, to draw charts from.

It does not run the query, so run it first with kater run. When no rows are kept, Kater refuses with snapshot_unavailable.

Examples

# Run the spend_by_platform query on the warehouse
kater run --select connections/snowflake_prod_connection/workspaces/ad_reporting/query_contracts/spend_by_platform.sql
# Get the rows that the run kept
kater chart snapshot --request-file spend_by_platform.json

Arguments

Argument	Description
`<path>`	Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names.

Options

Option	Description
`--request-file <file>`	The query, as JSON, such as `spend_by_platform.json`. Give `-` to read it from standard input. See The request.

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

The request

Field	What it holds
`source`	The query: its `name`, and the full `path` of its workspace under `namespace`.
`inputs`	Optional. The parameter values and the filters of the run to read. They must be the same as the run’s.
`own_filters`	Optional. True reads the run that had the query’s own optional filters on, as `kater chart execute` with `own_filters` and a dashboard tile run it.

{"source": {"name": "spend_by_platform", "namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}}

What it shows

The answer’s snapshot holds the rows, with an id. kater chart preview takes that id as snapshot_id, to draw a chart from these rows. You need permission to run the query.

See also