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

[b/398251186] Make descriptions mandatory for Snowflake connectors #749

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

misolt
Copy link
Collaborator

@misolt misolt commented Feb 21, 2025

Changes

  • Make it required for non-abstract Snowflake connectors to provide a description string.
  • Other existing connectors are unaffected.

Implementation

Add the method getDescription:

  • The method is abstract in AbstractSnowflakeConnector
  • In AbstractConnector, the implementation uses the existing getAnnotation approach
  • In Connector, the method returns an empty description.

Notes

  • The result is that all AbstractSnowflakeConnector subclasses need to provide a description string.
  • In addition, providing an empty description is no longer possible - it will be hidden. Let me know if you intended to use it and I'll add support.
  • It is now possible (but not that useful) to build more complex description strings, because they don't have to be constants.
  • Implementing a Connector that bypasses AbstractConnector and then putting the Description annotation on it would've worked in the past, but it will not work after this change.

@misolt misolt marked this pull request as ready for review February 21, 2025 19:15
@misolt misolt changed the title Make descriptions mandatory for Snowflake connectors [b/398251186] Make descriptions mandatory for Snowflake connectors Feb 21, 2025
@misolt misolt requested a review from kajgol February 27, 2025 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant