blob: dfdd3b6216bfd82ccdb7c25ed0eb3856e72d7897 [file] [log] [blame]
:py:mod:`airflow.providers.amazon.aws.transfers.exasol_to_s3`
=============================================================
.. py:module:: airflow.providers.amazon.aws.transfers.exasol_to_s3
.. autoapi-nested-parse::
Transfers data from Exasol database into a S3 Bucket.
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
airflow.providers.amazon.aws.transfers.exasol_to_s3.ExasolToS3Operator
.. py:class:: ExasolToS3Operator(*, query_or_table, key, bucket_name = None, replace = False, encrypt = False, gzip = False, acl_policy = None, query_params = None, export_params = None, exasol_conn_id = 'exasol_default', aws_conn_id = 'aws_default', **kwargs)
Bases: :py:obj:`airflow.models.BaseOperator`
Export data from Exasol database to AWS S3 bucket.
:param query_or_table: the sql statement to be executed or table name to export
:param key: S3 key that will point to the file
:param bucket_name: Name of the bucket in which to store the file
:param replace: A flag to decide whether or not to overwrite the key
if it already exists. If replace is False and the key exists, an
error will be raised.
:param encrypt: If True, the file will be encrypted on the server-side
by S3 and will be stored in an encrypted form while at rest in S3.
:param gzip: If True, the file will be compressed locally
:param acl_policy: String specifying the canned ACL policy for the file being
uploaded to the S3 bucket.
:param query_params: Query parameters passed to underlying ``export_to_file``
method of :class:`~pyexasol.connection.ExaConnection`.
:param export_params: Extra parameters passed to underlying ``export_to_file``
method of :class:`~pyexasol.connection.ExaConnection`.
.. py:attribute:: template_fields
:annotation: :Sequence[str] = ['query_or_table', 'key', 'bucket_name', 'query_params', 'export_params']
.. py:attribute:: template_fields_renderers
.. py:attribute:: template_ext
:annotation: :Sequence[str] = ['.sql']
.. py:attribute:: ui_color
:annotation: = #ededed
.. py:method:: execute(self, context)
This is the main method to derive when creating an operator.
Context is the same dictionary used as when rendering jinja templates.
Refer to get_template_context for more context.