Type aliasing for model contract column data_type

.changes/unreleased/Features-20230907-161831.yaml

@@ -0,0 +1,6 @@
+kind: Features
+body: Use translate_types on data_type in model.columns in templates
+time: 2023-09-07T16:18:31.428161-04:00
+custom:
+  Author: gshank
+  Issue: "8007"

core/dbt/adapters/base/column.py

@@ -7,12 +7,12 @@
 
 @dataclass
 class Column:
+    # Note: This is automatically used by contract code
+    # No-op conversions (INTEGER => INT) have been removed.
+    # Any adapter that wants to take advantage of "translate_type"
+    # should create a ClassVar with the appropriate conversions.
     TYPE_LABELS: ClassVar[Dict[str, str]] = {
         "STRING": "TEXT",
-        "TIMESTAMP": "TIMESTAMP",
-        "FLOAT": "FLOAT",
-        "INTEGER": "INT",
-        "BOOLEAN": "BOOLEAN",
     }
     column: str
     dtype: str

core/dbt/context/providers.py

@@ -1227,12 +1227,24 @@
 
     @contextproperty("model")
     def ctx_model(self) -> Dict[str, Any]:
-        ret = self.model.to_dict(omit_none=True)
+        model_dct = self.model.to_dict(omit_none=True)
         # Maintain direct use of compiled_sql
         # TODO add depreciation logic[CT-934]
-        if "compiled_code" in ret:
-            ret["compiled_sql"] = ret["compiled_code"]
-        return ret
+        if "compiled_code" in model_dct:
+            model_dct["compiled_sql"] = model_dct["compiled_code"]
+
+        if (
+            hasattr(self.model, "contract")
+            and self.model.contract.alias_types is True
+            and "columns" in model_dct
+        ):
+            for column in model_dct["columns"].values():
+                if "data_type" in column:
+                    orig_data_type = column["data_type"]
+                    # translate data_type to value in Column.TYPE_LABELS
+                    new_data_type = self.adapter.Column.translate_type(orig_data_type)
+                    column["data_type"] = new_data_type
+        return model_dct
 
     @contextproperty()
     def pre_hooks(self) -> Optional[List[Dict[str, Any]]]:

core/dbt/contracts/graph/model_config.py

@@ -202,6 +202,7 @@ def default(cls) -> "OnConfigurationChangeOption":
 @dataclass
 class ContractConfig(dbtClassMixin, Replaceable):
     enforced: bool = False
+    alias_types: bool = True
 
 
 @dataclass

core/dbt/contracts/graph/nodes.py

@@ -232,6 +232,7 @@ class ColumnInfo(AdditionalPropertiesMixin, ExtensibleDbtClassMixin, Replaceable
 @dataclass
 class Contract(dbtClassMixin, Replaceable):
     enforced: bool = False
+    alias_types: bool = True
     checksum: Optional[str] = None
 
 

core/dbt/parser/base.py

@@ -360,7 +360,9 @@ def update_parsed_node_config(
 
         # If we have contract in the config, copy to node level
         if "contract" in config_dict and config_dict["contract"]:
-            parsed_node.contract = Contract(enforced=config_dict["contract"]["enforced"])
+            contract_dct = config_dict["contract"]
+            Contract.validate(contract_dct)
+            parsed_node.contract = Contract.from_dict(contract_dct)
 
         # unrendered_config is used to compare the original database/schema/alias
         # values and to handle 'same_config' and 'same_contents' calls

schemas/dbt/manifest/v11.json

@@ -172,6 +172,10 @@
         "enforced": {
           "type": "boolean",
           "default": false
+        },
+        "alias_types": {
+          "type": "boolean",
+          "default": true
         }
       },
       "additionalProperties": false
@@ -560,6 +564,10 @@
           "type": "boolean",
           "default": false
         },
+        "alias_types": {
+          "type": "boolean",
+          "default": true
+        },
         "checksum": {
           "anyOf": [
             {

tests/functional/artifacts/expected_manifest.py

@@ -36,7 +36,7 @@ def get_rendered_model_config(**updates):
         "packages": [],
         "incremental_strategy": None,
         "docs": {"node_color": None, "show": True},
-        "contract": {"enforced": False},
+        "contract": {"enforced": False, "alias_types": True},
         "access": "protected",
     }
     result.update(updates)
@@ -72,7 +72,7 @@ def get_rendered_seed_config(**updates):
         "packages": [],
         "incremental_strategy": None,
         "docs": {"node_color": None, "show": True},
-        "contract": {"enforced": False},
+        "contract": {"enforced": False, "alias_types": True},
     }
     result.update(updates)
     return result
@@ -112,7 +112,7 @@ def get_rendered_snapshot_config(**updates):
         "packages": [],
         "incremental_strategy": None,
         "docs": {"node_color": None, "show": True},
-        "contract": {"enforced": False},
+        "contract": {"enforced": False, "alias_types": True},
     }
     result.update(updates)
     return result
@@ -328,7 +328,7 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False):
                         "constraints": [],
                     },
                 },
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "constraints": [],
                 "patch_path": "test://" + model_schema_yml_path,
                 "docs": {"node_color": None, "show": False},
@@ -421,7 +421,7 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False):
                         "constraints": [],
                     },
                 },
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "constraints": [],
                 "patch_path": "test://" + model_schema_yml_path,
                 "docs": {"node_color": None, "show": False},
@@ -564,7 +564,7 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False):
                 },
                 "checksum": {"name": "none", "checksum": ""},
                 "unrendered_config": unrendered_test_config,
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
             },
             "snapshot.test.snapshot_seed": {
                 "alias": "snapshot_seed",
@@ -576,7 +576,7 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False):
                 "compiled": True,
                 "compiled_code": ANY,
                 "config": snapshot_config,
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "database": project.database,
                 "group": None,
                 "deferred": False,
@@ -625,7 +625,7 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False):
                 "columns": {},
                 "config": test_config,
                 "group": None,
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {
                     "macros": ["macro.test.test_nothing", "macro.dbt.get_where_subquery"],
@@ -678,7 +678,7 @@ def expected_seeded_manifest(project, model_database=None, quote_model=False):
                 "columns": {},
                 "config": test_config,
                 "group": None,
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {
                     "macros": ["macro.dbt.test_unique", "macro.dbt.get_where_subquery"],
@@ -949,7 +949,7 @@ def expected_references_manifest(project):
                 "unique_id": "model.test.ephemeral_copy",
                 "compiled": True,
                 "compiled_code": ANY,
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "extra_ctes_injected": True,
                 "extra_ctes": [],
                 "checksum": checksum_file(ephemeral_copy_path),
@@ -985,7 +985,7 @@ def expected_references_manifest(project):
                     },
                 },
                 "config": get_rendered_model_config(materialized="table", group="test_group"),
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {
                     "macros": [],
@@ -1054,7 +1054,7 @@ def expected_references_manifest(project):
                     },
                 },
                 "config": get_rendered_model_config(),
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "database": project.database,
                 "depends_on": {
                     "macros": [],
@@ -1178,7 +1178,7 @@ def expected_references_manifest(project):
                 "compiled": True,
                 "compiled_code": ANY,
                 "config": get_rendered_snapshot_config(target_schema=alternate_schema),
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "database": model_database,
                 "deferred": False,
                 "depends_on": {"macros": [], "nodes": ["seed.test.seed"]},
@@ -1533,7 +1533,7 @@ def expected_versions_manifest(project):
                 "unique_id": "model.test.versioned_model.v1",
                 "compiled": True,
                 "compiled_code": ANY,
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "extra_ctes_injected": True,
                 "extra_ctes": [],
                 "checksum": checksum_file(versioned_model_v1_path),
@@ -1575,7 +1575,7 @@ def expected_versions_manifest(project):
                     materialized="view", group="test_group", meta={"size": "large", "color": "red"}
                 ),
                 "constraints": [],
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {"macros": [], "nodes": []},
                 "deferred": False,
@@ -1622,7 +1622,7 @@ def expected_versions_manifest(project):
                 "columns": {},
                 "config": get_rendered_model_config(),
                 "constraints": [],
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "database": project.database,
                 "depends_on": {
                     "macros": [],
@@ -1683,7 +1683,7 @@ def expected_versions_manifest(project):
                 "columns": {},
                 "config": test_config,
                 "group": "test_group",
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {
                     "macros": ["macro.dbt.test_unique", "macro.dbt.get_where_subquery"],
@@ -1737,7 +1737,7 @@ def expected_versions_manifest(project):
                 "columns": {},
                 "config": test_config,
                 "group": "test_group",
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {
                     "macros": ["macro.dbt.test_unique", "macro.dbt.get_where_subquery"],
@@ -1791,7 +1791,7 @@ def expected_versions_manifest(project):
                 "columns": {},
                 "config": test_config,
                 "group": "test_group",
-                "contract": {"checksum": None, "enforced": False},
+                "contract": {"checksum": None, "enforced": False, "alias_types": True},
                 "sources": [],
                 "depends_on": {
                     "macros": ["macro.dbt.test_unique", "macro.dbt.get_where_subquery"],

tests/functional/configs/test_contract_configs.py

@@ -104,7 +104,33 @@ def model(dbt, _):
         tests:
           - unique
       - name: color
-        data_type: text
+        data_type: string
+      - name: date_day
+        data_type: date
+"""
+
+model_schema_alias_types_false_yml = """
+version: 2
+models:
+  - name: my_model
+    config:
+      contract:
+        enforced: true
+        alias_types: false
+    columns:
+      - name: id
+        quote: true
+        data_type: integer
+        description: hello
+        constraints:
+            - type: not_null
+            - type: primary_key
+            - type: check
+              expression: (id > 0)
+        tests:
+          - unique
+      - name: color
+        data_type: string
       - name: date_day
         data_type: date
 """
@@ -251,7 +277,7 @@ def test__model_contract_true(self, project):
 
         assert contract_actual_config.enforced is True
 
-        expected_columns = "{'id': ColumnInfo(name='id', description='hello', meta={}, data_type='integer', constraints=[ColumnLevelConstraint(type=<ConstraintType.not_null: 'not_null'>, name=None, expression=None, warn_unenforced=True, warn_unsupported=True), ColumnLevelConstraint(type=<ConstraintType.primary_key: 'primary_key'>, name=None, expression=None, warn_unenforced=True, warn_unsupported=True), ColumnLevelConstraint(type=<ConstraintType.check: 'check'>, name=None, expression='(id > 0)', warn_unenforced=True, warn_unsupported=True)], quote=True, tags=[], _extra={}), 'color': ColumnInfo(name='color', description='', meta={}, data_type='text', constraints=[], quote=None, tags=[], _extra={}), 'date_day': ColumnInfo(name='date_day', description='', meta={}, data_type='date', constraints=[], quote=None, tags=[], _extra={})}"
+        expected_columns = "{'id': ColumnInfo(name='id', description='hello', meta={}, data_type='integer', constraints=[ColumnLevelConstraint(type=<ConstraintType.not_null: 'not_null'>, name=None, expression=None, warn_unenforced=True, warn_unsupported=True), ColumnLevelConstraint(type=<ConstraintType.primary_key: 'primary_key'>, name=None, expression=None, warn_unenforced=True, warn_unsupported=True), ColumnLevelConstraint(type=<ConstraintType.check: 'check'>, name=None, expression='(id > 0)', warn_unenforced=True, warn_unsupported=True)], quote=True, tags=[], _extra={}), 'color': ColumnInfo(name='color', description='', meta={}, data_type='string', constraints=[], quote=None, tags=[], _extra={}), 'date_day': ColumnInfo(name='date_day', description='', meta={}, data_type='date', constraints=[], quote=None, tags=[], _extra={})}"
 
         assert expected_columns == str(my_model_columns)
 
@@ -264,6 +290,15 @@ def test__model_contract_true(self, project):
             == cleaned_code
         )
 
+        # set alias_types to false (should fail to compile)
+        write_file(
+            model_schema_alias_types_false_yml,
+            project.project_root,
+            "models",
+            "constraints_schema.yml",
+        )
+        run_dbt(["run"], expect_pass=False)
+
 
 class TestProjectContractEnabledConfigs:
     @pytest.fixture(scope="class")