Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mapping in Airbyte UI #50881

Merged
merged 2 commits into from
Jan 22, 2025
Merged

Mapping in Airbyte UI #50881

merged 2 commits into from
Jan 22, 2025

Conversation

ian-at-airbyte
Copy link
Contributor

@ian-at-airbyte ian-at-airbyte commented Jan 3, 2025

What

Adds mapping docs to a "good enough" level.

How

Add a new topic explaining how mapping works.

Review guide

/docs/using-airbyte/mappings.md

User Impact

The feature for Teams customers is documented.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Jan 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 9:52pm

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Jan 3, 2025
@ian-at-airbyte ian-at-airbyte marked this pull request as ready for review January 17, 2025 21:46
@ian-at-airbyte ian-at-airbyte changed the title [Draft] Mapping in Airbyte UI Mapping in Airbyte UI Jan 17, 2025
@@ -38,7 +40,7 @@ There are many reasons you might want to encrypt data.
- **Efficient retrieval**: Hashing can enable faster lookups in databases.
- **Anonymity and compliance**: Source datasets can contain personally identifiable information (PII). Anonymizing PII can help you meet data privacy regulations like GDPR and HIPAA.

<!-- Probably need some guidance on the use of keys with Airbyte, esp. wrt external secrets managers and AES encryption -->
<!-- Probably need some guidance on the use of keys with Airbyte, esp. wrt external secrets managers and AES encryption, and the validation rules -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pedroslopez or I can probably answer whatever questions you have here. Is this blocking?


Before you begin mapping fields, consider the following.

- If you set up mapping on an existing connection, Airbyte prompts you to clear your stream and the data in your destination. You almost certainly should do this. Not doing this could result in undesirable or unexpected behavior. For example, if you set up hashing on a field that contains personally identifiable information (PII), you want all data in that column to be hashed, not just new data. Clearing your destination accomplishes this. However, if you're dealing with an extremely large database, a complete resync might take a significant amount of time.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For most destinations, we will recommend a refresh from within the UI, not a clear. The only exception to this is if the destination does not support refreshes (only a few Marketplace destinations are this way).

However, for this operation you are right that users will probably want a clear unless their sync mode uses Full Refresh.

Before you begin mapping fields, consider the following.

- If you set up mapping on an existing connection, Airbyte prompts you to clear your stream and the data in your destination. You almost certainly should do this. Not doing this could result in undesirable or unexpected behavior. For example, if you set up hashing on a field that contains personally identifiable information (PII), you want all data in that column to be hashed, not just new data. Clearing your destination accomplishes this. However, if you're dealing with an extremely large database, a complete resync might take a significant amount of time.
- Do not map a cursor or primary key field if the [sync mode](core-concepts/sync-modes) depends on it. Doing this disrupts Airbyte's ability to use them for incremental syncing and deduplication.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pedroslopez did we decide that this would actually be disruptive or not? I can't recall.

Copy link
Contributor

@teallarson teallarson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I left a few notes, none of them blocking.

@ian-at-airbyte ian-at-airbyte merged commit cee3930 into master Jan 22, 2025
30 checks passed
@ian-at-airbyte ian-at-airbyte deleted the 11246-mappings-ui branch January 22, 2025 17:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation team/documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants