You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ossie.apache.org by "alphonse-terrier (via GitHub)" <gi...@apache.org> on 2026/07/15 14:07:38 UTC
[PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
alphonse-terrier opened a new pull request, #208:
URL: https://github.com/apache/ossie/pull/208
## Motivation
The Snowflake converter's README could give the impression that it produces the newer Snowflake *semantic view* YAML (the format paired with `CREATE SEMANTIC VIEW`). It actually emits the legacy Cortex Analyst semantic model YAML (the stage-based format). These structures overlap but are distinct Snowflake surfaces, and the ambiguity could mislead users about what the output can be plugged into.
## Change
Documentation only — no code or test changes.
- Add an **Output format** note clarifying that the converter emits the legacy Cortex Analyst semantic model YAML, not the semantic view YAML, with a link to Snowflake's semantic view YAML spec.
- Add an **"Ossie YAML and Snowflake semantic views"** section pointing to the native Snowflake procedures/functions that round-trip Ossie YAML to and from semantic views today:
- `SYSTEM$CREATE_SEMANTIC_VIEW_FROM_OSI_YAML` (Ossie YAML → semantic view)
- `SYSTEM$READ_OSI_YAML_FROM_SEMANTIC_VIEW` (semantic view → Ossie YAML)
Both are linked to their official docs. The section also flags a dedicated open-source Ossie ↔ semantic-view converter as welcome future work.
## Scope
- Single file changed: `converters/snowflake/README.md`
- No changes to the converter source or tests.
- ASF license header preserved.
## Checklist
- [ ] ICLA on file with the ASF (required before a first non-trivial contribution merges)
- [x] Change is documentation-only; no tests affected
- [x] Motivation and change described above
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
Posted by "jbonofre (via GitHub)" <gi...@apache.org>.
jbonofre commented on code in PR #208:
URL: https://github.com/apache/ossie/pull/208#discussion_r4052422038
##########
converters/snowflake/README.md:
##########
@@ -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:
Review Comment:
```suggestion
Snowflake can read and write Ossie YAML natively today, though the version/shape it uses (0.1.1, semantic_model-wrapped) currently differs from what this converter emits/accepts — see Limitations.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
Posted by "khush-bhatia (via GitHub)" <gi...@apache.org>.
khush-bhatia commented on PR #208:
URL: https://github.com/apache/ossie/pull/208#issuecomment-5028424080
> Thanks for taking a look, @khush-bhatia 🙏
>
> Agreed that the converted YAML works end-to-end: Snowflake ingests it and creates a Semantic View. That part isn't in dispute.
>
> My point is a different one though: the file doesn't conform to the published [semantic view YAML spec](https://docs.snowflake.com/en/user-guide/views-semantic/semantic-view-yaml-spec), because the converter emits fields that aren't part of that spec (the loader accepts them, but it looks like it just ignores the extras). Concretely:
>
> 1. **`unique_keys` at the table level**: emitted in [`_convert_dataset`](https://github.com/apache/ossie/blob/main/converters/snowflake/src/osi_to_snowflake_yaml_converter.py#L165-L168), visible in the committed example ([`unique_keys:` L30-L33](https://github.com/apache/ossie/blob/main/converters/snowflake/tests/example_converted_tpcds_semantic_model.yaml#L30-L33)). The semantic view YAML table schema only defines `primary_key`. There is no table-level `unique_keys` (there's a `unique` boolean on dimensions/facts, which is a different thing).
> 2. **`synonyms` at the table level**: emitted [here](https://github.com/apache/ossie/blob/main/converters/snowflake/src/osi_to_snowflake_yaml_converter.py#L177-L180) (`store_sales` in the example ([L35-L39](https://github.com/apache/ossie/blob/main/converters/snowflake/tests/example_converted_tpcds_semantic_model.yaml#L35-L39))). In the semantic view YAML spec, `synonyms` live on dimensions/time_dimensions/facts/metrics, not on the table.
>
> Both of these are valid fields in the Cortex Analyst semantic model YAML but they aren't in the semantic view YAML spec. So "creates a Semantic View" and "conforms to the semantic view YAML spec" aren't the same claim: the first is true, the second isn't (extra fields, silently tolerated).
>
> Happy to adjust the doc wording if the "legacy" framing feels too strong but I'd like to keep the note that the output isn't a field-for-field match of the semantic view YAML spec, since that's the practical gotcha for anyone diffing it against the docs. Does that work for you?
@alphonse-terrier
> 1. **`unique_keys` at the table level**: emitted in [`_convert_dataset`]
This represents a documentation gap in snowflake docs. I will follow up to get this fixed. The unique_keys at table level is the preferred approach since it enables customers to define a composite key as unique. The `unique` boolean on dimensions/facts is the old way but it is still supported to maintain backwards compatability.
> 2. **`synonyms` at the table level**:
In the semantic view YAML, synonyms are supported for both tables and facts/dimensions. If the Ossie converter is not handling the conversion correctly here, that's bug in the converter that can be fixed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
Posted by "jbonofre (via GitHub) via issues" <is...@ossie.apache.org>.
jbonofre commented on PR #208:
URL: https://github.com/apache/ossie/pull/208#issuecomment-6539677227
No update from the author. I'm closing, please reopen when you are back on it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
Posted by "jbonofre (via GitHub)" <gi...@apache.org>.
jbonofre commented on PR #208:
URL: https://github.com/apache/ossie/pull/208#issuecomment-5946798998
Any update @alphonse-terrier ?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
Posted by "alphonse-terrier (via GitHub)" <gi...@apache.org>.
alphonse-terrier commented on PR #208:
URL: https://github.com/apache/ossie/pull/208#issuecomment-5000094242
Thanks for taking a look, @khush-bhatia 🙏
Agreed that the converted YAML works end-to-end: Snowflake ingests it and creates a Semantic View. That part isn't in dispute.
My point is a different one though: the file doesn't conform to the published [semantic view YAML spec](https://docs.snowflake.com/en/user-guide/views-semantic/semantic-view-yaml-spec), because the converter emits fields that aren't part of that spec (the loader accepts them, but it looks like it just ignores the extras). Concretely:
1. **`unique_keys` at the table level**: emitted in [`_convert_dataset`](https://github.com/apache/ossie/blob/main/converters/snowflake/src/osi_to_snowflake_yaml_converter.py#L165-L168), visible in the committed example ([`unique_keys:` L30-L33](https://github.com/apache/ossie/blob/main/converters/snowflake/tests/example_converted_tpcds_semantic_model.yaml#L30-L33)). The semantic view YAML table schema only defines `primary_key`. There is no table-level `unique_keys` (there's a `unique` boolean on dimensions/facts, which is a different thing).
2. **`synonyms` at the table level**: emitted [here](https://github.com/apache/ossie/blob/main/converters/snowflake/src/osi_to_snowflake_yaml_converter.py#L177-L180) (`store_sales` in the example ([L35-L39](https://github.com/apache/ossie/blob/main/converters/snowflake/tests/example_converted_tpcds_semantic_model.yaml#L35-L39))). In the semantic view YAML spec, `synonyms` live on dimensions/time_dimensions/facts/metrics, not on the table.
Both of these are valid fields in the Cortex Analyst semantic model YAML but they aren't in the semantic view YAML spec. So "creates a Semantic View" and "conforms to the semantic view YAML spec" aren't the same claim: the first is true, the second isn't (extra fields, silently tolerated).
Happy to adjust the doc wording if the "legacy" framing feels too strong but I'd like to keep the note that the output isn't a field-for-field match of the semantic view YAML spec, since that's the practical gotcha for anyone diffing it against the docs. Does that work for you?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(snowflake): clarify output format and link native Ossie semantic-view functions [ossie]
Posted by "jbonofre (via GitHub) via issues" <is...@ossie.apache.org>.
jbonofre closed pull request #208: docs(snowflake): clarify output format and link native Ossie semantic-view functions
URL: https://github.com/apache/ossie/pull/208
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@ossie.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org