airflow.providers.amazon.aws.operators.athena

Module Contents

Classes

AthenaOperator

An operator that submits a presto query to athena.

AWSAthenaOperator

This operator is deprecated.
class airflow.providers.amazon.aws.operators.athena.AthenaOperator(*, query: str, database: str, output_location: str, aws_conn_id: str = 'aws_default', client_request_token: Optional[str] = None, workgroup: str = 'primary', query_execution_context: Optional[Dict[str, str]] = None, result_configuration: Optional[Dict[str, Any]] = None, sleep_time: int = 30, max_tries: Optional[int] = None, **kwargs: Any)[source]

Bases: airflow.models.BaseOperator

An operator that submits a presto query to athena.

See also

For more information on how to use this operator, take a look at the guide: Amazon Athena Operator

Parameters

  • query (str) -- Presto to be run on athena. (templated)

  • database (str) -- Database to select. (templated)

  • output_location (str) -- s3 path to write the query results into. (templated)

  • aws_conn_id (str) -- aws connection to use

  • client_request_token (str) -- Unique token created by user to avoid multiple executions of same query

  • workgroup (str) -- Athena workgroup in which query will be run

  • query_execution_context (dict) -- Context in which query need to be run

  • result_configuration (dict) -- Dict with path to store results in and config related to encryption

  • sleep_time (int) -- Time (in seconds) to wait between two consecutive calls to check query status on Athena

  • max_tries (int) -- Number of times to poll for query state before function exits

ui_color = #44b5e2[source]
template_fields :Sequence[str] = ['query', 'database', 'output_location'][source]
template_ext :Sequence[str] = ['.sql'][source]
template_fields_renderers[source]
hook(self) → airflow.providers.amazon.aws.hooks.athena.AthenaHook[source]

Create and return an AthenaHook.

execute(self, context: airflow.utils.context.Context) → Optional[str][source]

Run Presto Query on Athena

on_kill(self) → None[source]

Cancel the submitted athena query

class airflow.providers.amazon.aws.operators.athena.AWSAthenaOperator(*args, **kwargs)[source]

Bases: AthenaOperator

This operator is deprecated. Please use airflow.providers.amazon.aws.operators.athena.AthenaOperator.

Was this entry helpful?