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

Document for append operator #619

Merged
merged 8 commits into from
Aug 9, 2022
Merged

Document for append operator #619

merged 8 commits into from
Aug 9, 2022

Conversation

utkarsharma2
Copy link
Collaborator

Description

What is the current behavior?

In the past, we had a tutorial which illustrated how to use each of our operators/decorators:
https://github.com/astronomer/astro-sdk/blob/be6280df00ccff0d7a1c0dfb099b2065303dbe88/REFERENCE.md

closes: #590

What is the new behavior?

Have a reference page per operator/decorator similar to
https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/operators/ecs.html#howto-operator-ecsoperator

In which we reference parts of an (automated tested) example DAG which illustrates the usage of that operator/decorator.

Many of these use cases already exist in our example DAGs - we should reference them.

Does this introduce a breaking change?

Nope

Checklist

  • Created tests which fail without the change (if possible)
  • Extended the README / documentation, if necessary

tests/test_example_dags.py Outdated Show resolved Hide resolved
example_dags/example_append.py Outdated Show resolved Hide resolved
docs/astro/sql/operators/append.rst Outdated Show resolved Hide resolved
docs/astro/sql/operators/append.rst Show resolved Hide resolved
docs/astro/sql/operators/append.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 9, 2022

Codecov Report

Merging #619 (05771c5) into main (91f7a35) will not change coverage.
The diff coverage is n/a.

❗ Current head 05771c5 differs from pull request most recent head c2495e0. Consider uploading reports for the commit c2495e0 to get more accurate results

@@           Coverage Diff           @@
##             main     #619   +/-   ##
=======================================
  Coverage   93.30%   93.30%           
=======================================
  Files          41       41           
  Lines        1672     1672           
  Branches      211      211           
=======================================
  Hits         1560     1560           
  Misses         89       89           
  Partials       23       23           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

output_table=Table(conn_id="postgres_conn"),
)
load_append = aql.load_file(
input_file=File(path=DATA_DIR + "/homes2.csv"),
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
input_file=File(path=DATA_DIR + "/homes2.csv"),
input_file=File(path=DATA_DIR + "homes2.csv"),

We have an extra / here

@utkarsharma2 utkarsharma2 merged commit 367f94b into main Aug 9, 2022
@utkarsharma2 utkarsharma2 deleted the appendDocs branch August 9, 2022 12:15
kaxil pushed a commit that referenced this pull request Aug 18, 2022
What is the current behavior?

In the past, we had a tutorial which illustrated how to use each of our operators/decorators:
https://github.com/astronomer/astro-sdk/blob/be6280df00ccff0d7a1c0dfb099b2065303dbe88/REFERENCE.md

closes: #590
What is the new behavior?

Have a reference page per operator/decorator similar to
https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/operators/ecs.html#howto-operator-ecsoperator

In which we reference parts of an (automated tested) example DAG which illustrates the usage of that operator/decorator.

Many of these use cases already exist in our example DAGs - we should reference them.
Does this introduce a breaking change?

Nope
kaxil pushed a commit that referenced this pull request Aug 18, 2022
What is the current behavior?

In the past, we had a tutorial which illustrated how to use each of our operators/decorators:
https://github.com/astronomer/astro-sdk/blob/be6280df00ccff0d7a1c0dfb099b2065303dbe88/REFERENCE.md

closes: #590
What is the new behavior?

Have a reference page per operator/decorator similar to
https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/operators/ecs.html#howto-operator-ecsoperator

In which we reference parts of an (automated tested) example DAG which illustrates the usage of that operator/decorator.

Many of these use cases already exist in our example DAGs - we should reference them.
Does this introduce a breaking change?

Nope
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.

Add example DAG and documentation for append
3 participants