Lift + shift for cross-db macros

.changes/unreleased/Features-20220518-114604.yaml

@@ -0,0 +1,7 @@
+kind: Features
+body: Move cross-db macros from dbt-utils into dbt-core global project
+time: 2022-05-18T11:46:04.557104+02:00
+custom:
+  Author: jtcohen6 dbeatty10
+  Issue: "4813"
+  PR: "5265"

core/dbt/include/global_project/macros/utils/any_value.sql

@@ -0,0 +1,9 @@
+{% macro any_value(expression) -%}
+    {{ return(adapter.dispatch('any_value', 'dbt') (expression)) }}
+{% endmacro %}
+
+{% macro default__any_value(expression) -%}
+
+    any_value({{ expression }})
+
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/bool_or.sql

@@ -0,0 +1,9 @@
+{% macro bool_or(expression) -%}
+    {{ return(adapter.dispatch('bool_or', 'dbt') (expression)) }}
+{% endmacro %}
+
+{% macro default__bool_or(expression) -%}
+
+    bool_or({{ expression }})
+
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/cast_bool_to_text.sql

@@ -0,0 +1,7 @@
+{% macro cast_bool_to_text(field) %}
+  {{ adapter.dispatch('cast_bool_to_text', 'dbt') (field) }}
+{% endmacro %}
+
+{% macro default__cast_bool_to_text(field) %}
+    cast({{ field }} as {{ api.Column.translate_type('string') }})
+{% endmacro %}

core/dbt/include/global_project/macros/utils/concat.sql

@@ -0,0 +1,7 @@
+{% macro concat(fields) -%}
+  {{ return(adapter.dispatch('concat', 'dbt')(fields)) }}
+{%- endmacro %}
+
+{% macro default__concat(fields) -%}
+    {{ fields|join(' || ') }}
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/date_trunc.sql

@@ -0,0 +1,7 @@
+{% macro date_trunc(datepart, date) -%}
+  {{ return(adapter.dispatch('date_trunc', 'dbt') (datepart, date)) }}
+{%- endmacro %}
+
+{% macro default__date_trunc(datepart, date) -%}
+    date_trunc('{{datepart}}', {{date}})
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/dateadd.sql

@@ -0,0 +1,14 @@
+{% macro dateadd(datepart, interval, from_date_or_timestamp) %}
+  {{ return(adapter.dispatch('dateadd', 'dbt')(datepart, interval, from_date_or_timestamp)) }}
+{% endmacro %}
+
+
+{% macro default__dateadd(datepart, interval, from_date_or_timestamp) %}
+
+    dateadd(
+        {{ datepart }},
+        {{ interval }},
+        {{ from_date_or_timestamp }}
+        )
+
+{% endmacro %}

core/dbt/include/global_project/macros/utils/datediff.sql

@@ -0,0 +1,14 @@
+{% macro datediff(first_date, second_date, datepart) %}
+  {{ return(adapter.dispatch('datediff', 'dbt')(first_date, second_date, datepart)) }}
+{% endmacro %}
+
+
+{% macro default__datediff(first_date, second_date, datepart) -%}
+
+    datediff(
+        {{ datepart }},
+        {{ first_date }},
+        {{ second_date }}
+        )
+
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/escape_single_quotes.sql

@@ -0,0 +1,8 @@
+{% macro escape_single_quotes(expression) %}
+      {{ return(adapter.dispatch('escape_single_quotes', 'dbt') (expression)) }}
+{% endmacro %}
+
+{# /*Default to replacing a single apostrophe with two apostrophes: they're -> they''re*/ #}
+{% macro default__escape_single_quotes(expression) -%}
+{{ expression | replace("'","''") }}
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/except.sql

@@ -0,0 +1,9 @@
+{% macro except() %}
+  {{ return(adapter.dispatch('except', 'dbt')()) }}
+{% endmacro %}
+
+{% macro default__except() %}
+
+    except
+
+{% endmacro %}

core/dbt/include/global_project/macros/utils/hash.sql

@@ -0,0 +1,7 @@
+{% macro hash(field) -%}
+  {{ return(adapter.dispatch('hash', 'dbt') (field)) }}
+{%- endmacro %}
+
+{% macro default__hash(field) -%}
+    md5(cast({{ field }} as {{ api.Column.translate_type('string') }}))
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/intersect.sql

@@ -0,0 +1,9 @@
+{% macro intersect() %}
+  {{ return(adapter.dispatch('intersect', 'dbt')()) }}
+{% endmacro %}
+
+{% macro default__intersect() %}
+
+    intersect
+
+{% endmacro %}

core/dbt/include/global_project/macros/utils/last_day.sql

@@ -0,0 +1,15 @@
+{% macro last_day(date, datepart) %}
+  {{ return(adapter.dispatch('last_day', 'dbt') (date, datepart)) }}
+{% endmacro %}
+
+{%- macro default_last_day(date, datepart) -%}
+    cast(
+        {{dbt.dateadd('day', '-1',
+        dbt.dateadd(datepart, '1', dbt.date_trunc(datepart, date))
+        )}}
+        as date)
+{%- endmacro -%}
+
+{% macro default__last_day(date, datepart) -%}
+    {{dbt.default_last_day(date, datepart)}}
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/length.sql

@@ -0,0 +1,11 @@
+{% macro length(expression) -%}
+    {{ return(adapter.dispatch('length', 'dbt') (expression)) }}
+{% endmacro %}
+
+{% macro default__length(expression) %}
+
+    length(
+        {{ expression }}
+    )
+
+{%- endmacro -%}

core/dbt/include/global_project/macros/utils/listagg.sql

@@ -0,0 +1,30 @@
+{% macro listagg(measure, delimiter_text="','", order_by_clause=none, limit_num=none) -%}
+    {{ return(adapter.dispatch('listagg', 'dbt') (measure, delimiter_text, order_by_clause, limit_num)) }}
+{%- endmacro %}
+
+{% macro default__listagg(measure, delimiter_text, order_by_clause, limit_num) -%}
+
+    {% if limit_num -%}
+    array_to_string(
+        array_slice(
+            array_agg(
+                {{ measure }}
+            ){% if order_by_clause -%}
+            within group ({{ order_by_clause }})
+            {%- endif %}
+            ,0
+            ,{{ limit_num }}
+        ),
+        {{ delimiter_text }}
+        )
+    {%- else %}
+    listagg(
+        {{ measure }},
+        {{ delimiter_text }}
+        )
+        {% if order_by_clause -%}
+        within group ({{ order_by_clause }})
+        {%- endif %}
+    {%- endif %}
+
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/literal.sql

@@ -0,0 +1,7 @@
+{%- macro string_literal(value) -%}
+  {{ return(adapter.dispatch('string_literal', 'dbt') (value)) }}
+{%- endmacro -%}
+
+{% macro default__string_literal(value) -%}
+    '{{ value }}'
+{%- endmacro %}

core/dbt/include/global_project/macros/utils/position.sql

@@ -0,0 +1,11 @@
+{% macro position(substring_text, string_text) -%}
+    {{ return(adapter.dispatch('position', 'dbt') (substring_text, string_text)) }}
+{% endmacro %}
+
+{% macro default__position(substring_text, string_text) %}
+
+    position(
+        {{ substring_text }} in {{ string_text }}
+    )
+
+{%- endmacro -%}

core/dbt/include/global_project/macros/utils/replace.sql

@@ -0,0 +1,14 @@
+{% macro replace(field, old_chars, new_chars) -%}
+    {{ return(adapter.dispatch('replace', 'dbt') (field, old_chars, new_chars)) }}
+{% endmacro %}
+
+{% macro default__replace(field, old_chars, new_chars) %}
+
+    replace(
+        {{ field }},
+        {{ old_chars }},
+        {{ new_chars }}
+    )
+
+
+{% endmacro %}

core/dbt/include/global_project/macros/utils/right.sql

@@ -0,0 +1,12 @@
+{% macro right(string_text, length_expression) -%}
+    {{ return(adapter.dispatch('right', 'dbt') (string_text, length_expression)) }}
+{% endmacro %}
+
+{% macro default__right(string_text, length_expression) %}
+
+    right(
+        {{ string_text }},
+        {{ length_expression }}
+    )
+
+{%- endmacro -%}

core/dbt/include/global_project/macros/utils/safe_cast.sql

@@ -0,0 +1,9 @@
+{% macro safe_cast(field, type) %}
+  {{ return(adapter.dispatch('safe_cast', 'dbt') (field, type)) }}
+{% endmacro %}
+
+{% macro default__safe_cast(field, type) %}
+    {# most databases don't support this function yet
+    so we just need to use cast #}
+    cast({{field}} as {{type}})
+{% endmacro %}

core/dbt/include/global_project/macros/utils/split_part.sql

@@ -0,0 +1,26 @@
+{% macro split_part(string_text, delimiter_text, part_number) %}
+  {{ return(adapter.dispatch('split_part', 'dbt') (string_text, delimiter_text, part_number)) }}
+{% endmacro %}
+
+{% macro default__split_part(string_text, delimiter_text, part_number) %}
+
+    split_part(
+        {{ string_text }},
+        {{ delimiter_text }},
+        {{ part_number }}
+        )
+
+{% endmacro %}
+
+{% macro _split_part_negative(string_text, delimiter_text, part_number) %}
+
+    split_part(
+        {{ string_text }},
+        {{ delimiter_text }},
+          length({{ string_text }})
+          - length(
+              replace({{ string_text }},  {{ delimiter_text }}, '')
+          ) + 2 {{ part_number }}
+        )
+
+{% endmacro %}

plugins/postgres/dbt/include/postgres/macros/utils/any_value.sql

@@ -0,0 +1,7 @@
+{#- /*Postgres doesn't support any_value, so we're using min() to get the same result*/ -#}
+
+{% macro postgres__any_value(expression) -%}
+
+    min({{ expression }})
+
+{%- endmacro %}

plugins/postgres/dbt/include/postgres/macros/utils/dateadd.sql

@@ -0,0 +1,5 @@
+{% macro postgres__dateadd(datepart, interval, from_date_or_timestamp) %}
+
+    {{ from_date_or_timestamp }} + ((interval '1 {{ datepart }}') * ({{ interval }}))
+
+{% endmacro %}

plugins/postgres/dbt/include/postgres/macros/utils/datediff.sql

@@ -0,0 +1,32 @@
+{% macro postgres__datediff(first_date, second_date, datepart) -%}
+
+    {% if datepart == 'year' %}
+        (date_part('year', ({{second_date}})::date) - date_part('year', ({{first_date}})::date))
+    {% elif datepart == 'quarter' %}
+        ({{ datediff(first_date, second_date, 'year') }} * 4 + date_part('quarter', ({{second_date}})::date) - date_part('quarter', ({{first_date}})::date))
+    {% elif datepart == 'month' %}
+        ({{ datediff(first_date, second_date, 'year') }} * 12 + date_part('month', ({{second_date}})::date) - date_part('month', ({{first_date}})::date))
+    {% elif datepart == 'day' %}
+        (({{second_date}})::date - ({{first_date}})::date)
+    {% elif datepart == 'week' %}
+        ({{ datediff(first_date, second_date, 'day') }} / 7 + case
+            when date_part('dow', ({{first_date}})::timestamp) <= date_part('dow', ({{second_date}})::timestamp) then
+                case when {{first_date}} <= {{second_date}} then 0 else -1 end
+            else
+                case when {{first_date}} <= {{second_date}} then 1 else 0 end
+        end)
+    {% elif datepart == 'hour' %}
+        ({{ datediff(first_date, second_date, 'day') }} * 24 + date_part('hour', ({{second_date}})::timestamp) - date_part('hour', ({{first_date}})::timestamp))
+    {% elif datepart == 'minute' %}
+        ({{ datediff(first_date, second_date, 'hour') }} * 60 + date_part('minute', ({{second_date}})::timestamp) - date_part('minute', ({{first_date}})::timestamp))
+    {% elif datepart == 'second' %}
+        ({{ datediff(first_date, second_date, 'minute') }} * 60 + floor(date_part('second', ({{second_date}})::timestamp)) - floor(date_part('second', ({{first_date}})::timestamp)))
+    {% elif datepart == 'millisecond' %}
+        ({{ datediff(first_date, second_date, 'minute') }} * 60000 + floor(date_part('millisecond', ({{second_date}})::timestamp)) - floor(date_part('millisecond', ({{first_date}})::timestamp)))
+    {% elif datepart == 'microsecond' %}
+        ({{ datediff(first_date, second_date, 'minute') }} * 60000000 + floor(date_part('microsecond', ({{second_date}})::timestamp)) - floor(date_part('microsecond', ({{first_date}})::timestamp)))
+    {% else %}
+        {{ exceptions.raise_compiler_error("Unsupported datepart for macro datediff in postgres: {!r}".format(datepart)) }}
+    {% endif %}
+
+{%- endmacro %}

plugins/postgres/dbt/include/postgres/macros/utils/last_day.sql

@@ -0,0 +1,14 @@
+{% macro postgres__last_day(date, datepart) -%}
+
+    {%- if datepart == 'quarter' -%}
+    -- postgres dateadd does not support quarter interval.
+    cast(
+        {{dbt.dateadd('day', '-1',
+        dbt.dateadd('month', '3', dbt.date_trunc(datepart, date))
+        )}}
+        as date)
+    {%- else -%}
+    {{dbt.default_last_day(date, datepart)}}
+    {%- endif -%}
+
+{%- endmacro %}

plugins/postgres/dbt/include/postgres/macros/utils/listagg.sql

@@ -0,0 +1,23 @@
+{% macro postgres__listagg(measure, delimiter_text, order_by_clause, limit_num) -%}
+
+    {% if limit_num -%}
+    array_to_string(
+        (array_agg(
+            {{ measure }}
+            {% if order_by_clause -%}
+            {{ order_by_clause }}
+            {%- endif %}
+        ))[1:{{ limit_num }}],
+        {{ delimiter_text }}
+        )
+    {%- else %}
+    string_agg(
+        {{ measure }},
+        {{ delimiter_text }}
+        {% if order_by_clause -%}
+        {{ order_by_clause }}
+        {%- endif %}
+        )
+    {%- endif %}
+
+{%- endmacro %}

plugins/postgres/dbt/include/postgres/macros/utils/split_part.sql

@@ -0,0 +1,9 @@
+{% macro postgres__split_part(string_text, delimiter_text, part_number) %}
+
+  {% if part_number >= 0 %}
+    {{ dbt.default__split_part(string_text, delimiter_text, part_number) }}
+  {% else %}
+    {{ dbt._split_part_negative(string_text, delimiter_text, part_number) }}
+  {% endif %}
+
+{% endmacro %}

tests/adapter/dbt/tests/adapter/utils/base_utils.py

@@ -0,0 +1,33 @@
+import pytest
+from dbt.tests.util import run_dbt
+
+macros__test_assert_equal_sql = """
+{% test assert_equal(model, actual, expected) %}
+select * from {{ model }} where {{ actual }} != {{ expected }}
+
+{% endtest %}
+"""
+
+
+class BaseUtils:
+    # setup
+    @pytest.fixture(scope="class")
+    def macros(self):
+        return {"test_assert_equal.sql": macros__test_assert_equal_sql}
+
+    # make it possible to dynamically update the macro call with a namespace
+    # (e.g.) 'dateadd', 'dbt.dateadd', 'dbt_utils.dateadd'
+    def macro_namespace(self):
+        return ""
+
+    def interpolate_macro_namespace(self, model_sql, macro_name):
+        macro_namespace = self.macro_namespace()
+        return (
+            model_sql.replace(f"{macro_name}(", f"{macro_namespace}.{macro_name}(")
+            if macro_namespace
+            else model_sql
+        )
+
+    # actual test sequence
+    def test_build_assert_equal(self, project):
+        run_dbt(["build"])  # seed, model, test