From bc4c52692ccd63e85ce9dd2e15c4ea9c4eae56d1 Mon Sep 17 00:00:00 2001 From: Vincent Beck Date: Wed, 11 May 2022 08:41:41 -0600 Subject: [PATCH] Update doc and sample dag for Quicksight --- .../aws/example_dags/example_quicksight.py | 16 +++++---- .../operators/quicksight.rst | 36 ++++++++++--------- docs/spelling_wordlist.txt | 1 + 3 files changed, 30 insertions(+), 23 deletions(-) diff --git a/airflow/providers/amazon/aws/example_dags/example_quicksight.py b/airflow/providers/amazon/aws/example_dags/example_quicksight.py index dd46035daadbc..5c50a54492617 100644 --- a/airflow/providers/amazon/aws/example_dags/example_quicksight.py +++ b/airflow/providers/amazon/aws/example_dags/example_quicksight.py @@ -19,11 +19,12 @@ from datetime import datetime from airflow import DAG +from airflow.models.baseoperator import chain from airflow.providers.amazon.aws.operators.quicksight import QuickSightCreateIngestionOperator from airflow.providers.amazon.aws.sensors.quicksight import QuickSightSensor -DATA_SET_ID = os.getenv("DATA_SET_ID", "DemoDataSet_Test") -INGESTION_NO_WAITING_ID = os.getenv("INGESTION_NO_WAITING_ID", "DemoDataSet_Ingestion_No_Waiting_Test") +DATA_SET_ID = os.getenv("DATA_SET_ID", "data-set-id") +INGESTION_ID = os.getenv("INGESTION_ID", "ingestion-id") with DAG( dag_id="example_quicksight", @@ -36,10 +37,10 @@ # and does not wait for its completion # [START howto_operator_quicksight_create_ingestion] quicksight_create_ingestion_no_waiting = QuickSightCreateIngestionOperator( + task_id="quicksight_create_ingestion_no_waiting", data_set_id=DATA_SET_ID, - ingestion_id=INGESTION_NO_WAITING_ID, + ingestion_id=INGESTION_ID, wait_for_completion=False, - task_id="sample_quicksight_no_waiting_dag", ) # [END howto_operator_quicksight_create_ingestion] @@ -47,9 +48,10 @@ # job until it succeeds. # [START howto_sensor_quicksight] quicksight_job_status = QuickSightSensor( + task_id="quicksight_job_status", data_set_id=DATA_SET_ID, - ingestion_id=INGESTION_NO_WAITING_ID, - task_id="check_quicksight_job_status", + ingestion_id=INGESTION_ID, ) # [END howto_sensor_quicksight] - quicksight_create_ingestion_no_waiting >> quicksight_job_status + + chain(quicksight_create_ingestion_no_waiting, quicksight_job_status) diff --git a/docs/apache-airflow-providers-amazon/operators/quicksight.rst b/docs/apache-airflow-providers-amazon/operators/quicksight.rst index 4a65055b67f80..21948fe8486e6 100644 --- a/docs/apache-airflow-providers-amazon/operators/quicksight.rst +++ b/docs/apache-airflow-providers-amazon/operators/quicksight.rst @@ -15,30 +15,31 @@ specific language governing permissions and limitations under the License. +================= +Amazon QuickSight +================= -Amazon QuickSight Operators -======================================== +`Amazon QuickSight `__ is a fast business analytics service to build visualizations, +perform ad hoc analysis, and quickly get business insights from your data. +Amazon QuickSight seamlessly discovers AWS data sources, enables organizations to scale to hundreds of thousands of +users, and delivers fast and responsive query performance by using the Amazon QuickSight Super-fast, +Parallel, In-Memory, Calculation Engine (SPICE). Prerequisite Tasks ------------------ .. include:: _partials/prerequisite_tasks.rst -Overview --------- - -Airflow to Amazon QuickSight integration allows users to create and start the SPICE ingestion for dataset. - - - :class:`~airflow.providers.amazon.aws.operators.quicksight.QuickSightCreateIngestionOperator` - - :class:`~airflow.providers.amazon.aws.sensor.quicksight.QuickSightSensor` +Operators +--------- .. _howto/operator:QuickSightCreateIngestionOperator: -Amazon QuickSight CreateIngestion Operator -""""""""""""""""""""""""""""""""""""""""""" +Amazon QuickSight create ingestion +================================== -The QuickSightCreateIngestionOperator Creates and starts a new SPICE ingestion for a dataset. -The operator also refreshes existing SPICE datasets +The ``QuickSightCreateIngestionOperator`` creates and starts a new SPICE ingestion for a dataset. +The operator also refreshes existing SPICE datasets. .. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_quicksight.py :language: python @@ -46,12 +47,15 @@ The operator also refreshes existing SPICE datasets :start-after: [START howto_operator_quicksight_create_ingestion] :end-before: [END howto_operator_quicksight_create_ingestion] +Sensors +------- + .. _howto/sensor:QuickSightSensor: -Amazon QuickSight Sensor -"""""""""""""""""""""""" +Amazon QuickSight ingestion sensor +================================== -The QuickSightSensor wait for Amazon QuickSight CreateIngestion until it reaches a terminal state +The ``QuickSightSensor`` waits for an Amazon QuickSight create ingestion until it reaches a terminal state. .. exampleinclude:: /../../airflow/providers/amazon/aws/example_dags/example_quicksight.py :language: python diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 703c713644c33..eb8f6d7795c27 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -892,6 +892,7 @@ hiveconfs hivemeta hiveserver hmsclient +hoc homebrew honoured hookable