Skip to content

feat: Allow developers to deprecate stream fields #2814

Open
@edgarrmondragon

Description

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:

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions