Support dbt 1.5+

Support dbt 1.5+ and plan to switch to using dbt-core contraints (see note in readme)

Note: dbt 1.5+ supports primary_key and foreign_key [constraints](https://docs.getdbt.com/reference/resource-properties/constraints). However, as of dbt-core v1.5.2, constraints require [contracts](https://docs.getdbt.com/reference/resource-configs/contract) to be enabled. The catch-22 is that contracts then require ALL model columns to define data_type, but data_type is database-specific, so you lose the incredible database agnostic features of dbt. For this reason, we use the [`dbt_constraints`](https://github.com/Snowflake-Labs/dbt_constraints) package to enable cross-database support for primary and foreign keys. The issue will be tracked [here](#11).

Author: ataft

README.md

@@ -252,6 +252,12 @@ models:
               field: customer_key
 ```
 
+Another way for tools to derive joins from dbt models is by defining primary and foreign keys. While many columnar databases (e.g. Snowflake) do not enfore referential integrity (primary and foreign keys), they can still be defined so that tools can pick them up. For traditional relational databases, it can be important to define primary and foreign keys for performance reasons as well.
+
+> Important: to use primary and foreign key constraints, set the dbt_project.yml variable "dbt_constraints_enabled: true"
+
+> Note: dbt 1.5+ supports primary_key and foreign_key [constraints](https://docs.getdbt.com/reference/resource-properties/constraints). However, as of dbt-core v1.5.2, constraints require [contracts](https://docs.getdbt.com/reference/resource-configs/contract) to be enabled. The catch-22 is that contracts then require ALL model columns to define data_type, but data_type is database-specific, so you lose the incredible database agnostic features of dbt. For this reason, we use the [`dbt_constraints`](https://github.com/Snowflake-Labs/dbt_constraints) package to enable cross-database support for primary and foreign keys. The issue will be tracked [here](https://github.com/flexanalytics/dbt-business-intelligence/issues/11).
+
 ### Data Freshness
 
 BI tools should use dbt's built in run/job update timestamps and [source freshness](https://docs.getdbt.com/reference/resource-properties/freshness) to display data freshness information to end users.
@@ -379,6 +385,9 @@ Here is a list of concepts that were covered in this repo.
   * [`dbt-date`](https://github.com/calogica/dbt-date#get_date_dimensionstart_date-end_date)
   * [`dbt-utils`](https://github.com/dbt-labs/dbt-utils)
   * [`dbt_constraints`](https://github.com/Snowflake-Labs/dbt_constraints)
+  * [`metrics`](https://github.com/dbt-labs/metrics)
+
+> **WARNING**: dbt_metrics is going to be deprecated in dbt-core 1.6 in July 2023 as part of the migration to MetricFlow. This package will continue to work with dbt-core 1.5 but a 1.6 version will not be released. If you have any questions, please join us in the #dbt-core-metrics in the dbt Community Slack.
 
 * **Jinja & Macros** - using [Jinja & Macros](https://docs.getdbt.com/docs/building-a-dbt-project/jinja-macros) to create re-usable code
 

macros/bigquery__create_constraints.sql

@@ -1,34 +1,34 @@
 {# BigQuery specific implementation to create a primary key #}
-{%- macro bigquery__create_primary_key(table_relation, column_names, verify_permissions, quote_columns=false) -%}
+{%- macro bigquery__create_primary_key(table_relation, column_names, verify_permissions, quote_columns=false, constraint_name=none, lookup_cache=none) -%}
     {#- TODO -#}
 {%- endmacro -%}
 
 
 
 {# BigQuery specific implementation to create a unique key #}
-{%- macro bigquery__create_unique_key(table_relation, column_names, verify_permissions, quote_columns=false) -%}
+{%- macro bigquery__create_unique_key(table_relation, column_names, verify_permissions, quote_columns=false, constraint_name=none, lookup_cache=none) -%}
     {#- TODO -#}
 {%- endmacro -%}
 
 
 
 {# BigQuery specific implementation to create a foreign key #}
-{%- macro bigquery__create_foreign_key(pk_table_relation, pk_column_names, fk_table_relation, fk_column_names, verify_permissions, quote_columns=true) -%}
+{%- macro bigquery__create_foreign_key(pk_table_relation, pk_column_names, fk_table_relation, fk_column_names, verify_permissions, quote_columns=true, constraint_name=none, lookup_cache=none) -%}
     {#- TODO -#}
 {%- endmacro -%}
 
 
 
 {#- This macro is used in create macros to avoid duplicate PK/UK constraints
     and to skip FK where no PK/UK constraint exists on the parent table -#}
-{%- macro bigquery__unique_constraint_exists(table_relation, column_names) -%}
+{%- macro bigquery__unique_constraint_exists(table_relation, column_names, lookup_cache=none) -%}
     {#- TODO -#}
 {%- endmacro -%}
 
 
 
 {#- This macro is used in create macros to avoid duplicate FK constraints -#}
-{%- macro bigquery__foreign_key_exists(table_relation, column_names) -%}
+{%- macro bigquery__foreign_key_exists(table_relation, column_names, lookup_cache=none) -%}
     {#- TODO -#}
 {%- endmacro -%}
 
@@ -51,6 +51,6 @@
     {#- TODO -#}
 {% endmacro %}
 
-{% macro bigquery__create_not_null() -%}
+{% macro bigquery__create_not_null(table_relation, column_names, verify_permissions, quote_columns=false, lookup_cache=none) -%}
     {#- TODO -#}
 {% endmacro %}

macros/sqlserver__create_constraints.sql

@@ -1,5 +1,5 @@
 {# SQL Server specific implementation to create a primary key #}
-{%- macro sqlserver__create_primary_key(table_relation, column_names, verify_permissions, quote_columns=false) -%}
+{%- macro sqlserver__create_primary_key(table_relation, column_names, verify_permissions, quote_columns=false, constraint_name=none, lookup_cache=none) -%}
     {%- set constraint_name = (table_relation.identifier ~ "_" ~ column_names|join('_') ~ "_PK") | upper -%}
 
     {%- if constraint_name|length > 63 %}
@@ -36,7 +36,7 @@
 
 
 {# SQL Server specific implementation to create a unique key #}
-{%- macro sqlserver__create_unique_key(table_relation, column_names, verify_permissions, quote_columns=false) -%}
+{%- macro sqlserver__create_unique_key(table_relation, column_names, verify_permissions, quote_columns=false, constraint_name=none, lookup_cache=none) -%}
     {%- set constraint_name = (table_relation.identifier ~ "_" ~ column_names|join('_') ~ "_UK") | upper -%}
 
     {%- if constraint_name|length > 63 %}
@@ -71,7 +71,7 @@
 {%- endmacro -%}
 
 {# SQL Server specific implementation to create a not null constraint #}
-{%- macro sqlserver__create_not_null(table_relation, column_names, verify_permissions, quote_columns=false) -%}
+{%- macro sqlserver__create_not_null(table_relation, column_names, verify_permissions, quote_columns=false, lookup_cache=none) -%}
     {%- set columns_list = dbt_constraints.get_quoted_column_list(column_names, quote_columns) -%}
 
     {%- if dbt_constraints.have_ownership_priv(table_relation, verify_permissions) -%}
@@ -93,7 +93,7 @@
 {%- endmacro -%}
 
 {# SQL Server specific implementation to create a foreign key #}
-{%- macro sqlserver__create_foreign_key(pk_table_relation, pk_column_names, fk_table_relation, fk_column_names, verify_permissions, quote_columns=true) -%}
+{%- macro sqlserver__create_foreign_key(pk_table_relation, pk_column_names, fk_table_relation, fk_column_names, verify_permissions, quote_columns=true, constraint_name=none, lookup_cache=none) -%}
     {%- set constraint_name = (fk_table_relation.identifier ~ "_" ~ fk_column_names|join('_') ~ "_FK") | upper -%}
 
     {%- if constraint_name|length > 63 %}
@@ -136,7 +136,7 @@
 
 {#- This macro is used in create macros to avoid duplicate PK/UK constraints
     and to skip FK where no PK/UK constraint exists on the parent table -#}
-{%- macro sqlserver__unique_constraint_exists(table_relation, column_names) -%}
+{%- macro sqlserver__unique_constraint_exists(table_relation, column_names, lookup_cache=none) -%}
     {%- set lookup_query -%}
     select c.oid as constraint_name
         , upper(col.attname) as column_name
@@ -170,7 +170,7 @@
 
 
 {#- This macro is used in create macros to avoid duplicate FK constraints -#}
-{%- macro sqlserver__foreign_key_exists(table_relation, column_names) -%}
+{%- macro sqlserver__foreign_key_exists(table_relation, column_names, lookup_cache=none) -%}
     {%- set lookup_query -%}
     select c.oid as fk_name
         , upper(col.attname) as fk_column_name

models/schema.yml

@@ -10,6 +10,12 @@ models:
             - order_key
             - product_key
             - date_key
+      - dbt_constraints.primary_key:
+          column_names:
+            - customer_key
+            - order_key
+            - product_key
+            - date_key
     meta:
       label: Sales Fact
       display_index: 1
@@ -85,6 +91,7 @@ models:
           hidden: true
         tests:
           - unique
+          - dbt_constraints.primary_key
       - name: customer_code
         meta:
           label: Customer Id
@@ -131,6 +138,7 @@ models:
           hidden: true
         tests:
           - unique
+          - dbt_constraints.primary_key
       - name: order_number
         meta:
           label: Order Number
@@ -160,6 +168,7 @@ models:
           hidden: true
         tests:
           - unique
+          - dbt_constraints.primary_key
       - name: product_code
         meta:
           label: Product Code
@@ -201,6 +210,7 @@ models:
           hidden: true
         tests:
           - unique
+          - dbt_constraints.primary_key
       - name: date_day
         meta:
           label: Order Date

packages.yml

@@ -2,7 +2,7 @@ packages:
   - package: calogica/dbt_date
     version: 0.6.2
   - package: dbt-labs/metrics
-    version: 1.4.1
+    version: 1.5.0
   - package: Snowflake-Labs/dbt_constraints
     version: 0.6.0
   - package: dbt-msft/tsql_utils