-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy pathschema.rs
More file actions
1763 lines (1635 loc) · 55.4 KB
/
Copy pathschema.rs
File metadata and controls
1763 lines (1635 loc) · 55.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! YAML schema definitions for config loading
//!
//! Supports both native Sidemantic format and Cube.js format.
use serde::{Deserialize, Serialize};
use crate::core::{
Aggregation, CohortInnerMetric, ComparisonCalculation, ComparisonType, Dimension,
DimensionType, Metric, MetricType, Model, Parameter, ParameterType, PreAggregation,
PreAggregationType, RefreshKey, Relationship, RelationshipType, Segment, TimeGrain,
};
pub const NATIVE_FORMAT_VERSION: u32 = 1;
// =============================================================================
// Native Sidemantic Format
// =============================================================================
/// Root schema for native sidemantic YAML files
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(deny_unknown_fields)]
pub struct SidemanticConfig {
#[serde(default)]
pub version: Option<u32>,
#[serde(default)]
pub models: Vec<ModelConfig>,
/// Graph-level metrics (can reference model metrics)
#[serde(default)]
pub metrics: Vec<MetricConfig>,
#[serde(default)]
pub parameters: Vec<ParameterConfig>,
#[serde(default)]
pub sql_metrics: Option<String>,
#[serde(default)]
pub sql_segments: Option<String>,
/// Graph-level metadata payload (round-trips format-specific state such as OSI,
/// and Snowflake Cortex top-level sections from the Python native export).
#[serde(default)]
pub metadata: Option<serde_json::Value>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ModelConfig {
pub name: String,
/// Parent model to inherit from
pub extends: Option<String>,
pub table: Option<String>,
pub sql: Option<String>,
pub source_uri: Option<String>,
#[serde(default = "default_primary_key_config")]
pub primary_key: KeyConfig,
#[serde(default)]
pub primary_key_columns: Option<Vec<String>>,
#[serde(default)]
pub unique_keys: Option<Vec<Vec<String>>>,
pub description: Option<String>,
pub label: Option<String>,
#[serde(default)]
pub metadata: Option<serde_json::Value>,
#[serde(default)]
pub meta: Option<serde_json::Value>,
#[serde(default)]
pub auto_dimensions: bool,
#[serde(default)]
pub dimensions: Vec<DimensionConfig>,
#[serde(default, alias = "measures")]
pub metrics: Vec<MetricConfig>,
#[serde(default)]
pub relationships: Vec<RelationshipConfig>,
#[serde(default)]
pub segments: Vec<SegmentConfig>,
#[serde(default)]
pub pre_aggregations: Vec<PreAggregationConfig>,
pub default_time_dimension: Option<String>,
pub default_grain: Option<String>,
#[serde(default)]
pub freshness: Option<FreshnessConfig>,
#[serde(default)]
pub sql_metrics: Option<String>,
#[serde(default)]
pub sql_segments: Option<String>,
}
fn default_primary_key() -> String {
"id".to_string()
}
fn default_primary_key_config() -> KeyConfig {
KeyConfig::Single(default_primary_key())
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum KeyConfig {
Single(String),
Multiple(Vec<String>),
}
impl KeyConfig {
fn into_columns(self) -> Vec<String> {
match self {
Self::Single(value) => vec![value],
Self::Multiple(values) => values,
}
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct FreshnessConfig {
#[serde(default)]
pub watermark: Option<String>,
#[serde(default)]
pub sql: Option<String>,
#[serde(default, alias = "ttlSeconds")]
pub ttl_seconds: Option<u64>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct DimensionConfig {
pub name: String,
#[serde(default, rename = "type")]
pub dim_type: Option<String>,
#[serde(default, alias = "expr")]
pub sql: Option<String>,
pub granularity: Option<String>,
pub supported_granularities: Option<Vec<String>>,
pub description: Option<String>,
pub label: Option<String>,
#[serde(default)]
pub metadata: Option<serde_json::Value>,
#[serde(default)]
pub meta: Option<serde_json::Value>,
/// Alternative names (e.g. Snowflake Cortex Analyst, Cube).
#[serde(default)]
pub synonyms: Option<Vec<String>>,
/// Representative sample values for this dimension.
#[serde(default)]
pub sample_values: Option<Vec<String>>,
/// Linked Cortex Search service name (Snowflake Cortex Analyst).
#[serde(default)]
pub cortex_search_service_name: Option<String>,
pub format: Option<String>,
pub value_format_name: Option<String>,
pub parent: Option<String>,
pub window: Option<String>,
#[serde(default = "default_public")]
pub public: bool,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct MetricConfig {
pub name: String,
pub extends: Option<String>,
#[serde(default, rename = "type")]
pub metric_type: Option<String>,
pub agg: Option<String>,
#[serde(default, alias = "expr", alias = "measure")]
pub sql: Option<String>,
#[serde(default, rename = "metrics", skip_serializing_if = "Option::is_none")]
_legacy_metric_dependencies: Option<Vec<String>>,
pub numerator: Option<String>,
pub denominator: Option<String>,
pub offset_window: Option<String>,
pub window: Option<String>,
pub grain_to_date: Option<String>,
pub window_expression: Option<String>,
pub window_frame: Option<String>,
pub window_order: Option<String>,
pub base_metric: Option<String>,
pub comparison_type: Option<String>,
pub time_offset: Option<String>,
pub calculation: Option<String>,
pub entity: Option<String>,
pub base_event: Option<String>,
pub conversion_event: Option<String>,
pub conversion_window: Option<String>,
pub steps: Option<Vec<String>>,
pub cohort_event: Option<String>,
pub activity_event: Option<String>,
pub periods: Option<usize>,
pub retention_granularity: Option<String>,
pub granularity: Option<String>,
pub inner_metrics: Option<Vec<CohortInnerMetricConfig>>,
pub entity_dimensions: Option<Vec<String>>,
pub having: Option<String>,
pub fill_nulls_with: Option<serde_json::Value>,
pub format: Option<String>,
pub value_format_name: Option<String>,
pub drill_fields: Option<Vec<String>>,
pub non_additive_dimension: Option<String>,
#[serde(default)]
pub filters: Vec<String>,
pub description: Option<String>,
pub label: Option<String>,
#[serde(default)]
pub metadata: Option<serde_json::Value>,
#[serde(default)]
pub meta: Option<serde_json::Value>,
/// Alternative names (e.g. Snowflake Cortex Analyst, Cube).
#[serde(default)]
pub synonyms: Option<Vec<String>>,
#[serde(default = "default_public")]
pub public: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct CohortInnerMetricConfig {
pub name: String,
pub agg: Option<String>,
pub sql: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RelationshipConfig {
pub name: String,
#[serde(default, rename = "type")]
pub rel_type: Option<String>,
pub foreign_key: Option<KeyConfig>,
#[serde(default)]
pub foreign_key_columns: Option<Vec<String>>,
pub primary_key: Option<KeyConfig>,
#[serde(default)]
pub primary_key_columns: Option<Vec<String>>,
pub through: Option<String>,
pub through_foreign_key: Option<String>,
#[serde(default)]
pub through_foreign_key_columns: Option<Vec<String>>,
pub related_foreign_key: Option<String>,
#[serde(default)]
pub related_foreign_key_columns: Option<Vec<String>>,
/// Custom SQL join condition using {from} and {to} placeholders
pub sql: Option<String>,
#[serde(default)]
pub metadata: Option<serde_json::Value>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct SegmentConfig {
pub name: String,
pub sql: String,
pub description: Option<String>,
#[serde(default = "default_public")]
pub public: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct PreAggregationConfig {
pub name: String,
#[serde(default, rename = "type")]
pub preagg_type: Option<String>,
#[serde(default)]
pub sql: Option<String>,
#[serde(default)]
pub measures: Option<Vec<String>>,
#[serde(default)]
pub dimensions: Option<Vec<String>>,
#[serde(default)]
pub time_dimension: Option<String>,
#[serde(default)]
pub granularity: Option<String>,
#[serde(default)]
pub partition_granularity: Option<String>,
#[serde(default)]
pub build_range_start: Option<String>,
#[serde(default)]
pub build_range_end: Option<String>,
#[serde(default = "default_scheduled_refresh")]
pub scheduled_refresh: bool,
#[serde(default)]
pub refresh_key: Option<RefreshKeyConfig>,
#[serde(default)]
pub indexes: Option<Vec<IndexConfig>>,
#[serde(default)]
pub meta: Option<serde_json::Value>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct RefreshKeyConfig {
#[serde(default)]
pub every: Option<String>,
#[serde(default)]
pub sql: Option<String>,
#[serde(default)]
pub incremental: bool,
#[serde(default)]
pub update_window: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct IndexConfig {
pub name: String,
#[serde(default)]
pub columns: Vec<String>,
#[serde(default = "default_index_type", rename = "type")]
pub index_type: String,
}
fn default_public() -> bool {
true
}
fn default_index_type() -> String {
"regular".to_string()
}
fn default_scheduled_refresh() -> bool {
true
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ParameterConfig {
pub name: String,
#[serde(rename = "type")]
pub parameter_type: ParameterType,
pub description: Option<String>,
pub label: Option<String>,
pub default_value: Option<serde_json::Value>,
pub allowed_values: Option<Vec<serde_json::Value>>,
#[serde(default)]
pub default_to_today: bool,
}
// =============================================================================
// Conversion to Core Types
// =============================================================================
impl SidemanticConfig {
pub fn validate_version(&self) -> crate::error::Result<()> {
match self.version {
None | Some(NATIVE_FORMAT_VERSION) => Ok(()),
Some(version) => Err(crate::error::SidemanticError::validation_issue(
"unsupported_native_format_version",
None,
"version",
Some(&version.to_string()),
format!(
"Unsupported native Sidemantic format version {version}; supported version is {NATIVE_FORMAT_VERSION}"
),
)),
}
}
pub fn validate_contract(&self) -> crate::error::Result<()> {
self.validate_version()?;
for model in &self.models {
if model.auto_dimensions {
return Err(crate::error::SidemanticError::validation_issue(
"unsupported_auto_dimensions",
Some(&model.name),
&format!("models.{}.auto_dimensions", model.name),
Some("true"),
"Rust native runtime does not support auto_dimensions; declare dimensions explicitly or set auto_dimensions: false",
));
}
validate_optional_enum(
model.default_grain.as_deref(),
&format!("models.{}.default_grain", model.name),
TIME_GRAINS,
)?;
if let Some(freshness) = &model.freshness {
if freshness.watermark.is_some() && freshness.sql.is_some() {
return Err(crate::error::SidemanticError::validation_issue(
"invalid_freshness_policy",
Some(&model.name),
&format!("models.{}.freshness", model.name),
None,
"Model freshness cannot define both watermark and sql",
));
}
if freshness.ttl_seconds == Some(0) {
return Err(crate::error::SidemanticError::validation_issue(
"invalid_freshness_ttl",
Some(&model.name),
&format!("models.{}.freshness.ttl_seconds", model.name),
Some("0"),
"Model freshness ttl_seconds must be positive",
));
}
}
for dimension in &model.dimensions {
validate_optional_enum(
dimension.dim_type.as_deref(),
&format!("models.{}.dimensions.{}.type", model.name, dimension.name),
&[
"categorical",
"string",
"time",
"boolean",
"numeric",
"number",
],
)?;
validate_optional_enum(
dimension.granularity.as_deref(),
&format!(
"models.{}.dimensions.{}.granularity",
model.name, dimension.name
),
TIME_GRAINS,
)?;
if let Some(supported_granularities) = dimension.supported_granularities.as_ref() {
for granularity in supported_granularities {
validate_enum(
granularity,
&format!(
"models.{}.dimensions.{}.supported_granularities",
model.name, dimension.name
),
TIME_GRAINS,
)?;
}
}
}
for metric in &model.metrics {
validate_metric_config(
metric,
&format!("models.{}.metrics.{}", model.name, metric.name),
)?;
}
for relationship in &model.relationships {
validate_optional_enum(
relationship.rel_type.as_deref(),
&format!(
"models.{}.relationships.{}.type",
model.name, relationship.name
),
&[
"many_to_one",
"manytoone",
"one_to_one",
"onetoone",
"one_to_many",
"onetomany",
"many_to_many",
"manytomany",
],
)?;
}
for preagg in &model.pre_aggregations {
validate_optional_enum(
preagg.preagg_type.as_deref(),
&format!(
"models.{}.pre_aggregations.{}.type",
model.name, preagg.name
),
&["rollup", "original_sql", "rollup_join", "lambda"],
)?;
if let Some(granularity) = preagg.granularity.as_deref() {
validate_enum(
granularity,
&format!(
"models.{}.pre_aggregations.{}.granularity",
model.name, preagg.name
),
PREAGG_GRANULARITIES,
)?;
}
if let Some(partition_granularity) = preagg.partition_granularity.as_deref() {
validate_enum(
partition_granularity,
&format!(
"models.{}.pre_aggregations.{}.partition_granularity",
model.name, preagg.name
),
PARTITION_GRANULARITIES,
)?;
}
}
}
for metric in &self.metrics {
validate_metric_config(metric, &format!("metrics.{}", metric.name))?;
}
Ok(())
}
/// Convert to core models, top-level metrics, and top-level parameters.
pub fn into_parts(self) -> crate::error::Result<(Vec<Model>, Vec<Metric>, Vec<Parameter>)> {
self.validate_contract()?;
let models = self.models.into_iter().map(|m| m.into_model()).collect();
let metrics = self.metrics.into_iter().map(|m| m.into_metric()).collect();
let parameters = self
.parameters
.into_iter()
.map(|p| p.into_parameter())
.collect();
Ok((models, metrics, parameters))
}
/// Convert to list of core Model types
pub fn into_models(self) -> crate::error::Result<Vec<Model>> {
Ok(self.into_parts()?.0)
}
}
impl ModelConfig {
/// Convert to core Model type
pub fn into_model(self) -> Model {
let primary_key_columns = self
.primary_key_columns
.filter(|columns| !columns.is_empty())
.unwrap_or_else(|| self.primary_key.into_columns());
let primary_key = primary_key_columns
.first()
.cloned()
.unwrap_or_else(default_primary_key);
Model {
name: self.name,
table: self.table,
sql: self.sql,
source_uri: self.source_uri,
extends: self.extends,
primary_key,
primary_key_columns,
unique_keys: self.unique_keys,
dimensions: self
.dimensions
.into_iter()
.map(|d| d.into_dimension())
.collect(),
metrics: self.metrics.into_iter().map(|m| m.into_metric()).collect(),
relationships: self
.relationships
.into_iter()
.map(|r| r.into_relationship())
.collect(),
segments: self
.segments
.into_iter()
.map(|s| s.into_segment())
.collect(),
pre_aggregations: self
.pre_aggregations
.into_iter()
.map(|p| p.into_pre_aggregation())
.collect(),
default_time_dimension: self.default_time_dimension,
default_grain: self.default_grain,
label: self.label,
description: self.description,
metadata: self.metadata,
meta: self.meta,
}
}
}
impl DimensionConfig {
fn into_dimension(self) -> Dimension {
let dim_type = match self
.dim_type
.as_deref()
.map(str::to_ascii_lowercase)
.as_deref()
{
Some("time") => DimensionType::Time,
Some("boolean") => DimensionType::Boolean,
Some("numeric" | "number") => DimensionType::Numeric,
_ => DimensionType::Categorical,
};
Dimension {
name: self.name,
r#type: dim_type,
sql: self.sql,
granularity: self.granularity,
supported_granularities: self.supported_granularities,
label: self.label,
description: self.description,
metadata: self.metadata,
meta: self.meta,
format: self.format,
value_format_name: self.value_format_name,
parent: self.parent,
window: self.window,
public: self.public,
}
}
}
impl MetricConfig {
fn into_metric(self) -> Metric {
let explicit_metric_type = self.metric_type.as_deref().map(str::to_ascii_lowercase);
let can_normalize_inline_aggregation =
matches!(explicit_metric_type.as_deref(), None | Some("simple"));
let inline_aggregation = if self.agg.is_none() && can_normalize_inline_aggregation {
self.sql
.as_deref()
.and_then(parse_inline_metric_aggregation)
} else {
None
};
let metric_type = match explicit_metric_type.as_deref() {
Some("simple") => MetricType::Simple,
Some("derived") => MetricType::Derived,
Some("ratio") => MetricType::Ratio,
Some("cumulative") => MetricType::Cumulative,
Some("time_comparison" | "timecomparison") => MetricType::TimeComparison,
Some("conversion") => MetricType::Conversion,
Some("retention") => MetricType::Retention,
Some("cohort") => MetricType::Cohort,
_ => {
if inline_aggregation.is_none() && self.agg.is_none() && self.sql.is_some() {
MetricType::Derived
} else {
MetricType::Simple
}
}
};
let agg = self
.agg
.as_deref()
.map(parse_aggregation)
.or_else(|| inline_aggregation.as_ref().map(|(agg, _)| agg.clone()));
let sql = inline_aggregation
.as_ref()
.and_then(|(_, inner_sql)| inner_sql.clone())
.or(self.sql);
let grain_to_date = self.grain_to_date.as_deref().and_then(parse_time_grain);
let comparison_type = self
.comparison_type
.as_deref()
.and_then(parse_comparison_type);
let calculation = self
.calculation
.as_deref()
.and_then(parse_comparison_calculation);
let inner_metrics = self.inner_metrics.map(|items| {
items
.into_iter()
.map(|item| CohortInnerMetric {
name: item.name,
agg: item.agg.as_deref().map(parse_aggregation),
sql: item.sql,
})
.collect()
});
Metric {
name: self.name,
extends: self.extends,
r#type: metric_type,
agg,
sql,
numerator: self.numerator,
denominator: self.denominator,
offset_window: self.offset_window,
filters: self.filters,
label: self.label,
description: self.description,
metadata: self.metadata,
meta: self.meta,
window: self.window,
grain_to_date,
window_expression: self.window_expression,
window_frame: self.window_frame,
window_order: self.window_order,
base_metric: self.base_metric,
comparison_type,
time_offset: self.time_offset,
calculation,
entity: self.entity,
base_event: self.base_event,
conversion_event: self.conversion_event,
conversion_window: self.conversion_window,
steps: self.steps,
cohort_event: self.cohort_event,
activity_event: self.activity_event,
periods: self.periods,
retention_granularity: self.retention_granularity.or(self.granularity),
inner_metrics,
entity_dimensions: self.entity_dimensions,
having: self.having,
fill_nulls_with: self.fill_nulls_with,
format: self.format,
value_format_name: self.value_format_name,
drill_fields: self.drill_fields,
non_additive_dimension: self.non_additive_dimension,
public: self.public,
}
}
}
impl RelationshipConfig {
fn into_relationship(self) -> Relationship {
let rel_type = match self
.rel_type
.as_deref()
.map(str::to_ascii_lowercase)
.as_deref()
{
Some("one_to_one" | "onetoone") => RelationshipType::OneToOne,
Some("one_to_many" | "onetomany") => RelationshipType::OneToMany,
Some("many_to_many" | "manytomany") => RelationshipType::ManyToMany,
_ => RelationshipType::ManyToOne,
};
let foreign_key_columns = self
.foreign_key_columns
.filter(|columns| !columns.is_empty())
.or_else(|| self.foreign_key.clone().map(KeyConfig::into_columns));
let primary_key_columns = self
.primary_key_columns
.filter(|columns| !columns.is_empty())
.or_else(|| self.primary_key.clone().map(KeyConfig::into_columns));
Relationship {
name: self.name,
r#type: rel_type,
foreign_key: foreign_key_columns
.as_ref()
.and_then(|columns| columns.first().cloned()),
foreign_key_columns,
primary_key: primary_key_columns
.as_ref()
.and_then(|columns| columns.first().cloned()),
primary_key_columns,
through: self.through,
through_foreign_key: self.through_foreign_key,
through_foreign_key_columns: self
.through_foreign_key_columns
.filter(|columns| !columns.is_empty()),
related_foreign_key: self.related_foreign_key,
related_foreign_key_columns: self
.related_foreign_key_columns
.filter(|columns| !columns.is_empty()),
sql: self.sql,
metadata: self.metadata,
}
}
}
impl SegmentConfig {
fn into_segment(self) -> Segment {
Segment {
name: self.name,
sql: self.sql,
description: self.description,
public: self.public,
}
}
}
impl PreAggregationConfig {
fn into_pre_aggregation(self) -> PreAggregation {
let preagg_type = match self
.preagg_type
.as_deref()
.map(str::to_ascii_lowercase)
.as_deref()
{
Some("original_sql") => PreAggregationType::OriginalSql,
Some("rollup_join") => PreAggregationType::RollupJoin,
Some("lambda") => PreAggregationType::Lambda,
_ => PreAggregationType::Rollup,
};
PreAggregation {
name: self.name,
preagg_type,
sql: self.sql,
measures: self.measures,
dimensions: self.dimensions,
time_dimension: self.time_dimension,
granularity: self.granularity,
partition_granularity: self.partition_granularity,
build_range_start: self.build_range_start,
build_range_end: self.build_range_end,
scheduled_refresh: self.scheduled_refresh,
refresh_key: self.refresh_key.map(|r| RefreshKey {
every: r.every,
sql: r.sql,
incremental: r.incremental,
update_window: r.update_window,
}),
indexes: self.indexes.map(|indexes| {
indexes
.into_iter()
.map(|idx| crate::core::Index {
name: idx.name,
columns: idx.columns,
index_type: idx.index_type,
})
.collect()
}),
meta: self.meta,
}
}
}
impl ParameterConfig {
fn into_parameter(self) -> Parameter {
Parameter {
name: self.name,
parameter_type: self.parameter_type,
description: self.description,
label: self.label,
default_value: self.default_value,
allowed_values: self.allowed_values,
default_to_today: self.default_to_today,
}
}
}
/// Build a [`Metric`] from a raw SQL expression, applying the same inline
/// aggregation detection and metric-type inference as the native YAML loader.
///
/// Used by importers (e.g. OSI) whose metric definitions carry full aggregate
/// expressions like `SUM(orders.amount)` or `COUNT(DISTINCT customers.id)`.
pub(crate) fn metric_from_sql_expression(
name: String,
sql: Option<String>,
description: Option<String>,
meta: Option<serde_json::Value>,
) -> Metric {
MetricConfig {
name,
sql,
description,
meta,
public: true,
..MetricConfig::default()
}
.into_metric()
}
/// Parse a YAML list of metric configs into core [`Metric`]s, applying the same
/// inline-aggregation and type inference as the native loader. Used to ferry
/// graph-level metrics through the bridge without imposing model ownership.
pub(crate) fn metrics_from_config_yaml(yaml: &str) -> crate::error::Result<Vec<Metric>> {
let configs: Vec<MetricConfig> = serde_yaml::from_str(yaml).map_err(|e| {
crate::error::SidemanticError::Validation(format!("failed to parse metrics: {e}"))
})?;
Ok(configs.into_iter().map(MetricConfig::into_metric).collect())
}
// =============================================================================
// Helpers
// =============================================================================
const TIME_GRAINS: &[&str] = &[
"second", "minute", "hour", "day", "week", "month", "quarter", "year",
];
const PERIOD_GRAINS: &[&str] = &["day", "week", "month", "quarter", "year"];
const RETENTION_GRAINS: &[&str] = &["day", "week", "month"];
const PREAGG_GRANULARITIES: &[&str] = &["hour", "day", "week", "month", "quarter", "year"];
const PARTITION_GRANULARITIES: &[&str] = &["day", "week", "month", "quarter", "year"];
fn validate_optional_enum(
value: Option<&str>,
field_path: &str,
allowed: &[&str],
) -> crate::error::Result<()> {
if let Some(value) = value {
validate_enum(value, field_path, allowed)?;
}
Ok(())
}
fn validate_enum(value: &str, field_path: &str, allowed: &[&str]) -> crate::error::Result<()> {
let normalized = value.to_ascii_lowercase();
if allowed
.iter()
.any(|allowed_value| *allowed_value == normalized)
{
return Ok(());
}
Err(crate::error::SidemanticError::validation_issue(
"unsupported_enum_value",
model_name_from_field_path(field_path).as_deref(),
field_path,
Some(value),
format!(
"Unsupported value '{value}' for {field_path}; supported values are {}",
allowed.join(", ")
),
))
}
fn model_name_from_field_path(field_path: &str) -> Option<String> {
let mut parts = field_path.split('.');
if parts.next()? != "models" {
return None;
}
parts.next().map(ToString::to_string)
}
fn validate_metric_config(metric: &MetricConfig, field_path: &str) -> crate::error::Result<()> {
validate_optional_enum(
metric.metric_type.as_deref(),
&format!("{field_path}.type"),
&[
"simple",
"derived",
"ratio",
"cumulative",
"time_comparison",
"timecomparison",
"conversion",
"retention",
"cohort",
],
)?;
validate_optional_enum(
metric.agg.as_deref(),
&format!("{field_path}.agg"),
&[
"count",
"count_distinct",
"countdistinct",
"sum",
"avg",
"average",
"min",
"max",
"median",
"stddev",
"stddev_pop",
"variance",
"variance_pop",
"expression",
],
)?;
validate_optional_enum(
metric.grain_to_date.as_deref(),
&format!("{field_path}.grain_to_date"),
PERIOD_GRAINS,
)?;
validate_optional_enum(
metric.retention_granularity.as_deref(),
&format!("{field_path}.retention_granularity"),
RETENTION_GRAINS,
)?;
validate_optional_enum(
metric.granularity.as_deref(),
&format!("{field_path}.granularity"),
RETENTION_GRAINS,
)?;
validate_optional_enum(
metric.comparison_type.as_deref(),
&format!("{field_path}.comparison_type"),
&["yoy", "mom", "wow", "dod", "qoq", "prior_period"],
)?;
validate_optional_enum(
metric.calculation.as_deref(),
&format!("{field_path}.calculation"),
&["difference", "percent_change", "ratio"],
)?;
if let Some(inner_metrics) = metric.inner_metrics.as_ref() {
for inner_metric in inner_metrics {
validate_optional_enum(
inner_metric.agg.as_deref(),
&format!("{field_path}.inner_metrics.{}.agg", inner_metric.name),
&[
"count",
"count_distinct",
"countdistinct",
"sum",
"avg",
"average",
"min",
"max",
"median",
"stddev",
"stddev_pop",
"variance",
"variance_pop",
"expression",
],
)?;
}
}
Ok(())
}
fn parse_aggregation(s: &str) -> Aggregation {
match s.to_lowercase().as_str() {
"count" => Aggregation::Count,
"count_distinct" | "countdistinct" => Aggregation::CountDistinct,