You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: sml-reference/dimension.md
+47Lines changed: 47 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -269,6 +269,7 @@ namespace Dimensions{
269
269
Boolean is_aggregatable
270
270
Boolean exclude_from_fact_agg
271
271
String time_unit
272
+
Int constraint_translation_rank
272
273
Array~String~ allowed_calcs_for_dma
273
274
CustomEmptyMember custom_empty_member
274
275
String folder
@@ -308,12 +309,15 @@ namespace Dimensions{
308
309
String label
309
310
String description
310
311
String folder
312
+
Number precedence
311
313
Array~CalculatedMembers~ calculated_members
314
+
Boolean is_hidden
312
315
}
313
316
class CalculatedMembers{
314
317
String unique_name
315
318
String description
316
319
String format
320
+
Boolean is_hidden
317
321
String expression
318
322
Boolean use_input_metric_format
319
323
String template
@@ -541,13 +545,36 @@ Defines the individual calculated members in the group.
541
545
542
546
A description of the calculation group.
543
547
548
+
## is_hidden
549
+
550
+
-**Type:** boolean
551
+
-**Required:** N
552
+
553
+
Determines whether the calculation group is visible in BI tools.
554
+
555
+
Supported values:
556
+
557
+
-`false` (default)
558
+
-`true`
559
+
544
560
## folder
545
561
546
562
-**Type:** string
547
563
-**Required:** N
548
564
549
565
The name of the folder in which the calculation group is displayed in BI tools.
550
566
567
+
## precedence
568
+
569
+
-**Type:** number
570
+
-**Required:** N
571
+
572
+
Update to "Precedence" explicitly defines the order of Calculation Group evaluation, making it consistent across BI tools.
573
+
574
+
Supported values:
575
+
576
+
- Integer and floating point numbers
577
+
551
578
# Calculated Members Properties
552
579
553
580
## unique_name
@@ -577,6 +604,18 @@ Supported templates:
577
604
578
605
If you do not want to use a built-in template, you can define a custom expression using the `expression` property (see below).
579
606
607
+
## is_hidden
608
+
609
+
-**Type:** boolean
610
+
-**Required:** N
611
+
612
+
Determines whether the attribute is visible in BI tools.
613
+
614
+
Supported values:
615
+
616
+
-`false` (default)
617
+
-`true`
618
+
580
619
## expression
581
620
582
621
-**Type:** string
@@ -1188,6 +1227,14 @@ If the key consists of one column, the values in that column must be
1188
1227
unique. If the key is a compound key, the columns together must provide
1189
1228
unique values.
1190
1229
1230
+
## constraint_translation_rank
1231
+
1232
+
-**Type:** integer
1233
+
-**Required:** N
1234
+
-**Range:** should be a valid 32 bit integer
1235
+
1236
+
Defines the translation of dimension filter constraints into fact table partition column constraints. This can significantly improve query performance for cases where fact-based aggregates are not used.
For example, if you wanted to use the prefix **Order**, you would set
396
396
`role_play` to `"Order {0}"`.
397
397
398
+
### constraint_translation
399
+
400
+
-**Type:** object
401
+
-**Required:** N
402
+
403
+
Defines the translation of dimension filter constraints into fact table partition column constraints. This can significantly improve query performance for cases where fact-based aggregates are not used.
404
+
405
+
Supported properties:
406
+
407
+
-`level`: String, required. Indicates the dimension level to which the constraint translation applies.
408
+
-`from_columns`: Array, required. Lists the column(s) in the dataset that should be used for the join.
409
+
410
+
If the `constraint_translation` property is defined, a corresponding `constraint_translation_rank` must be present in the associated level.
411
+
398
412
## metrics
399
413
400
414
-**Type:** array
@@ -440,7 +454,7 @@ analysts with the entire data model, you can make specific dimensions,
440
454
hierarchies, levels, secondary attributes, measures, and calculated
441
455
measures invisible to them.
442
456
443
-
**Note:** We recommend that you add perspectives *after* a model has
457
+
**Note:** We recommend that you add perspectives _after_ a model has
444
458
been fully tested. Although you can edit a model after adding
445
459
perspectives, any changes might require you to update the perspectives
446
460
to hide new objects that would otherwise be visible to all users.
@@ -476,9 +490,9 @@ perspective.
476
490
A list of the specific dimensions and their hierarchies to be hidden in the
477
491
perspective.
478
492
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
493
+
By default, all objects within a dimension are visible. The lowest granularity objects specified are
494
+
hidden and the objects above it are not. Hiding a level in a hierarchy hides all levels below it.
495
+
Hiding a hierarchy hides all levels in it. Hiding a dimension hides all objects within it including hierarchies
482
496
and secondary attributes. If a dimension is not hidden, secondary attributes can be hidden individually.
483
497
484
498
Supported properties:
@@ -488,9 +502,10 @@ Supported properties:
488
502
489
503
-`hierarchies`: Array, optional. A list of the specific hierarchies
490
504
within the dimension to hide in the perspective. Supported properties:
491
-
-`name`: String, required. The name of the hierarchy.
492
-
-`level`: String, optional. Defines a single level in the hierarchy to be hidden in the perspective. All levels below the specified level will also be hidden.
493
-
-`levels`: Array, optional. ⚠️ **DEPRECATED** use `level` instead.
505
+
506
+
-`name`: String, required. The name of the hierarchy.
507
+
-`level`: String, optional. Defines a single level in the hierarchy to be hidden in the perspective. All levels below the specified level will also be hidden.
508
+
-`levels`: Array, optional. ⚠️ **DEPRECATED** use `level` instead.
494
509
495
510
-`secondary_attributes`: Array, optional. A list of the dimension's
496
511
secondary attributes to hide in the perspective.
@@ -644,22 +659,22 @@ Supported properties:
644
659
determines whether it should be defined on the key column, name
645
660
column, or both. Supported values: `name`, `key`, `name+key`
646
661
647
-
When the engine builds an instance of this aggregate, it creates
648
-
a partition for each combination of values in the dimensional
649
-
attributes. The number of partitions depends on the
650
-
left-to-right order of the attributes, as well as the number of
651
-
values for each attribute.
662
+
When the engine builds an instance of this aggregate, it creates
663
+
a partition for each combination of values in the dimensional
664
+
attributes. The number of partitions depends on the
665
+
left-to-right order of the attributes, as well as the number of
666
+
values for each attribute.
652
667
653
-
Essentially, the partitioning key functions as a `GROUP BY`
654
-
column. Queries against the aggregate must use this dimensional
655
-
attribute in a `WHERE` clause. A good candidate for a
656
-
partitioning key is a set of dimensional attributes that
657
-
together have a few hundred to under 1000 value combinations.
668
+
Essentially, the partitioning key functions as a `GROUP BY`
669
+
column. Queries against the aggregate must use this dimensional
670
+
attribute in a `WHERE` clause. A good candidate for a
671
+
partitioning key is a set of dimensional attributes that
672
+
together have a few hundred to under 1000 value combinations.
658
673
659
674
-`distribution`: String, optional. The distribution keys to use when
660
675
creating the aggregate table. If your aggregate data warehouse
661
676
supports distribution keys, then the semantic engine uses the specified keys when
662
-
creating the aggregate table.
677
+
creating the aggregate table.
663
678
664
679
## partitions
665
680
@@ -734,7 +749,7 @@ Supported properties:
734
749
-`allow_peer_aggs`: Boolean, optional. Enables aggregation on data
735
750
derived from datasets in data warehouses that are different from the
736
751
source dataset.
737
-
-`allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
752
+
-`allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
738
753
in preferred storage.
739
754
-`create_hinted_aggregate`: Boolean, options. Enables the creation of
0 commit comments