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.

Sign up for GitHub

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

Migrate Postgres example DAGs to new design #22458 #24148

Merged
merged 2 commits into from
Jun 3, 2022
+23 −23
Merged

Migrate Postgres example DAGs to new design #22458 #24148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1db14c1
Migrate Postgres example DAGs to new design #22458
chethanuk Jun 3, 2022
d893855
Fix static checks
chethanuk Jun 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions airflow/providers/postgres/example_dags/__init__.py
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/apache-airflow-providers-postgres/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Content
:maxdepth: 1
:caption: Resources

Example DAGs <https://github.com/apache/airflow/tree/main/airflow/providers/postgres/example_dags>
Example DAGs <https://github.com/apache/airflow/tree/main/tests/system/providers/postgres>

.. toctree::
:maxdepth: 1
Expand Down
6 changes: 3 additions & 3 deletions docs/apache-airflow-providers-postgres/operators/postgres_operator_howto_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Creating a Postgres database table

The code snippets below are based on Airflow-2.0

.. exampleinclude:: /../../airflow/providers/postgres/example_dags/example_postgres.py
.. exampleinclude:: /../../tests/system/providers/postgres/example_postgres.py
:language: python
:start-after: [START postgres_operator_howto_guide]
:end-before: [END postgres_operator_howto_guide_create_pet_table]
Expand Down Expand Up @@ -160,7 +160,7 @@ Passing Server Configuration Parameters into PostgresOperator
PostgresOperator provides the optional ``runtime_parameters`` attribute which makes it possible to set
the `server configuration parameter values <https://www.postgresql.org/docs/current/runtime-config-client.html>`_ for the SQL request during runtime.

.. exampleinclude:: /../../airflow/providers/postgres/example_dags/example_postgres.py
.. exampleinclude:: /../../tests/system/providers/postgres/example_postgres.py
:language: python
:start-after: [START postgres_operator_howto_guide_get_birth_date]
:end-before: [END postgres_operator_howto_guide_get_birth_date]
Expand All @@ -171,7 +171,7 @@ The complete Postgres Operator DAG

When we put everything together, our DAG should look like this:

.. exampleinclude:: /../../airflow/providers/postgres/example_dags/example_postgres.py
.. exampleinclude:: /../../tests/system/providers/postgres/example_postgres.py
:language: python
:start-after: [START postgres_operator_howto_guide]
:end-before: [END postgres_operator_howto_guide]
Expand Down
22 changes: 19 additions & 3 deletions ...postgres/example_dags/example_postgres.py → ...em/providers/postgres/example_postgres.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,23 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

# [START postgres_operator_howto_guide]
import datetime
import os

from airflow import DAG
from airflow.providers.postgres.operators.postgres import PostgresOperator

# [START postgres_operator_howto_guide]


# create_pet_table, populate_pet_table, get_all_pets, and get_birth_date are examples of tasks created by
# instantiating the Postgres Operator

ENV_ID = os.environ.get("SYSTEM_TESTS_ENV_ID")
DAG_ID = "postgres_operator_dag"

with DAG(
dag_id="postgres_operator_dag",
dag_id=DAG_ID,
start_date=datetime.datetime(2020, 2, 2),
schedule_interval="@once",
catchup=False,
Expand Down Expand Up @@ -72,3 +77,14 @@

create_pet_table >> populate_pet_table >> get_all_pets >> get_birth_date
# [END postgres_operator_howto_guide]

from tests.system.utils.watcher import watcher

# This test needs watcher in order to properly mark success/failure
# when "tearDown" task with trigger rule is part of the DAG
list(dag.tasks) >> watcher()

from tests.system.utils import get_test_run # noqa: E402

# Needed to run the example DAG with pytest (see: tests/system/README.md#run_via_pytest)
test_run = get_test_run(dag)