Add RelationConfig Protocol for use in Relation.create_from #9210

MichelleArk · 2023-12-05T06:03:35Z

resolves #9215

Problem

Solution

Introduces RelationConfigProtocol
This protocol is used to consolidate Relation.create_from, removing the need to have NodeType-based create_from_node and create_from_source

Checklist

I have read the contributing guide and understand what's expected of me
I have run this code in development and it appears to resolve the stated issue
This PR includes tests, or tests are not required/relevant for this PR
This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX
This PR includes type annotations for new and modified functions

github-actions · 2023-12-05T06:03:49Z

Thank you for your pull request! We could not find a changelog entry for this change. For details on how to document a change, see the contributing guide.

codecov · 2023-12-05T06:06:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ed8f5d3) 86.58% compared to head (7ad1acc) 86.61%.

Additional details and impacted files

@@                           Coverage Diff                           @@
##           feature/decouple-adapters-from-core    dbt-labs/dbt-core#9210      +/-   ##
=======================================================================
+ Coverage                                86.58%   86.61%   +0.03%     
=======================================================================
  Files                                      215      215              
  Lines                                    26880    26856      -24     
=======================================================================
- Hits                                     23274    23262      -12     
+ Misses                                    3606     3594      -12

Flag	Coverage Δ
integration	`83.53% <100.00%> (+0.05%)`	⬆️
unit	`65.19% <71.42%> (-0.11%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

MichelleArk · 2023-12-05T08:03:35Z

After this PR, remaining core imports in dbt/adapters:

❯ python3 scripts/migrate-adapters.py core/dbt/adapters

core/dbt/adapters/protocol.py:
  - dbt.contracts.graph.model_config::BaseConfig
  - dbt.contracts.graph.manifest::Manifest

core/dbt/adapters/factory.py:
  - dbt.mp_context::get_mp_context

core/dbt/adapters/base/connections.py:
  - dbt.contracts.graph.manifest::Manifest

core/dbt/adapters/base/query_headers.py:
  - dbt.context.manifest::generate_query_header_context
  - dbt.contracts.graph.nodes::ResultNode
  - dbt.contracts.graph.manifest::Manifest

core/dbt/adapters/base/impl.py:
  - dbt.contracts.graph.manifest::Manifest
  - dbt.contracts.graph.manifest::MacroManifest
  - dbt.contracts.graph.nodes::ResultNode

migration progress: 95.82% of dbt imports are valid (from adapters or common)
remaining core imports: 10

MichelleArk · 2023-12-05T08:11:18Z

core/dbt/adapters/contracts/relation.py

+class RelationConfig(Protocol):
+    name: str
+    database: str
+    schema: str
+    identifier: str
+    quoting_dict: Dict[str, bool]


we may want to include meta or tags to accommodate adapter-specific implementations, for example in dbt-duckdb: https://github.com/duckdb/dbt-duckdb/blob/master/dbt/adapters/duckdb/relation.py#L11

But these are the attributes necessary for core <> adapters + postgres. Have carved out an issue to add additional fields later on: https://github.com/dbt-labs/dbt-core/issues/9216

MichelleArk · 2023-12-05T08:12:56Z

core/dbt/adapters/base/impl.py

@@ -476,7 +476,7 @@ def _get_catalog_relations(self, manifest: Manifest) -> List[BaseRelation]:
            manifest.sources.values(),
        )

-        relations = [self.Relation.create_from(self.config, n) for n in nodes]
+        relations = [self.Relation.create_from(self.config, n) for n in nodes]  # type: ignore[arg-type]


this gets cleaned up in: #9212

MichelleArk · 2023-12-05T08:13:10Z

core/dbt/adapters/base/impl.py

@@ -429,7 +429,7 @@ def _get_cache_schemas(self, manifest: Manifest) -> Set[BaseRelation]:
        """
        # the cache only cares about executable nodes
        return {
-            self.Relation.create_from(self.config, node).without_identifier()
+            self.Relation.create_from(self.config, node).without_identifier()  # type: ignore[arg-type]


this gets cleaned up in: #9213

core/dbt/adapters/base/relation.py

…te-from-refactor

* remove dbt.contracts.connection imports from adapter module * Move events to common (#8676) * Move events to common * More Type Annotations (#8536) * Extend use of type annotations in the events module. * Add return type of None to more __init__ definitions. * Still more type annotations adding -> None to __init__ * Tweak per review * Allow adapters to include python package logging in dbt logs (#8643) * add set_package_log_level functionality * set package handler * set package handler * add logging about stting up logging * test event log handler * add event log handler * add event log level * rename package and add unit tests * revert logfile config change * cleanup and add code comments * add changie * swap function for dict * add additional unit tests * fix unit test * update README and protos * fix formatting * update precommit --------- Co-authored-by: Peter Webb <peter.webb@dbtlabs.com> * fix import * move types_pb2.py from events to common/events * move agate_helper into common * Add utils module (#8910) * moving types_pb2.py to common/events * split out utils into core/common/adapters * add changie * remove usage of dbt.config.PartialProject from dbt/adapters (#8909) * remove usage of dbt.config.PartialProject from dbt/adapters * add changie --------- Co-authored-by: Colin <colin.rogers@dbtlabs.com> * move agate_helper unit tests under tests/unit/common * move agate_helper into common (#8911) * move agate_helper into common * add changie --------- Co-authored-by: Colin <colin.rogers@dbtlabs.com> * remove dbt.flags.MP_CONTEXT usage in dbt/adapters (#8931) * remove dbt.flags.LOG_CACHE_EVENTS usage in dbt/adapters (#8933) * Refactor Base Exceptions (#8989) * moving types_pb2.py to common/events * Refactor Base Exceptions * update make_log_dir_if_missing to handle str * move remaining adapters exception imports to common/adapters --------- Co-authored-by: Michelle Ark <michelle.ark@dbtlabs.com> * Remove usage of dbt.deprecations in dbt/adapters, enable core & adapter-specific (#9051) * Decouple adapter constraints from core (#9054) * Move constraints to dbt.common * Move constraints to contracts folder, per review * Add a changelog entry. * move include/global_project to adapters (#8930) * remove adapter.get_compiler (#9134) * Move adapter logger to adapters (#9165) * moving types_pb2.py to common/events * Move AdapterLogger to adapter folder * add changie * delete accidentally merged types_pb2.py * Move the semver package to common and alter references. (#9166) * Move the semver package to common and alter references. * Alter leftover references to dbt.semver, this time using from syntax. --------- Co-authored-by: Mila Page <versusfacit@users.noreply.github.com> * Refactor EventManager setup and interaction (#9180) * moving types_pb2.py to common/events * move event manager setup back to core, remove ref to global EVENT_MANAGER and clean up event manager functions * move invocation_id from events to first class common concept * move lowercase utils to common * move lowercase utils to common * ref CAPTURE_STREAM through method * add changie * first pass: adapter migration script (#9160) * Decouple macro generator from adapters (#9149) * Remove usage of dbt.contracts.relation in dbt/adapters (#9207) * Remove ResultNode usage from connections (#9211) * Add RelationConfig Protocol for use in Relation.create_from (#9210) * move relation contract to dbt.adapters * changelog entry * first pass: clean up relation.create_from * type ignores * type ignore * changelog entry * update RelationConfig variable names * Merge main into feature/decouple-adapters-from-core (#9240) * moving types_pb2.py to common/events * Restore warning on unpinned git packages (#9157) * Support --empty flag for schema-only dry runs (#8971) * Fix ensuring we produce valid jsonschema artifacts for manifest, catalog, sources, and run-results (#9155) * Drop `all_refs=True` from jsonschema-ization build process Passing `all_refs=True` makes it so that Everything is a ref, even the top level schema. In jsonschema land, this essentially makes the produced artifact not a full schema, but a fractal object to be included in a schema. Thus when `$id` is passed in, jsonschema tools blow up because `$id` is for identifying a schema, which we explicitly weren't creating. The alternative was to drop the inclusion of `$id`. Howver, we're intending to create a schema, and having an `$id` is recommended best practice. Additionally since we were intending to create a schema, not a fractal, it seemed best to create to full schema. * Explicity produce jsonschemas using DRAFT_2020_12 dialect Previously were were implicitly using the `DRAFT_2020_12` dialect through mashumaro. It felt wise to begin explicitly specifying this. First, it is closest in available mashumaro provided dialects to what we produced pre 1.7. Secondly, if mashumaro changes its default for whatever reason (say a new dialect is added, and mashumaro moves to that), we don't want to automatically inherit that. * Bump manifest version to v12 Core 1.7 released with manifest v11, and we don't want to be overriding that with 1.8. It'd be weird for 1.7 and 1.8 to both have v11 manifests, but for them to be different, right? * Begin including schema dialect specification in produced jsonschema In jsonschema's documentation they state > It's not always easy to tell which draft a JSON Schema is using. > You can use the $schema keyword to declare which version of the JSON Schema specification the schema is written to. > It's generally good practice to include it, though it is not required. and > For brevity, the $schema keyword isn't included in most of the examples in this book, but it should always be used in the real world. Basically, to know how to parse a schema, it's important to include what schema dialect is being used for the schema specification. The change in this commit ensures we include that information. * Create manifest v12 jsonschema specification * Add change documentation for jsonschema schema production fix * Bump run-results version to v6 * Generate new v6 run-results jsonschema * Regenerate catalog v1 and sources v3 with fixed jsonschema production * Update tests to handle bumped versions of manifest and run-results --------- Co-authored-by: Jeremy Cohen <jeremy@dbtlabs.com> Co-authored-by: Michelle Ark <MichelleArk@users.noreply.github.com> Co-authored-by: Quigley Malcolm <QMalcolm@users.noreply.github.com> * Move BaseConfig to Common (#9224) * moving types_pb2.py to common/events * move BaseConfig and assorted dependencies to common * move ShowBehavior and OnConfigurationChange to common * add changie * Remove manifest from catalog and connection method signatures (#9242) * Add MacroResolverProtocol, remove lazy loading of manifest in adapter.execute_macro (#9243) * remove manifest from adapter.execute_macro, replace with MacroResolver + remove lazy loading * rename to MacroResolverProtocol * pass MacroResolverProtcol in adapter.calculate_freshness_from_metadata * changelog entry * fix adapter.calculate_freshness call * pass context to MacroQueryStringSetter (#9248) * moving types_pb2.py to common/events * remove manifest from adapter.execute_macro, replace with MacroResolver + remove lazy loading * rename to MacroResolverProtocol * pass MacroResolverProtcol in adapter.calculate_freshness_from_metadata * changelog entry * fix adapter.calculate_freshness call * pass context to MacroQueryStringSetter * changelog entry --------- Co-authored-by: Colin <colin.rogers@dbtlabs.com> * add macro_context_generator on adapter (#9251) * moving types_pb2.py to common/events * remove manifest from adapter.execute_macro, replace with MacroResolver + remove lazy loading * rename to MacroResolverProtocol * pass MacroResolverProtcol in adapter.calculate_freshness_from_metadata * changelog entry * fix adapter.calculate_freshness call * add macro_context_generator on adapter * fix adapter test setup * changelog entry * Update parser to support conversion metrics (#9173) * added ConversionTypeParams classes * updated parser for ConversionTypeParams * added step to populate input_measure for conversion metrics * version bump on DSI * comment back manifest generating line * updated v12 schemas * added tests * added changelog * Add typing for macro_context_generator, fix query_header_context --------- Co-authored-by: Colin <colin.rogers@dbtlabs.com> Co-authored-by: William Deng <33618746+WilliamDee@users.noreply.github.com> * Pass mp_context to adapter factory (#9275) * moving types_pb2.py to common/events * require core to pass mp_context to adapter factory * add changie * fix SpawnContext annotation * Fix include for decoupling (#9286) * moving types_pb2.py to common/events * fix include path in MANIFEST.in * Fix include for decoupling (#9288) * moving types_pb2.py to common/events * fix include path in MANIFEST.in * add index.html to in MANIFEST.in * move system client to common (#9294) * moving types_pb2.py to common/events * move system.py to common * add changie update README * remove dbt.utils from semver.py * remove aliasing connection_exception_retry * Update materialized views to use RelationConfigs and remove refs to dbt.utils (#9291) * moving types_pb2.py to common/events * add AdapterRuntimeConfig protocol and clean up dbt-postgress core imports * add changie * remove AdapterRuntimeConfig * update changelog * Add config field to RelationConfig (#9300) * moving types_pb2.py to common/events * add config field to RelationConfig * merge main into feature/decouple-adapters-from-core (#9305) * moving types_pb2.py to common/events * Update parser to support conversion metrics (#9173) * added ConversionTypeParams classes * updated parser for ConversionTypeParams * added step to populate input_measure for conversion metrics * version bump on DSI * comment back manifest generating line * updated v12 schemas * added tests * added changelog * Remove `--dry-run` flag from `dbt deps` (#9169) * Rm --dry-run flag for dbt deps * Add changelog entry * Update test * PR feedback * adding clean_up methods to basic and unique_id tests (#9195) * init attempt of adding clean_up methods to basic and unique_id tests * swapping cleanup method drop of test_schema to unique_schema to test breakage on docs_generate test * moving the clean_up method down into class BaseDocsGenerate * remove drop relation for unique_schema * manually define alternate_schema for clean_up as not being seen as part of project_config * add changelog * remove unneeded changelog * uncomment line that generates new manifest and delete manifest our changes created * make sure the manifest test is deleted and readd older version of manifest.json to appease test * manually revert file to previous commit * Revert "manually revert file to previous commit" This reverts commit a755419. --------- Co-authored-by: William Deng <33618746+WilliamDee@users.noreply.github.com> Co-authored-by: Jeremy Cohen <jeremy@dbtlabs.com> Co-authored-by: Matthew McKnight <91097623+McKnight-42@users.noreply.github.com> * resolve merge conflict on unparsed.py (#9309) * moving types_pb2.py to common/events * Update parser to support conversion metrics (#9173) * added ConversionTypeParams classes * updated parser for ConversionTypeParams * added step to populate input_measure for conversion metrics * version bump on DSI * comment back manifest generating line * updated v12 schemas * added tests * added changelog * Remove `--dry-run` flag from `dbt deps` (#9169) * Rm --dry-run flag for dbt deps * Add changelog entry * Update test * PR feedback * adding clean_up methods to basic and unique_id tests (#9195) * init attempt of adding clean_up methods to basic and unique_id tests * swapping cleanup method drop of test_schema to unique_schema to test breakage on docs_generate test * moving the clean_up method down into class BaseDocsGenerate * remove drop relation for unique_schema * manually define alternate_schema for clean_up as not being seen as part of project_config * add changelog * remove unneeded changelog * uncomment line that generates new manifest and delete manifest our changes created * make sure the manifest test is deleted and readd older version of manifest.json to appease test * manually revert file to previous commit * Revert "manually revert file to previous commit" This reverts commit a755419. --------- Co-authored-by: William Deng <33618746+WilliamDee@users.noreply.github.com> Co-authored-by: Jeremy Cohen <jeremy@dbtlabs.com> Co-authored-by: Matthew McKnight <91097623+McKnight-42@users.noreply.github.com> * Resolve unparsed.py conflict (#9311) * Update parser to support conversion metrics (#9173) * added ConversionTypeParams classes * updated parser for ConversionTypeParams * added step to populate input_measure for conversion metrics * version bump on DSI * comment back manifest generating line * updated v12 schemas * added tests * added changelog * Remove `--dry-run` flag from `dbt deps` (#9169) * Rm --dry-run flag for dbt deps * Add changelog entry * Update test * PR feedback * adding clean_up methods to basic and unique_id tests (#9195) * init attempt of adding clean_up methods to basic and unique_id tests * swapping cleanup method drop of test_schema to unique_schema to test breakage on docs_generate test * moving the clean_up method down into class BaseDocsGenerate * remove drop relation for unique_schema * manually define alternate_schema for clean_up as not being seen as part of project_config * add changelog * remove unneeded changelog * uncomment line that generates new manifest and delete manifest our changes created * make sure the manifest test is deleted and readd older version of manifest.json to appease test * manually revert file to previous commit * Revert "manually revert file to previous commit" This reverts commit a755419. --------- Co-authored-by: William Deng <33618746+WilliamDee@users.noreply.github.com> Co-authored-by: Jeremy Cohen <jeremy@dbtlabs.com> Co-authored-by: Matthew McKnight <91097623+McKnight-42@users.noreply.github.com> --------- Co-authored-by: colin-rogers-dbt <111200756+colin-rogers-dbt@users.noreply.github.com> Co-authored-by: Peter Webb <peter.webb@dbtlabs.com> Co-authored-by: Colin <colin.rogers@dbtlabs.com> Co-authored-by: Mila Page <67295367+VersusFacit@users.noreply.github.com> Co-authored-by: Mila Page <versusfacit@users.noreply.github.com> Co-authored-by: Jeremy Cohen <jeremy@dbtlabs.com> Co-authored-by: Quigley Malcolm <QMalcolm@users.noreply.github.com> Co-authored-by: William Deng <33618746+WilliamDee@users.noreply.github.com> Co-authored-by: Matthew McKnight <91097623+McKnight-42@users.noreply.github.com> Co-authored-by: Chenyu Li <chenyu.li@dbtlabs.com>

MichelleArk added 3 commits December 5, 2023 12:03

move relation contract to dbt.adapters

7f777f8

changelog entry

2cee865

first pass: clean up relation.create_from

160d0db

cla-bot bot added the cla:yes label Dec 5, 2023

type ignores

d7d5e23

MichelleArk changed the title ~~first pass: clean up relation.create_from~~ Consolidate Relation.create_from Dec 5, 2023

MichelleArk changed the title ~~Consolidate Relation.create_from~~ Add RelationConfig Protocol for use in Relation.create_from Dec 5, 2023

MichelleArk added 2 commits December 5, 2023 17:06

type ignore

b8de881

changelog entry

ba53f05

MichelleArk commented Dec 5, 2023

View reviewed changes

MichelleArk marked this pull request as ready for review December 5, 2023 08:13

MichelleArk requested review from a team as code owners December 5, 2023 08:13

MichelleArk requested review from nathaniel-may, QMalcolm and colin-rogers-dbt and removed request for nathaniel-may and QMalcolm December 5, 2023 08:13

colin-rogers-dbt reviewed Dec 5, 2023

View reviewed changes

core/dbt/adapters/base/relation.py Outdated Show resolved Hide resolved

colin-rogers-dbt reviewed Dec 5, 2023

View reviewed changes

core/dbt/adapters/base/relation.py Outdated Show resolved Hide resolved

Base automatically changed from decouple-relations-from-core to feature/decouple-adapters-from-core December 6, 2023 01:34

MichelleArk added 2 commits December 6, 2023 10:58

Merge branch 'feature/decouple-adapters-from-core' into relation-crea…

6796edd

…te-from-refactor

update RelationConfig variable names

7ad6aa1

MichelleArk requested a review from colin-rogers-dbt December 6, 2023 02:03

Merge branch 'feature/decouple-adapters-from-core' into relation-crea…

7ad1acc

…te-from-refactor

MichelleArk force-pushed the relation-create-from-refactor branch from 7f2d29a to 7ad1acc Compare December 6, 2023 02:19

colin-rogers-dbt approved these changes Dec 6, 2023

View reviewed changes

colin-rogers-dbt merged commit eb96e3d into feature/decouple-adapters-from-core Dec 6, 2023
51 checks passed

colin-rogers-dbt deleted the relation-create-from-refactor branch December 6, 2023 18:46

MichelleArk mentioned this pull request Dec 7, 2023

[CT-3455] Remove usage of dbt.contracts.graph.nodes from dbt/adapters/base/relation.py #9215

Closed

colin-rogers-dbt mentioned this pull request Dec 12, 2023

Move Adapter Factory to Core #9274

Draft

5 tasks

MichelleArk mentioned this pull request Mar 1, 2024

Migrate to dbt-common + dbt-adapters duckdb/dbt-duckdb#342

Merged

MichelleArk mentioned this pull request Mar 15, 2024

SourceDefinition.meta should represent merged base meta and table_meta #9766

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add RelationConfig Protocol for use in Relation.create_from #9210

Add RelationConfig Protocol for use in Relation.create_from #9210

MichelleArk commented Dec 5, 2023 •

edited

Loading

github-actions bot commented Dec 5, 2023

codecov bot commented Dec 5, 2023 •

edited

Loading

MichelleArk commented Dec 5, 2023

MichelleArk Dec 5, 2023

MichelleArk Dec 5, 2023

MichelleArk Dec 5, 2023

Add RelationConfig Protocol for use in Relation.create_from #9210

Add RelationConfig Protocol for use in Relation.create_from #9210

Conversation

MichelleArk commented Dec 5, 2023 • edited Loading

Problem

Solution

Checklist

github-actions bot commented Dec 5, 2023

codecov bot commented Dec 5, 2023 • edited Loading

Codecov Report

MichelleArk commented Dec 5, 2023

MichelleArk Dec 5, 2023

Choose a reason for hiding this comment

MichelleArk Dec 5, 2023

Choose a reason for hiding this comment

MichelleArk Dec 5, 2023

Choose a reason for hiding this comment

MichelleArk commented Dec 5, 2023 •

edited

Loading

codecov bot commented Dec 5, 2023 •

edited

Loading