Add meta to SemanticModels

.changes/unreleased/Features-20230929-170945.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Add meta attribute to SemanticModels
+time: 2023-09-29T17:09:45.0354-05:00
+custom:
+  Author: emmyoop
+  Issue: "8511"

core/dbt/contracts/graph/model_config.py

@@ -382,6 +382,10 @@ class SemanticModelConfig(BaseConfig):
         default=None,
         metadata=CompareBehavior.Exclude.meta(),
     )
+    meta: Dict[str, Any] = field(
+        default_factory=dict,
+        metadata=MergeBehavior.Update.meta(),
+    )
 
 
 @dataclass

core/dbt/contracts/graph/nodes.py

@@ -1583,6 +1583,7 @@ class SemanticModel(GraphNode):
     refs: List[RefArgs] = field(default_factory=list)
     created_at: float = field(default_factory=lambda: time.time())
     config: SemanticModelConfig = field(default_factory=SemanticModelConfig)
+    meta: Dict[str, Any] = field(default_factory=dict)
     unrendered_config: Dict[str, Any] = field(default_factory=dict)
     primary_entity: Optional[str] = None
     group: Optional[str] = None

core/dbt/contracts/graph/unparsed.py

@@ -712,6 +712,7 @@ class UnparsedSemanticModel(dbtClassMixin):
     name: str
     model: str  # looks like "ref(...)"
     config: Dict[str, Any] = field(default_factory=dict)
+    meta: Dict[str, Any] = field(default_factory=dict)
     description: Optional[str] = None
     label: Optional[str] = None
     defaults: Optional[Defaults] = None

core/dbt/parser/schema_yaml_readers.py

@@ -549,6 +549,7 @@ def _generate_semantic_model_config(
             base=False,
             patch_config_dict=precedence_configs,
         )
+
         return config
 
     def parse_semantic_model(self, unparsed: UnparsedSemanticModel):
@@ -595,8 +596,14 @@ def parse_semantic_model(self, unparsed: UnparsedSemanticModel):
             config=config,
             unrendered_config=unrendered_config,
             group=config.group,
+            meta=unparsed.meta,
         )
 
+        # If we have meta in the config, copy to node level, for backwards
+        # compatibility with earlier node-only config.
+        if "meta" in config and config["meta"]:
+            parsed.meta = config["meta"]
+
         ctx = generate_parse_semantic_models(
             parsed,
             self.root_project,

schemas/dbt/manifest/v11.json

@@ -5497,6 +5497,12 @@
             }
           ],
           "default": null
+        },
+        "meta": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          }
         }
       },
       "additionalProperties": true
@@ -5635,6 +5641,12 @@
         "config": {
           "$ref": "#/$defs/SemanticModelConfig"
         },
+        "meta": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          }
+        },
         "unrendered_config": {
           "type": "object",
           "propertyNames": {

tests/functional/semantic_models/fixtures.py

@@ -134,6 +134,9 @@
     config:
       enabled: true
       group: some_group
+      meta:
+        my_meta: 'testing'
+        my_other_meta: 'testing more'
     dimensions:
       - name: favorite_color
         type: categorical
@@ -185,6 +188,7 @@
       agg_time_dimension: created_at
 """
 
+
 schema_yml = """models:
   - name: fct_revenue
     description: This is the model fct_revenue. It should be able to use doc blocks

tests/functional/semantic_models/test_semantic_model_configs.py

@@ -204,3 +204,26 @@ def test_project_plus_yaml_level(self, project):
         ).config
 
         assert isinstance(config_test_table, SemanticModelConfig)
+
+
+# test setting meta attributes in semantic model config
+class TestMetaConfig:
+    @pytest.fixture(scope="class")
+    def models(self):
+        return {
+            "people.sql": models_people_sql,
+            "metricflow_time_spine.sql": metricflow_time_spine_sql,
+            "semantic_models.yml": enabled_semantic_model_people_yml,
+            "people_metrics.yml": models_people_metrics_yml,
+            "groups.yml": groups_yml,
+        }
+
+    def test_meta_config(self, project):
+        run_dbt(["parse"])
+        manifest = get_manifest(project.project_root)
+        sm_id = "semantic_model.test.semantic_people"
+        assert sm_id in manifest.semantic_models
+        sm_node = manifest.semantic_models[sm_id]
+        meta_expected = {"my_meta": "testing", "my_other_meta": "testing more"}
+        assert sm_node.meta == meta_expected
+        assert sm_node.config.meta == meta_expected