[AIRFLOW-3174] Refine Docstring for SQL Operators & Hooks

airflow/hooks/dbapi_hook.py

@@ -191,6 +191,7 @@ def get_autocommit(self, conn):
         Return True if conn.autocommit is set to True.
         Return False if conn.autocommit is not set or set to False or conn
         does not support autocommit.
+
         :param conn: Connection to get autocommit setting from.
         :type conn: connection object.
         :return: connection autocommit setting.

airflow/hooks/mysql_hook.py

@@ -49,6 +49,7 @@ def set_autocommit(self, conn, autocommit):
     def get_autocommit(self, conn):
         """
         MySql connection gets autocommit in a different way.
+
         :param conn: connection to get autocommit setting from.
         :type conn: connection object.
         :return: connection autocommit setting

airflow/operators/jdbc_operator.py

@@ -28,12 +28,17 @@ class JdbcOperator(BaseOperator):
 
     Requires jaydebeapi.
 
-    :param jdbc_conn_id: reference to a predefined database
-    :type jdbc_conn_id: str
     :param sql: the sql code to be executed. (templated)
     :type sql: Can receive a str representing a sql statement,
         a list of str (sql statements), or reference to a template file.
         Template reference are recognized by str ending in '.sql'
+    :param jdbc_conn_id: reference to a predefined database
+    :type jdbc_conn_id: str
+    :param autocommit: if True, each command is automatically committed.
+        (default value: False)
+    :type autocommit: bool
+    :param parameters: (optional) the parameters to render the SQL query with.
+    :type parameters: mapping or iterable
     """
 
     template_fields = ('sql',)

airflow/operators/mssql_operator.py

@@ -26,11 +26,16 @@ class MsSqlOperator(BaseOperator):
     """
     Executes sql code in a specific Microsoft SQL database
 
-    :param mssql_conn_id: reference to a specific mssql database
-    :type mssql_conn_id: str
     :param sql: the sql code to be executed
     :type sql: str or string pointing to a template file with .sql
         extension. (templated)
+    :param mssql_conn_id: reference to a specific mssql database
+    :type mssql_conn_id: str
+    :param parameters: (optional) the parameters to render the SQL query with.
+    :type parameters: mapping or iterable
+    :param autocommit: if True, each command is automatically committed.
+        (default value: False)
+    :type autocommit: bool
     :param database: name of database which overwrite defined one in connection
     :type database: str
     """

airflow/operators/mysql_operator.py

@@ -26,12 +26,17 @@ class MySqlOperator(BaseOperator):
     """
     Executes sql code in a specific MySQL database
 
-    :param mysql_conn_id: reference to a specific mysql database
-    :type mysql_conn_id: str
     :param sql: the sql code to be executed. (templated)
     :type sql: Can receive a str representing a sql statement,
         a list of str (sql statements), or reference to a template file.
         Template reference are recognized by str ending in '.sql'
+    :param mysql_conn_id: reference to a specific mysql database
+    :type mysql_conn_id: str
+    :param parameters: (optional) the parameters to render the SQL query with.
+    :type parameters: mapping or iterable
+    :param autocommit: if True, each command is automatically committed.
+        (default value: False)
+    :type autocommit: bool
     :param database: name of database which overwrite defined one in connection
     :type database: str
     """

airflow/operators/oracle_operator.py

@@ -26,12 +26,17 @@ class OracleOperator(BaseOperator):
     """
     Executes sql code in a specific Oracle database
 
-    :param oracle_conn_id: reference to a specific Oracle database
-    :type oracle_conn_id: str
     :param sql: the sql code to be executed. (templated)
     :type sql: Can receive a str representing a sql statement,
         a list of str (sql statements), or reference to a template file.
         Template reference are recognized by str ending in '.sql'
+    :param oracle_conn_id: reference to a specific Oracle database
+    :type oracle_conn_id: str
+    :param parameters: (optional) the parameters to render the SQL query with.
+    :type parameters: mapping or iterable
+    :param autocommit: if True, each command is automatically committed.
+        (default value: False)
+    :type autocommit: bool
     """
 
     template_fields = ('sql',)

airflow/operators/postgres_operator.py

@@ -25,12 +25,17 @@ class PostgresOperator(BaseOperator):
     """
     Executes sql code in a specific Postgres database
 
-    :param postgres_conn_id: reference to a specific postgres database
-    :type postgres_conn_id: str
     :param sql: the sql code to be executed. (templated)
     :type sql: Can receive a str representing a sql statement,
         a list of str (sql statements), or reference to a template file.
         Template reference are recognized by str ending in '.sql'
+    :param postgres_conn_id: reference to a specific postgres database
+    :type postgres_conn_id: str
+    :param autocommit: if True, each command is automatically committed.
+        (default value: False)
+    :type autocommit: bool
+    :param parameters: (optional) the parameters to render the SQL query with.
+    :type parameters: mapping or iterable
     :param database: name of database which overwrite defined one in connection
     :type database: str
     """

airflow/operators/sqlite_operator.py

@@ -26,11 +26,13 @@ class SqliteOperator(BaseOperator):
     """
     Executes sql code in a specific Sqlite database
 
-    :param sqlite_conn_id: reference to a specific sqlite database
-    :type sqlite_conn_id: str
     :param sql: the sql code to be executed. (templated)
     :type sql: str or string pointing to a template file. File must have
         a '.sql' extensions.
+    :param sqlite_conn_id: reference to a specific sqlite database
+    :type sqlite_conn_id: str
+    :param parameters: (optional) the parameters to render the SQL query with.
+    :type parameters: mapping or iterable
     """
 
     template_fields = ('sql',)