[AIRFLOW-3174] Refine Docstring for SQL Operators #4023
Conversation
Codecov Report
@@ Coverage Diff @@
## master #4023 +/- ##
=======================================
Coverage 75.77% 75.77%
=======================================
Files 199 199
Lines 15946 15946
=======================================
Hits 12083 12083
Misses 3863 3863
Continue to review full report at Codecov.
|
XD-DENG
changed the title
airflow/operators/jdbc_operator.py
Outdated
| @@ -34,6 +34,8 @@ class JdbcOperator(BaseOperator): | |||
| :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 parameters: (optional) the parameters to render the SQL query with. | |||
There was a problem hiding this comment.
autocommit is also missing here :)
airflow/operators/mssql_operator.py
Outdated
| @@ -31,6 +31,8 @@ class MsSqlOperator(BaseOperator): | |||
| :param sql: the sql code to be executed | |||
| :type sql: str or string pointing to a template file with .sql | |||
| extension. (templated) | |||
| :param parameters: (optional) the parameters to render the SQL query with. | |||
| :type parameters: mapping or iterable | |||
There was a problem hiding this comment.
Could you fix the order? :) The sql one comes before mssql_conn_id, but in the docstring it is the other way around. Also autocommit is missing here.
airflow/operators/mysql_operator.py
Outdated
| @@ -32,6 +32,8 @@ class MySqlOperator(BaseOperator): | |||
| :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 parameters: (optional) the parameters to render the SQL query with. | |||
There was a problem hiding this comment.
Could you fix the order? :) The sql one comes before mssql_conn_id, but in the docstring it is the other way around. Also autocommit is missing here.
airflow/operators/oracle_operator.py
Outdated
| @@ -32,6 +32,8 @@ class OracleOperator(BaseOperator): | |||
| :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 parameters: (optional) the parameters to render the SQL query with. | |||
There was a problem hiding this comment.
Could you fix the order? :) The sql one comes before mssql_conn_id, but in the docstring it is the other way around. Also autocommit is missing here.
| @@ -31,6 +31,8 @@ class PostgresOperator(BaseOperator): | |||
| :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 parameters: (optional) the parameters to render the SQL query with. | |||
There was a problem hiding this comment.
Could you fix the order? :) The sql one comes before mssql_conn_id, but in the docstring it is the other way around. Also autocommit is missing here.
airflow/operators/sqlite_operator.py
Outdated
| @@ -31,6 +31,8 @@ class SqliteOperator(BaseOperator): | |||
| :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 parameters: (optional) the parameters to render the SQL query with. | |||
| :type parameters: mapping or iterable | |||
There was a problem hiding this comment.
Could you fix the order? :) The sql one comes before mssql_conn_id, but in the docstring it is the other way around.
JIRA
https://issues.apache.org/jira/browse/AIRFLOW-3174
Description
These SQL operators (based on
DbApiHook) receivesqlandparameters(optional) as arguments. Butparameterswere not documented.The contents I added is based on the docstring in https://github.com/apache/incubator-airflow/blob/master/airflow/hooks/dbapi_hook.py#L88