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

Keep legacy proto-based types available for import #999

Closed
plamut opened this issue Oct 1, 2021 · 1 comment
Closed

Keep legacy proto-based types available for import #999

plamut opened this issue Oct 1, 2021 · 1 comment
Assignees
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. semver: major Hint for users that this is an API breaking change. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@plamut
Copy link
Contributor

plamut commented Oct 1, 2021

As a follow-up to #814 and as discussed with @tswast on the chat, some users, that otherwise could upgrade to a 3.x version, would still need the legacy generated SQL model types that the 3.x version will remove.

We should add these models back to the codebase, but with the following restrictions:

  • These legacy files would be copy-pasted to their old place, but will not be generated anymore. The version to copy from main should be the time [Breaking Change] Remove google.cloud.bigquery_v2 directory and related code generation #814 was merged into v3.
  • The legacy models would not be exposed in the library's top-level namespace, nor would they be imported or used anywhere else in the code. Users will have to import them using the full module path, and at their own risk.
  • These types will not be maintained in any way, and will be ignored by type checks and test coverage. They will also eventually get out of sync with what the code generator would produce - this is intentional.
  • When importing anything from that legacy sub-package, a warning should be issued.

@tswast Feel free to update/correct the requirements above in case I misunderstood/misremembered them.

@plamut plamut added type: process A process-related concern. May include testing, release, or the like. semver: major Hint for users that this is an API breaking change. labels Oct 1, 2021
@plamut plamut self-assigned this Oct 1, 2021
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/python-bigquery API. label Oct 1, 2021
@plamut plamut added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. and removed type: process A process-related concern. May include testing, release, or the like. labels Oct 1, 2021
@plamut plamut changed the title Keep legacy generated SQL types available for import Keep legacy proto-based types available for import Oct 1, 2021
@tswast
Copy link
Contributor

tswast commented Oct 6, 2021

Closed by #1000

@tswast tswast closed this as completed Oct 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: bigquery Issues related to the googleapis/python-bigquery API. semver: major Hint for users that this is an API breaking change. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

2 participants