fix: Exclude location fields when api_type is BULK
#51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dlouseiro
changed the title
api_type is BULKapi_type is BULK
dlouseiro
force-pushed
the
dlouseiro/exclude-location-fields
branch
from
e5f9ca5
to
6931528
Compare
edgarrmondragon
approved these changes
Jun 28, 2024
|
Thanks @dlouseiro! |
nezd
pushed a commit
to dext/tap-salesforce
that referenced
this pull request
Sep 26, 2024
In the current implementation of the tap, fields described with `type=address` are correctly excluded when using `api_type=BULK`. Although, this is not the case for geolocation fields (described with `type=location`). I'm not a Salesforce specialist per se, but know that the changes I'm applying on this branch solved the issue described [here](MeltanoLabs#42). In my specific case I had a field like this: ``` "Geolocation__c": { "type": [ "number", "object", "null" ], "properties": { "longitude": { "type": [ "null", "number" ] }, "latitude": { "type": [ "null", "number" ] } } }, ``` As it's a compound field, split over multiple properties (`longitude` and `latitude`), the parent field `Geolocation__c` does not have much value as the relevant information is propagated in the "sub-fields" (`latitude` and `longitude`). So what I'm doing in this PR is to ensure that: - `Geolocation__c` is marked with `unsupported` in the schema metadata (snippet below) while still ensuring that the "sub-fields" are correctly queried. Snippet of the excluded schema after this PR: ``` { "breadcrumb": [ "properties", "Geolocation__c" ], "metadata": { "inclusion": "unsupported", "unsupported-description": "cannot query compound address fields with bulk API" } }, ``` Snippet of the "sub-fields" in the schema: ``` "Geolocation__Latitude__s": { "type": [ "null", "number" ] }, "Geolocation__Longitude__s": { "type": [ "null", "number" ] }, ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the current implementation of the tap, fields described with
type=addressare correctly excluded when usingapi_type=BULK.Although, this is not the case for geolocation fields (described with
type=location).I'm not a Salesforce specialist per se, but know that the changes I'm applying on this branch solved the issue described here.
In my specific case I had a field like this:
As it's a compound field, split over multiple properties (
longitudeandlatitude), the parent fieldGeolocation__cdoes not have much value as the relevant information is propagated in the "sub-fields" (latitudeandlongitude).So what I'm doing in this PR is to ensure that:
Geolocation__cis marked withunsupportedin the schema metadata (snippet below) while still ensuring that the "sub-fields" are correctly queried.Snippet of the excluded schema after this PR:
Snippet of the "sub-fields" in the schema: