docs-archive/apache-airflow-providers-mysql/3.0.0/_sources/_api/airflow/providers/mysql/transfers/s3_to_mysql/index.rst.txt

:py:mod:`airflow.providers.mysql.transfers.s3_to_mysql`
=======================================================

.. py:module:: airflow.providers.mysql.transfers.s3_to_mysql


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   airflow.providers.mysql.transfers.s3_to_mysql.S3ToMySqlOperator




.. py:class:: S3ToMySqlOperator(*, s3_source_key, mysql_table, mysql_duplicate_key_handling = 'IGNORE', mysql_extra_options = None, aws_conn_id = 'aws_default', mysql_conn_id = 'mysql_default', **kwargs)

   Bases: :py:obj:`airflow.models.BaseOperator`

   Loads a file from S3 into a MySQL table.

   :param s3_source_key: The path to the file (S3 key) that will be loaded into MySQL.
   :param mysql_table: The MySQL table into where the data will be sent.
   :param mysql_duplicate_key_handling: Specify what should happen to duplicate data.
       You can choose either `IGNORE` or `REPLACE`.

       .. seealso::
           https://dev.mysql.com/doc/refman/8.0/en/load-data.html#load-data-duplicate-key-handling
   :param mysql_extra_options: MySQL options to specify exactly how to load the data.
   :param aws_conn_id: The S3 connection that contains the credentials to the S3 Bucket.
   :param mysql_conn_id: Reference to :ref:`mysql connection id <howto/connection:mysql>`.

   .. py:attribute:: template_fields
      :annotation: :Sequence[str] = ['s3_source_key', 'mysql_table']

      

   .. py:attribute:: template_ext
      :annotation: :Sequence[str] = []

      

   .. py:attribute:: ui_color
      :annotation: = #f4a460

      

   .. py:method:: execute(self, context)

      Executes the transfer operation from S3 to MySQL.

      :param context: The context that is being provided when executing.