Skip to main content

# kater chart destination

Describes one workspace as a place for a chart over a shared model.

{/* 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 says whether the workspace can take the chart, which dashboard place the tile gets, and which filters the chart follows there. It reads only declarations, and changes nothing.

## Examples

```bash
# Describe the ad_reporting workspace as a place for a chart over the Ad Reporting model
kater chart destination --request-file ad_reporting_destination.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 shared model and the workspace to describe, as 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_model` | The shared model that the chart reads, by its `model_type`, its `name` and its connection. |
| `path` | The workspace to describe, by its full path. |
| `workspace` | Optional. The workspace the chart is in, by its full `path`. When `path` names it, the answer is `here`, and Add to puts a tile of the chart on its dashboard. |

```json title="ad_reporting_destination.json"
{"source_model": {"model_type": "semantic", "name": "ad_reporting", "namespace": {"connection": "snowflake_prod_connection"}}, "path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}
```

## What it shows

- **`enabled`** says whether the workspace can take the chart, and **`reason`** says why not, such as a workspace over another model.
- **`dashboard`** is where a tile goes: the first tab, and the last section that holds tiles. It is there only when you can change the dashboard. Without it, an add saves only the query and the chart.
- **`filters`** are the workspace's optional filters. A chart moved there follows them, and leaves behind its own condition on the same field.

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

Describes one workspace as a place for a chart over a shared model.

It says whether the workspace can take the chart, which dashboard place the tile gets, and which filters the chart follows there. It reads only declarations, and changes nothing.

Examples

# Describe the ad_reporting workspace as a place for a chart over the Ad Reporting model
kater chart destination --request-file ad_reporting_destination.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 shared model and the workspace to describe, as 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_model`	The shared model that the chart reads, by its `model_type`, its `name` and its connection.
`path`	The workspace to describe, by its full path.
`workspace`	Optional. The workspace the chart is in, by its full `path`. When `path` names it, the answer is `here`, and Add to puts a tile of the chart on its dashboard.

{"source_model": {"model_type": "semantic", "name": "ad_reporting", "namespace": {"connection": "snowflake_prod_connection"}}, "path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}

What it shows

enabled says whether the workspace can take the chart, and reason says why not, such as a workspace over another model.
dashboard is where a tile goes: the first tab, and the last section that holds tiles. It is there only when you can change the dashboard. Without it, an add saves only the query and the chart.
filters are the workspace’s optional filters. A chart moved there follows them, and leaves behind its own condition on the same field.

See also