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

feat: Allow developers to deprecate stream fields #2814

Closed
edgarrmondragon opened this issue Dec 17, 2024 · 1 comment
Closed

feat: Allow developers to deprecate stream fields #2814

edgarrmondragon opened this issue Dec 17, 2024 · 1 comment
Assignees
Labels
kind/Feature New feature or request valuestream/SDK
Milestone

Comments

@edgarrmondragon
Copy link
Collaborator

edgarrmondragon commented Dec 17, 2024

Feature scope

Taps (catalog, state, tests, etc.)

Description

The goal is to give developers a clear path for deprecation of a stream field, by automatically communicating to current and future users of the tap an explanation or even a migration instruction via this library's logs.

For example, if users want to change the type of a field but want to avoid introducing a breaking change, they could

  1. add new field field_decimal, and deprecate field by adding the deprecated=True flag
  2. the Singer SDK emits a warning each time field is selected for sync
  3. later, field is marked with selected-by-default: false metadata
  4. later yet, field is removed

Related:

@edgarrmondragon
Copy link
Collaborator Author

Closed by #2116

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/Feature New feature or request valuestream/SDK
Projects
None yet
Development

No branches or pull requests

1 participant