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

🚨🚨🐛 Source Mixapanel: Delete default primary key for Export stream #31955

Merged
merged 3 commits into from Nov 3, 2023

Conversation

tolik0
Copy link
Contributor

@tolik0 tolik0 commented Oct 30, 2023

What

Removed the default primary key from the Export stream.

How

The columns recommended by Mixpanel for the primary key - [insert_id, event_time, event_name, distinct_id] - may not always have an insert_id for certain users. This issue is discussed in detail here. This PR aims to give users the flexibility to choose their primary key, as requested in this related PR.

🚨 User Impact 🚨

This PR introduces breaking changes due to the removal of the default primary key for the Export stream.

@vercel
Copy link

vercel bot commented Oct 30, 2023

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 Nov 3, 2023 4:18pm

@octavia-squidington-iii octavia-squidington-iii added the area/connectors Connector related issues label Oct 30, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 30, 2023

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@octavia-squidington-iii octavia-squidington-iii added the area/documentation Improvements or additions to documentation label Oct 30, 2023
@tolik0 tolik0 marked this pull request as ready for review October 30, 2023 13:11
@tolik0 tolik0 self-assigned this Oct 30, 2023
@tolik0 tolik0 requested a review from bazarnov October 30, 2023 13:11
In this release, the default primary key for stream Export has been deleted,
allowing users to select the key that best fits their data.
Users will need to refresh the source schema and reset
affected streams after upgrading.
Copy link
Contributor

Choose a reason for hiding this comment

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

if ["distinct_id", "event", "time"] fits their usecase do they still need to refresh/reset?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for pointing that out! Upon local testing, it was found that after upgrading, users have the option to change the primary key, and the previous fields remain selected. Therefore, a refresh is only necessary if there's a need to apply a new primary key. I've updated the relevant messages to reflect this.

@octavia-squidington-iv octavia-squidington-iv requested a review from a team November 3, 2023 12:45
@tolik0 tolik0 merged commit 9e765cd into master Nov 3, 2023
25 of 27 checks passed
@tolik0 tolik0 deleted the tolik0/source-mixpanel/fix-export-pk branch November 3, 2023 23:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/mixpanel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants