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

Add postgres_conn_id to template fields in PostgresOperator #30778

Closed
wants to merge 1 commit into from

Conversation

DucNgn
Copy link

@DucNgn DucNgn commented Apr 20, 2023

Add postgres_conn_id to the template fields for the PostgresOperator


Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

@boring-cyborg
Copy link

boring-cyborg bot commented Apr 20, 2023

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

Copy link
Member

@hussein-awala hussein-awala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

postgres_conn_id is provided to super as conn_id which is already a template field, I'll test it to decide if it already possible or we need to do it in another way

Copy link
Member

@hussein-awala hussein-awala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this can do the job, can you test it?

@@ -42,7 +42,7 @@ class PostgresOperator(SQLExecuteQueryOperator):
For example, you could set the schema via `{"search_path": "CUSTOM_SCHEMA"}`.
"""

template_fields: Sequence[str] = ("sql",)
template_fields: Sequence[str] = ("sql", "postgres_conn_id")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
template_fields: Sequence[str] = ("sql", "postgres_conn_id")
template_fields: Sequence[str] = ("sql", "conn_id")

@hussein-awala
Copy link
Member

BTW, this operator is deprecated:

warnings.warn(
"""This class is deprecated.
Please use `airflow.providers.common.sql.operators.sql.SQLExecuteQueryOperator`.
Also, you can provide `hook_params={'schema': <database>}`.""",
DeprecationWarning,
stacklevel=2,
)

Should we stop updating it?
@potiuk @eladkal

@eladkal
Copy link
Contributor

eladkal commented Apr 21, 2023

Should we stop updating it? @potiuk @eladkal

Yes. We do not add new features to deprecated code

@eladkal
Copy link
Contributor

eladkal commented Apr 21, 2023

closing in favor of #30784

@eladkal eladkal closed this Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants