Skip to content

Commit 54445cb

Browse files
Merge branch 'main' into ATSCALE-25338-add-precedence-in-calc-group
2 parents 8bf582c + 8f4ced8 commit 54445cb

File tree

5 files changed

+25
-17
lines changed

5 files changed

+25
-17
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ We are or will be open-sourcing the following:
2222
2. **Pre-built Semantic Models**: The GitHub repository contains pre-built semantic models that incorporate standard data models, such as TPC-DS, common training models like Worldwide Importers and AdventureWorks, and marketplace models like Snowplow and CRISP. We expect to add semantic models for SaaS applications such as Salesforce, Google Analytics, and Jira soon.
2323
3. **SML SDK**: An SDK that facilitates the programmatic reading and writing of SML syntax.
2424
4. **SML CLIs**: Command line interfaces (CLIs) for installing SML dependencies and validating SML syntax. This includes a reference CLI for deploying SML models to a proprietary semantic layer platform.
25-
5. **Semantic Translators**: A CLI for translating other semantic modeling languages to and from SML, including Snowflake Cortex semantic models, Databricks UC Metrics, and Power BI semantic models.
25+
5. **Semantic Converters**: A CLI for translating other semantic modeling languages to and from SML, including Snowflake Cortex semantic models, Databricks UC Metrics, and Power BI semantic models.
2626

2727
## SML Example
2828
The following is an example of an SML `model` object:
@@ -95,6 +95,10 @@ as the properties available for each:
9595
- [Connection](sml-reference/connection.md) - Defines a database and schema for connecting datasets to the physical data platform.
9696
- [Composite Model](sml-reference/composite-model.md) - Defines a model made up of multiple other models.
9797

98+
## SML Converters
99+
100+
[SML Converters and Tooling](https://github.com/semanticdatalayer/sml-converters) - Library of bi-directional SML converters and tooling for different semantic layer platforms.
101+
98102
## Model Library
99103

100104
### Tutorial Models

sml-reference/catalog.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ repository name and settings for building aggregates. Each repository
66
must contain a file called `catalog.yml` at the root level.
77

88
Sample `catalog` file:
9-
```
9+
10+
```yaml
1011
unique_name: sml-models
1112
object_type: catalog
1213
label: SML Model Library
@@ -113,12 +114,14 @@ Supported properties:
113114
- `allow_peer_aggs`: Boolean, optional. Enables aggregation on data
114115
derived from datasets in data warehouses that are different from the
115116
source dataset.
117+
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
118+
in preferred storage.
116119

117120
Specify the `unique_name` of the dataset followed by the properties and
118121
values you want to set for it at the repository level. For example:
119122

120123
dataset1:
121-
create_hinted_aggregate: true
124+
allow_peer_aggs: true
122125

123126
**Note:** Datasets are typically defined at the repository level, in
124127
`catalog.yml`; however, datasets used by a specific model (typically

sml-reference/composite-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When you deploy a composite model, all of its referenced objects are deployed as
1010

1111
Sample `composite_model` file:
1212

13-
```
13+
```yaml
1414
unique_name: TPCDS - Composite
1515
object_type: composite_model
1616
label: TPCDS - Composite

sml-reference/model.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -465,37 +465,36 @@ file.
465465
- **Type:** array
466466
- **Required:** N
467467

468-
A list of the specific metrics and calculations available in the
468+
A list of the specific metrics and calculations to be hidden in the
469469
perspective.
470470

471471
### dimensions
472472

473473
- **Type:** array
474474
- **Required:** N
475475

476-
A list of the specific dimensions and their hierarchies available in the
476+
A list of the specific dimensions and their hierarchies to be hidden in the
477477
perspective.
478478

479-
By default, all objects within a dimension are visible. Hiding a level
480-
in a hierarchy hides all levels below it, as well as their secondary
481-
attributes.
479+
By default, all objects within a dimension are visible. The lowest granularity objects specified are
480+
hidden and the objects above it are not. Hiding a level in a hierarchy hides all levels below it.
481+
Hiding a hierarchy hides all levels in it. Hiding a dimension hides all objects within it including hierarchies
482+
and secondary attributes. If a dimension is not hidden, secondary attributes can be hidden individually.
482483

483484
Supported properties:
484485

485-
- `name`: String, required. The name of the dimension to include in the
486+
- `name`: String, required. The name of the dimension to be hidden in the
486487
perspective.
487488

488489
- `hierarchies`: Array, optional. A list of the specific hierarchies
489-
within the `name` dimension to include in the perspective. Supported
490-
properties:
490+
within the dimension to hide in the perspective. Supported properties:
491491
- `name`: String, required. The name of the hierarchy.
492-
- `levels`: Array, optional. A list of the levels within the
493-
hierarchy to include in the perspective.
492+
- `levels`: Array, optional. Defines a single level in the hierarchy to be hidden in the perspective. All levels below the specified level will also be hidden. Only one level should be provided.
494493

495494
- `secondary_attributes`: Array, optional. A list of the dimension's
496-
secondary attributes to include in the perspective.
495+
secondary attributes to hide in the perspective.
497496

498-
- `relationships_path`: Array, optional. A list of relationships path.
497+
- `relationships_path`: Array, optional. A list of relationships used to specify role-playing.
499498

500499
## drillthroughs
501500

@@ -734,6 +733,8 @@ Supported properties:
734733
- `allow_peer_aggs`: Boolean, optional. Enables aggregation on data
735734
derived from datasets in data warehouses that are different from the
736735
source dataset.
736+
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
737+
in preferred storage.
737738
- `create_hinted_aggregate`: Boolean, options. Enables the creation of
738739
hinted aggregates for the dataset.
739740

sml-reference/package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ individual objects (such as dimensions) across multiple models.
66

77
Sample `package` file:
88

9-
```
9+
```yaml
1010
packages:
1111
- name: shared
1212
url: https://github.com/company/shared

0 commit comments

Comments
 (0)