Adding MySql howto-documentation and example DAG (#12077)

closes #11918

airflow/providers/mysql/example_dags/__init__.py

@@ -0,0 +1,17 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

airflow/providers/mysql/example_dags/example_mysql.py

@@ -0,0 +1,56 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""
+Example use of MySql related operators.
+"""
+
+from airflow import DAG
+from airflow.operators.mysql_operator import MySqlOperator
+from airflow.utils.dates import days_ago
+
+default_args = {
+    'owner': 'airflow',
+}
+
+dag = DAG(
+    'example_mysql',
+    default_args=default_args,
+    start_date=days_ago(2),
+    tags=['example'],
+)
+
+# [START howto_operator_mysql]
+
+drop_table_mysql_task = MySqlOperator(
+    task_id='create_table_mysql', mysql_conn_id='mysql_conn_id', sql=r"""DROP TABLE table_name;""", dag=dag
+)
+
+# [END howto_operator_mysql]
+
+# [START howto_operator_mysql_external_file]
+
+mysql_task = MySqlOperator(
+    task_id='create_table_mysql_external_file',
+    mysql_conn_id='mysql_conn_id',
+    sql='/scripts/drop_table.sql',
+    dag=dag,
+)
+
+# [END howto_operator_mysql_external_file]
+
+drop_table_mysql_task >> mysql_task

docs/howto/operator/index.rst

@@ -40,6 +40,7 @@ determine what actually executes when your DAG runs.
     jdbc
     kubernetes
     microsoft/index
+    mysql
     papermill
     python
     snowflake

docs/howto/operator/mysql.rst

@@ -0,0 +1,69 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+
+
+.. _howto/operator:MySqlOperator:
+
+MySqlOperator
+=================
+
+Use the :class:`~airflow.providers.mysql.operators.MySqlOperator` to execute
+SQL commands in a `MySql <https://dev.mysql.com/doc/>`__ database.
+
+
+Using the Operator
+^^^^^^^^^^^^^^^^^^
+
+Use the ``mysql_conn_id`` argument to connect to your MySql instance where
+the connection metadata is structured as follows:
+
+.. list-table:: MySql Airflow Connection Metadata
+   :widths: 25 25
+   :header-rows: 1
+
+   * - Parameter
+     - Input
+   * - Host: string
+     - MySql hostname
+   * - Schema: string
+     - Set schema to execute Sql operations on by default
+   * - Login: string
+     - MySql user
+   * - Password: string
+     - MySql user password
+   * - Port: int
+     - MySql port
+
+An example usage of the MySqlOperator is as follows:
+
+.. exampleinclude:: /../airflow/providers/mysql/example_dags/example_mysql.py
+    :language: python
+    :start-after: [START howto_operator_mysql]
+    :end-before: [END howto_operator_mysql]
+
+You can also use an external file to execute the SQL commands. Script folder must be at the same level as DAG.py file.
+
+.. exampleinclude:: /../airflow/providers/mysql/example_dags/example_mysql.py
+    :language: python
+    :start-after: [START howto_operator_mysql_external_file]
+    :end-before: [END howto_operator_mysql_external_file]
+
+.. note::
+
+  Parameters that can be passed onto the operator will be given priority over the parameters already given
+  in the Airflow connection metadata (such as ``schema``, ``login``, ``password`` and so forth).

docs/operators-and-hooks-ref.rst

@@ -1315,6 +1315,12 @@ These integrations allow you to perform various operations within various servic
      - :mod:`airflow.providers.jenkins.operators.jenkins_job_trigger`
      -
 
+   * - `MySql <https://www.mysql.com/>`__
+     - :doc:`How to use <howto/operator/mysql>`
+     - :mod:`airflow.providers.snowflake.hooks.mysql`
+     - :mod:`airflow.providers.snowflake.operators.mysql`
+     -
+
    * - `Opsgenie <https://www.opsgenie.com/>`__
      -
      - :mod:`airflow.providers.opsgenie.hooks.opsgenie_alert`