Consolidated meta config to use the same models

.changes/unreleased/Breaking Changes-20241024-131227.yaml

@@ -0,0 +1,6 @@
+kind: Breaking Changes
+body: Consolidated meta config to use the same models
+time: 2024-10-24T13:12:27.343387-05:00
+custom:
+    Author: DevonFulcher
+    Issue: None

.changes/unreleased/Features-20241023-113450.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Support meta for dimensions, entities, and measures
+time: 2024-10-23T11:34:50.577294-05:00
+custom:
+    Author: DevonFulcher
+    Issue: None

dbt_semantic_interfaces/implementations/element_config.py

@@ -0,0 +1,18 @@
+from typing import Any, Dict
+
+from pydantic import Field
+from typing_extensions import override
+
+from dbt_semantic_interfaces.implementations.base import HashableBaseModel
+from dbt_semantic_interfaces.protocols.meta import SemanticLayerElementConfig
+from dbt_semantic_interfaces.protocols.protocol_hint import ProtocolHint
+
+
+class PydanticSemanticLayerElementConfig(HashableBaseModel, ProtocolHint[SemanticLayerElementConfig]):
+    """PydanticDimension config."""
+
+    @override
+    def _implements_protocol(self) -> SemanticLayerElementConfig:  # noqa: D
+        return self
+
+    meta: Dict[str, Any] = Field(default_factory=dict)

dbt_semantic_interfaces/implementations/elements/dimension.py

@@ -6,6 +6,9 @@
     HashableBaseModel,
     ModelWithMetadataParsing,
 )
+from dbt_semantic_interfaces.implementations.element_config import (
+    PydanticSemanticLayerElementConfig,
+)
 from dbt_semantic_interfaces.implementations.metadata import PydanticMetadata
 from dbt_semantic_interfaces.references import (
     DimensionReference,
@@ -48,6 +51,7 @@ class PydanticDimension(HashableBaseModel, ModelWithMetadataParsing):
     expr: Optional[str] = None
     metadata: Optional[PydanticMetadata]
     label: Optional[str] = None
+    config: Optional[PydanticSemanticLayerElementConfig]
 
     @property
     def reference(self) -> DimensionReference:  # noqa: D

dbt_semantic_interfaces/implementations/elements/entity.py

@@ -6,6 +6,9 @@
     HashableBaseModel,
     ModelWithMetadataParsing,
 )
+from dbt_semantic_interfaces.implementations.element_config import (
+    PydanticSemanticLayerElementConfig,
+)
 from dbt_semantic_interfaces.implementations.metadata import PydanticMetadata
 from dbt_semantic_interfaces.references import EntityReference
 from dbt_semantic_interfaces.type_enums import EntityType
@@ -21,6 +24,7 @@ class PydanticEntity(HashableBaseModel, ModelWithMetadataParsing):
     expr: Optional[str] = None
     metadata: Optional[PydanticMetadata] = None
     label: Optional[str] = None
+    config: Optional[PydanticSemanticLayerElementConfig]
 
     @property
     def reference(self) -> EntityReference:  # noqa: D

dbt_semantic_interfaces/implementations/elements/measure.py

@@ -6,6 +6,9 @@
     HashableBaseModel,
     ModelWithMetadataParsing,
 )
+from dbt_semantic_interfaces.implementations.element_config import (
+    PydanticSemanticLayerElementConfig,
+)
 from dbt_semantic_interfaces.implementations.metadata import PydanticMetadata
 from dbt_semantic_interfaces.references import MeasureReference
 from dbt_semantic_interfaces.type_enums import AggregationType
@@ -46,6 +49,7 @@ class PydanticMeasure(HashableBaseModel, ModelWithMetadataParsing):
     non_additive_dimension: Optional[PydanticNonAdditiveDimensionParameters] = None
     agg_time_dimension: Optional[str] = None
     label: Optional[str] = None
+    config: Optional[PydanticSemanticLayerElementConfig] = None
 
     @property
     def reference(self) -> MeasureReference:  # noqa: D

dbt_semantic_interfaces/implementations/metric.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any, Dict, List, Optional, Sequence, Set
+from typing import Dict, List, Optional, Sequence, Set
 
 from typing_extensions import override
 
@@ -12,11 +12,14 @@
     PydanticCustomInputParser,
     PydanticParseableValueType,
 )
+from dbt_semantic_interfaces.implementations.element_config import (
+    PydanticSemanticLayerElementConfig,
+)
 from dbt_semantic_interfaces.implementations.filters.where_filter import (
     PydanticWhereFilterIntersection,
 )
 from dbt_semantic_interfaces.implementations.metadata import PydanticMetadata
-from dbt_semantic_interfaces.protocols import Metric, MetricConfig, ProtocolHint
+from dbt_semantic_interfaces.protocols import Metric, ProtocolHint
 from dbt_semantic_interfaces.references import MeasureReference, MetricReference
 from dbt_semantic_interfaces.type_enums import (
     ConversionCalculationType,
@@ -183,14 +186,6 @@ class PydanticMetricTypeParams(HashableBaseModel):
     input_measures: List[PydanticMetricInputMeasure] = Field(default_factory=list)
 
 
-class PydanticMetricConfig(HashableBaseModel, ProtocolHint[MetricConfig]):  # noqa: D
-    @override
-    def _implements_protocol(self) -> MetricConfig:  # noqa: D
-        return self
-
-    meta: Dict[str, Any] = Field(default_factory=dict)
-
-
 class PydanticMetric(HashableBaseModel, ModelWithMetadataParsing, ProtocolHint[Metric]):
     """Describes a metric."""
 
@@ -205,7 +200,7 @@ def _implements_protocol(self) -> Metric:  # noqa: D
     filter: Optional[PydanticWhereFilterIntersection]
     metadata: Optional[PydanticMetadata]
     label: Optional[str] = None
-    config: Optional[PydanticMetricConfig]
+    config: Optional[PydanticSemanticLayerElementConfig]
     time_granularity: Optional[TimeGranularity] = None
 
     @property

dbt_semantic_interfaces/implementations/semantic_model.py

@@ -1,13 +1,16 @@
 from __future__ import annotations
 
-from typing import Any, Dict, List, Optional, Sequence
+from typing import List, Optional, Sequence
 
 from typing_extensions import override
 
 from dbt_semantic_interfaces.implementations.base import (
     HashableBaseModel,
     ModelWithMetadataParsing,
 )
+from dbt_semantic_interfaces.implementations.element_config import (
+    PydanticSemanticLayerElementConfig,
+)
 from dbt_semantic_interfaces.implementations.elements.dimension import PydanticDimension
 from dbt_semantic_interfaces.implementations.elements.entity import PydanticEntity
 from dbt_semantic_interfaces.implementations.elements.measure import PydanticMeasure
@@ -16,7 +19,6 @@
 from dbt_semantic_interfaces.protocols import (
     ProtocolHint,
     SemanticModel,
-    SemanticModelConfig,
     SemanticModelDefaults,
 )
 from dbt_semantic_interfaces.references import (
@@ -38,14 +40,6 @@ def _implements_protocol(self) -> SemanticModelDefaults:  # noqa: D
     agg_time_dimension: Optional[str]
 
 
-class PydanticSemanticModelConfig(HashableBaseModel, ProtocolHint[SemanticModelConfig]):  # noqa: D
-    @override
-    def _implements_protocol(self) -> SemanticModelConfig:  # noqa: D
-        return self
-
-    meta: Dict[str, Any] = Field(default_factory=dict)
-
-
 class PydanticSemanticModel(HashableBaseModel, ModelWithMetadataParsing, ProtocolHint[SemanticModel]):
     """Describes a semantic model."""
 
@@ -65,7 +59,7 @@ def _implements_protocol(self) -> SemanticModel:
     label: Optional[str] = None
 
     metadata: Optional[PydanticMetadata]
-    config: Optional[PydanticSemanticModelConfig]
+    config: Optional[PydanticSemanticLayerElementConfig]
 
     @property
     def entity_references(self) -> List[LinkableElementReference]:  # noqa: D

dbt_semantic_interfaces/parsing/generated_json_schemas/default_explicit_schema.json

@@ -135,6 +135,19 @@
             ],
             "type": "object"
         },
+        "dimension_config_schema": {
+            "$id": "dimension_config_schema",
+            "additionalProperties": false,
+            "properties": {
+                "meta": {
+                    "propertyNames": {
+                        "type": "string"
+                    },
+                    "type": "object"
+                }
+            },
+            "type": "object"
+        },
         "dimension_schema": {
             "$id": "dimension_schema",
             "additionalProperties": false,
@@ -151,6 +164,9 @@
                 }
             ],
             "properties": {
+                "config": {
+                    "$ref": "#/definitions/dimension_config_schema"
+                },
                 "description": {
                     "type": "string"
                 },
@@ -227,10 +243,26 @@
             ],
             "type": "object"
         },
+        "entity_config_schema": {
+            "$id": "entity_config_schema",
+            "additionalProperties": false,
+            "properties": {
+                "meta": {
+                    "propertyNames": {
+                        "type": "string"
+                    },
+                    "type": "object"
+                }
+            },
+            "type": "object"
+        },
         "entity_schema": {
             "$id": "entity_schema",
             "additionalProperties": false,
             "properties": {
+                "config": {
+                    "$ref": "#/definitions/entity_config_schema"
+                },
                 "entity": {
                     "type": "string"
                 },
@@ -337,6 +369,19 @@
                 "type"
             ]
         },
+        "measure_config_schema": {
+            "$id": "measure_config_schema",
+            "additionalProperties": false,
+            "properties": {
+                "meta": {
+                    "propertyNames": {
+                        "type": "string"
+                    },
+                    "type": "object"
+                }
+            },
+            "type": "object"
+        },
         "measure_schema": {
             "$id": "measure_schema",
             "additionalProperties": false,
@@ -370,6 +415,9 @@
                     "pattern": "(?!.*__).*^[a-z][a-z0-9_]*[a-z0-9]$",
                     "type": "string"
                 },
+                "config": {
+                    "$ref": "#/definitions/measure_config_schema"
+                },
                 "create_metric": {
                     "type": "boolean"
                 },

dbt_semantic_interfaces/parsing/schemas.py

@@ -161,6 +161,16 @@
     "additionalProperties": False,
 }
 
+
+entity_config_schema = {
+    "$id": "entity_config_schema",
+    "type": "object",
+    "properties": {
+        "meta": {"type": "object", "propertyNames": {"type": "string"}},
+    },
+    "additionalProperties": False,
+}
+
 entity_schema = {
     "$id": "entity_schema",
     "type": "object",
@@ -174,6 +184,7 @@
         "expr": {"type": ["string", "boolean"]},
         "entity": {"type": "string"},
         "label": {"type": "string"},
+        "config": {"$ref": "entity_config_schema"},
     },
     "additionalProperties": False,
     "required": ["name", "type"],
@@ -226,6 +237,15 @@
     "additionalProperties": False,
 }
 
+measure_config_schema = {
+    "$id": "measure_config_schema",
+    "type": "object",
+    "properties": {
+        "meta": {"type": "object", "propertyNames": {"type": "string"}},
+    },
+    "additionalProperties": False,
+}
+
 measure_schema = {
     "$id": "measure_schema",
     "type": "object",
@@ -248,11 +268,21 @@
         },
         "description": {"type": "string"},
         "label": {"type": "string"},
+        "config": {"$ref": "measure_config_schema"},
     },
     "additionalProperties": False,
     "required": ["name", "agg"],
 }
 
+dimension_config_schema = {
+    "$id": "dimension_config_schema",
+    "type": "object",
+    "properties": {
+        "meta": {"type": "object", "propertyNames": {"type": "string"}},
+    },
+    "additionalProperties": False,
+}
+
 dimension_schema = {
     "$id": "dimension_schema",
     "type": "object",
@@ -267,6 +297,7 @@
         "expr": {"type": ["string", "boolean"]},
         "type_params": {"$ref": "dimension_type_params_schema"},
         "label": {"type": "string"},
+        "config": {"$ref": "dimension_config_schema"},
     },
     # dimension must have type_params if its a time dimension
     "anyOf": [{"not": {"$ref": "#/definitions/is-time-dimension"}}, {"required": ["type_params"]}],
@@ -529,6 +560,9 @@
     saved_query_query_params_schema["$id"]: saved_query_query_params_schema,
     semantic_model_config_schema["$id"]: semantic_model_config_schema,
     metric_config_schema["$id"]: metric_config_schema,
+    dimension_config_schema["$id"]: dimension_config_schema,
+    entity_config_schema["$id"]: entity_config_schema,
+    measure_config_schema["$id"]: measure_config_schema,
 }
 
 resources: List[Tuple[str, Resource]] = [(str(k), DRAFT7.create_resource(v)) for k, v in schema_store.items()]

dbt_semantic_interfaces/protocols/__init__.py

@@ -14,7 +14,6 @@
     ConstantPropertyInput,
     ConversionTypeParams,
     Metric,
-    MetricConfig,
     MetricInput,
     MetricInputMeasure,
     MetricTimeWindow,
@@ -28,7 +27,6 @@
 )
 from dbt_semantic_interfaces.protocols.semantic_model import (  # noqa:F401
     SemanticModel,
-    SemanticModelConfig,
     SemanticModelDefaults,
     SemanticModelT,
 )

dbt_semantic_interfaces/protocols/dimension.py

@@ -3,6 +3,7 @@
 from abc import abstractmethod
 from typing import Optional, Protocol
 
+from dbt_semantic_interfaces.protocols.meta import SemanticLayerElementConfig
 from dbt_semantic_interfaces.protocols.metadata import Metadata
 from dbt_semantic_interfaces.references import (
     DimensionReference,
@@ -107,3 +108,8 @@ def validity_params(self) -> Optional[DimensionValidityParams]:
     def label(self) -> Optional[str]:
         """Returns a string representing a human readable label for the dimension."""
         pass
+
+    @property
+    @abstractmethod
+    def config(self) -> Optional[SemanticLayerElementConfig]:  # noqa: D
+        pass