hotfix/pass-through-all-columns

[fivetran-joemarkiewicz]

PR Overview

This PR will address the following Issue/Feature: #99

This PR will result in the following new package version: v0.9.0

This is not a breaking change in particular, but will be batched with PR #98 which is a breaking change.

Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:

This PR includes the following changes:

• Addition of the get_columns_macro.sql macro that will be used when users define the hubspot__pass_through_all_columns variable to true.
  • The macro is designed to leverage the respective "get_[table]_columns" macro for the relevant models to return a list of strings of all columns in the macro.
  • This macro is required to ensure customers using the hubspot__pass_through_all_columns: true config will have all the required columns that are necessary for downstream transformations while also bringing in all the fields from their source.
• Updates to the CONTACT, COMPANY, DEAL, and TICKET staging models to ensure all required columns are included when a user defines the hubspot__pass_through_all_columns variable as true.
  • In order for the above to be successful, additional changes were required in the respective "get_[table]_columns" macros to alias the fields. This ensures consistency regardless of using the hubspot__pass_through_all_columns variable as defined as true or false.

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

• dbt compile
• dbt run –full-refresh
• dbt run
• dbt test
• dbt run –vars (if applicable)

Before marking this PR as “ready for review” the following have been applied:

• The appropriate issue has been linked and tagged
• You are assigned to the corresponding issue and this PR
• BuildKite integration tests are passing

Detailed Validation

Please acknowledge that the following validation checks have been performed prior to marking this PR as “ready for review”:

• You have validated these changes and assure this PR will address the respective Issue/Feature.
• You are reasonably confident these changes will not impact any other components of this package or any dependent packages.
• You have provided details below around the validation steps performed to gain confidence in these changes.

I validated that these fields returned appropriately using both the hubspot__pass_through_all_columns variable being set to true and false. Additionally, I was able to confirm that both variable declarations worked when paired with the downstream transformation. Additionally, I was able to validate that without these changes, the accompanying PR #98 fails if hubspot__pass_through_all_columns is defined as true. However, it is resolved with these changes.

See corresponding height ticket for more validation details.

Standard Updates

Please acknowledge that your PR contains the following standard updates:

• Package versioning has been appropriately indexed in the following locations:
  • indexed within dbt_project.yml
  • indexed within integration_tests/dbt_project.yml
• CHANGELOG has individual entries for each respective change in this PR
• README updates have been applied (if applicable)
• DECISIONLOG updates have been updated (if applicable)
• Appropriate yml documentation has been added (if applicable)

dbt Docs

Please acknowledge that after the above were all completed the below were applied to your branch:

• docs were regenerated (unless this PR does not include any code or yml updates)

If you had to summarize this PR in an emoji, which would it be?

🎣

[fivetran-jamie]

looks pretty good to me! left one comment

one additional question: can we add hubspot__pass_through_all_columns: true to one of the dbt run steps in buildkite?

[fivetran-jamie]

not pretty but it works (so this is approved)!

i had another idea though that would move this logic to the column macros...

what if in get_[table]_column macros, we did something like

{% macro get_deal_columns() %}

{% set columns = [
    {"name": "_fivetran_synced", "datatype": dbt.type_timestamp()},
    {"name": "deal_id", "datatype": dbt.type_int()},
    {"name": "deal_pipeline_id", "datatype": dbt.type_string()},
    {"name": "deal_pipeline_stage_id", "datatype": dbt.type_string()},
    {"name": "is_deleted", "datatype": "boolean"},
    {"name": "owner_id", "datatype": dbt.type_int()},
    {"name": "portal_id", "datatype": dbt.type_int()},
    {"name": "property_dealname", "datatype": dbt.type_string()},
    {"name": "property_description", "datatype": dbt.type_string()},
    {"name": "property_amount", "datatype": dbt.type_int()},
    {"name": "property_closedate", "datatype": dbt.type_timestamp()},
    {"name": "property_createdate", "datatype": dbt.type_timestamp()}
] %}

{{ fivetran_utils.add_pass_through_columns(columns, var('hubspot__deal_pass_through_columns')) }}

{% if var('hubspot__pass_through_all_columns', false) %} 
{% set source_columns = adapter.get_columns_in_relation(ref('stg_hubspot__deal_tmp')) %}

{% for sc in source_columns if sc.name not in columns.name %} -- not sure if that syntax works but you get the gist
{% do columns.append({"name": sc.name, "datatype": dbt.type_string}) %}
{% endfor %} 
{% endif %} 

{{ return(columns) }}

{% endmacro %}