Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions converters/snowflake/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@

Converts Ossie YAML semantic models to [Snowflake Cortex Analyst](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst) semantic model YAML. Pure offline conversion — no Snowflake connection required.

> **Output format:** This converter produces the **legacy** Cortex Analyst semantic model YAML — the stage-based format. It is *not* the newer Snowflake [semantic view YAML](https://docs.snowflake.com/en/user-guide/views-semantic/semantic-view-yaml-spec) (`views-semantic`) that pairs with the `CREATE SEMANTIC VIEW` DDL. The two structures overlap heavily but are distinct Snowflake surfaces. See [Ossie YAML and Snowflake semantic views](#ossie-yaml-and-snowflake-semantic-views) below for how to get to an actual semantic view.

> **Note:** This converter is under active development. It handles common cases but has not been thoroughly tested against all edge cases — use with caution in production.

## Setup
Expand All @@ -44,3 +46,10 @@ python3 -m pytest tests/
## Limitations

Some Ossie concepts (e.g., `ai_context` on relationships) do not have a native counterpart in the Snowflake semantic model. These are dropped during conversion and the converter will emit warnings so you know what was left behind.

## Ossie YAML and Snowflake semantic views

A dedicated open-source Ossie ↔ semantic-view converter would be a welcome future addition. In the meantime, Snowflake can already read and write Ossie YAML natively, so the round-trip works today:

- [`SYSTEM$CREATE_SEMANTIC_VIEW_FROM_OSSIE_YAML`](https://docs.snowflake.com/en/sql-reference/stored-procedures/system_create_semantic_view_from_ossie_yaml) — create a semantic view directly from Ossie YAML (Ossie YAML → semantic view).
- [`SYSTEM$READ_OSSIE_YAML_FROM_SEMANTIC_VIEW`](https://docs.snowflake.com/en/sql-reference/functions/system_read_ossie_yaml_from_semantic_view) — export an existing semantic view to Ossie YAML (semantic view → Ossie YAML).