Skip to main content

# kater chart read

Shows one saved chart: its title, its spec, its SQL and its revision.

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

Read a chart before you change it, because each change needs its revision. It changes nothing.

## Examples

```bash
# Show the spend_mix chart
kater chart read --request-file spend_mix.json
# Keep the chart in a file, to make a change request from it with jq
kater chart read --request-file spend_mix.json --json > spend_mix_read.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 chart, as JSON, such as `spend_mix.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 |
| --- | --- |
| `chart` | The chart: its `name`, and the full `path` of its workspace under `namespace`. |

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

## What it shows

The answer holds the chart in `definition`:

| Field | What it holds |
| --- | --- |
| `title` | The title the chart shows: its label, or what it shows, such as "Clicks by Platform". |
| `path` | The chart's file, such as `connections/snowflake_prod_connection/workspaces/ad_reporting/charts/spend_mix.sql`. |
| `revision` | The chart's revision. A change request gives it as `expected_revision`. |
| `spec` | The chart: its name in `relation`, its query in `source`, its kind, its encodings and its presentation. |
| `sql` | The SQL that selects the query's columns for the chart. |
| `plan` | The same selection as `sql`, in parts: the columns, the conditions, the order and the limit. |
| `diagnostics` | The problems Kater found in the chart. |

## 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 read

Shows one saved chart: its title, its spec, its SQL and its revision.

Read a chart before you change it, because each change needs its revision. It changes nothing.

Examples

# Show the spend_mix chart
kater chart read --request-file spend_mix.json
# Keep the chart in a file, to make a change request from it with jq
kater chart read --request-file spend_mix.json --json > spend_mix_read.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 chart, as JSON, such as `spend_mix.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
`chart`	The chart: its `name`, and the full `path` of its workspace under `namespace`.

{"chart": {"name": "spend_mix", "namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}}}

What it shows

The answer holds the chart in definition:

Field	What it holds
`title`	The title the chart shows: its label, or what it shows, such as “Clicks by Platform”.
`path`	The chart’s file, such as `connections/snowflake_prod_connection/workspaces/ad_reporting/charts/spend_mix.sql`.
`revision`	The chart’s revision. A change request gives it as `expected_revision`.
`spec`	The chart: its name in `relation`, its query in `source`, its kind, its encodings and its presentation.
`sql`	The SQL that selects the query’s columns for the chart.
`plan`	The same selection as `sql`, in parts: the columns, the conditions, the order and the limit.
`diagnostics`	The problems Kater found in the chart.

See also