Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Explore and try ideas explore

kater explore tour

Reads a shared model's Explore tour: its cards in the Headlines, Trends, Drivers and Patterns sections, and its questions.

Use it to see what a model can answer before you build anything. It runs nothing on the warehouse and changes no files.

Examples

Terminal window
# Read the tour of the ad_reporting shared model
kater explore tour semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling
# Read only the model's questions
kater explore tour semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling --section questions
# Read more Trends cards, from the offset that the section's next_offset gave
kater explore tour semantic.ad_reporting --scope connections/snowflake_prod_connection/modeling --section trends --offset 5
# Read the tour of the model that source.json names
kater explore tour --request-file source.json

Arguments

ArgumentDescription
<model>Optional. The shared model, by its name or its typed address, such as semantic.ad_reporting. Give --scope with it. Leave it out when you give --request-file.

Options

OptionDescription
--request-file <file>The whole tour request as JSON, from a file, in place of MODEL and --scope. - reads stdin. It can hold section and offset too. See The request file.
--section <id>Reads only one section: headlines, trends, drivers or patterns, or questions for the model’s questions.
--offset <n>Where to start in the section that --section names, such as the section’s next_offset from an earlier read. It needs --section, and questions takes none. The default is 0.

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

What the tour gives

  • Sections. Each section that has cards. A section with more cards than it sent gives next_offset, where the next read starts.
  • Questions. The model’s questions, each with its id and whether it has a plan, as kater explore use-case list lists them.
  • For an editor of the model. It lists the card kinds it could not fill for any measure (blocked). It also lists the measures with no label or no format (gaps).
  • A model that does not compile. The tour is unavailable. reason says why, and recovery says what to do next.

See also