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

Make the interface of common.sql DBApiHook type-defined #36224

Open
1 task done
potiuk opened this issue Dec 14, 2023 · 0 comments
Open
1 task done

Make the interface of common.sql DBApiHook type-defined #36224

potiuk opened this issue Dec 14, 2023 · 0 comments
Assignees
Labels
kind:meta High-level information important to the community

Comments

@potiuk
Copy link
Member

potiuk commented Dec 14, 2023

Body

The current interface of DBApiHook is well described now in the ADR https://github.com/apache/airflow/blob/main/airflow/providers/common/sql/doc/adr/0002-return-common-data-structure-from-dbapihook-derived-hooks.md - but it's not enforced. We should see if we can use Python typing (or posibly other mechanisms) to make the interfaced more stable and enforced. That also includes review of the common.sql API now captured in the .pyi interface (but likely somewhat not complete/broken) which we created in order to make the common.sql API stable.

That needs a new ADR describing it as well.

That is pretty related and should bring common.sql API to the level it should have from the very beginning, hopefully becoming a "golden standard" for other common interfaces we expose to our providers.

cc: @bolkedebruin @Taragolis

Committer

  • I acknowledge that I am a maintainer/committer of the Apache Airflow project.
@potiuk potiuk added the kind:meta High-level information important to the community label Dec 14, 2023
@potiuk potiuk self-assigned this Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:meta High-level information important to the community
Projects
None yet
Development

No branches or pull requests

1 participant