You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/01/20 21:37:41 UTC
[GitHub] [airflow] Dr-Denzy opened a new pull request #13798: Created rule for SparkJDBCOperator class conn_id
Dr-Denzy opened a new pull request #13798:
URL: https://github.com/apache/airflow/pull/13798
This PR implements an upgrade check for SparkJDBCOperator.
In Airflow 1.10.x, the default name for SparkJDBCOperator class conn_id
is 'spark-default'. From Airflow 2.0, it has been changed to
'spark_default' to conform with the naming conventions of all
other connection names.
closes: #12918
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/master/UPDATING.md).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #13798:
URL: https://github.com/apache/airflow/pull/13798#discussion_r563725388
##########
File path: airflow/upgrade/rules/spark_jdbc_operator_conn_id_rule.py
##########
@@ -0,0 +1,45 @@
+# 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.
+
+from airflow.models import Connection
+from airflow.upgrade.rules.base_rule import BaseRule
+from airflow.utils.db import provide_session
+
+
+class SparkJDBCOperatorConnIdRule(BaseRule):
+ """SparkJDBCOperatorConnIdRule class to ease upgrade to Airflow 2.0"""
+
+ title = "Check Spark JDBC Operator default connection name"
+
+ description = """\
+In Airflow 1.10.x, the default value for SparkJDBCOperator class 'conn_id' is 'spark-default'.
+From Airflow 2.0, it has been changed to 'spark_default' to conform with the naming conventions
+of all other connection names.
+ """
+
+ @provide_session
+ def check(self, session=None):
+ for conn in session.query(Connection.conn_id):
+ if conn.conn_id == 'spark-default':
+ return (
+ "Deprecation Warning: From Airflow 2.0, SparkJDBCOperator class 'conn_id' "
+ "value has been changed to 'spark_default' to conform with the naming "
+ "conventions of all other connection names."
+ "See link below for details:"
+ "https://github.com/apache/airflow/blob/master/"
+ "UPDATING.md#sparkjdbchook-default-connection"
Review comment:
It is not clear from the description of what actions a user needs to perform if the check fails
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil merged pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #13798:
URL: https://github.com/apache/airflow/pull/13798
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil merged pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
kaxil merged pull request #13798:
URL: https://github.com/apache/airflow/pull/13798
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] Dr-Denzy commented on a change in pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
Dr-Denzy commented on a change in pull request #13798:
URL: https://github.com/apache/airflow/pull/13798#discussion_r567095246
##########
File path: airflow/upgrade/rules/spark_jdbc_operator_conn_id_rule.py
##########
@@ -0,0 +1,44 @@
+# 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.
+
+from airflow.models import Connection
+from airflow.upgrade.rules.base_rule import BaseRule
+from airflow.utils.db import provide_session
+
+
+class SparkJDBCOperatorConnIdRule(BaseRule):
+
+ title = "Check Spark JDBC Operator default connection name"
+
+ description = """\
+In Airflow 1.10.x, the default value for SparkJDBCOperator class 'conn_id' is 'spark-default'.
+From Airflow 2.0, it has been changed to 'spark_default' to conform with the naming conventions
+of all other connection names.
+ """
+
+ @provide_session
+ def check(self, session=None):
+ for conn in session.query(Connection.conn_id):
+ if conn.conn_id == 'spark-default':
+ return (
+ "Deprecation Warning: From Airflow 2.0, SparkJDBCOperator class 'conn_id' "
+ "value has been changed to 'spark_default' to conform with the naming "
+ "conventions of all other connection names."
+ "Use 'spark_default' instead of 'spark-default'. See the link below for details: "
+ "https://github.com/apache/airflow/blob/master/"
+ "UPDATING.md#sparkjdbchook-default-connection"
Review comment:
I agree!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #13798:
URL: https://github.com/apache/airflow/pull/13798#discussion_r567016431
##########
File path: airflow/upgrade/rules/spark_jdbc_operator_conn_id_rule.py
##########
@@ -0,0 +1,44 @@
+# 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.
+
+from airflow.models import Connection
+from airflow.upgrade.rules.base_rule import BaseRule
+from airflow.utils.db import provide_session
+
+
+class SparkJDBCOperatorConnIdRule(BaseRule):
+
+ title = "Check Spark JDBC Operator default connection name"
+
+ description = """\
+In Airflow 1.10.x, the default value for SparkJDBCOperator class 'conn_id' is 'spark-default'.
+From Airflow 2.0, it has been changed to 'spark_default' to conform with the naming conventions
+of all other connection names.
+ """
+
+ @provide_session
+ def check(self, session=None):
+ for conn in session.query(Connection.conn_id):
+ if conn.conn_id == 'spark-default':
+ return (
+ "Deprecation Warning: From Airflow 2.0, SparkJDBCOperator class 'conn_id' "
+ "value has been changed to 'spark_default' to conform with the naming "
+ "conventions of all other connection names."
+ "Use 'spark_default' instead of 'spark-default'. See the link below for details: "
+ "https://github.com/apache/airflow/blob/master/"
+ "UPDATING.md#sparkjdbchook-default-connection"
Review comment:
```suggestion
"Deprecation Warning: From Airflow 2.0, the default value of 'conn_id' argument of SparkJDBCOperator class "
"has been changed to 'spark_default' to conform with the naming "
"conventions of all other connection names."
"Please rename the connection with id 'spark-default' to 'spark_default' or explicitly pass 'spark-default' to the operator. See the link below for details: "
"https://github.com/apache/airflow/blob/master/"
"UPDATING.md#sparkjdbchook-default-connection"
```
I think this would be more clearer, what do you think?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #13798:
URL: https://github.com/apache/airflow/pull/13798#discussion_r563725388
##########
File path: airflow/upgrade/rules/spark_jdbc_operator_conn_id_rule.py
##########
@@ -0,0 +1,45 @@
+# 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.
+
+from airflow.models import Connection
+from airflow.upgrade.rules.base_rule import BaseRule
+from airflow.utils.db import provide_session
+
+
+class SparkJDBCOperatorConnIdRule(BaseRule):
+ """SparkJDBCOperatorConnIdRule class to ease upgrade to Airflow 2.0"""
+
+ title = "Check Spark JDBC Operator default connection name"
+
+ description = """\
+In Airflow 1.10.x, the default value for SparkJDBCOperator class 'conn_id' is 'spark-default'.
+From Airflow 2.0, it has been changed to 'spark_default' to conform with the naming conventions
+of all other connection names.
+ """
+
+ @provide_session
+ def check(self, session=None):
+ for conn in session.query(Connection.conn_id):
+ if conn.conn_id == 'spark-default':
+ return (
+ "Deprecation Warning: From Airflow 2.0, SparkJDBCOperator class 'conn_id' "
+ "value has been changed to 'spark_default' to conform with the naming "
+ "conventions of all other connection names."
+ "See link below for details:"
+ "https://github.com/apache/airflow/blob/master/"
+ "UPDATING.md#sparkjdbchook-default-connection"
Review comment:
It is not clear from the description of what actions a user needs to perform if the check fails
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [airflow] kaxil commented on a change in pull request #13798: Created rule for SparkJDBCOperator class conn_id
Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #13798:
URL: https://github.com/apache/airflow/pull/13798#discussion_r567016431
##########
File path: airflow/upgrade/rules/spark_jdbc_operator_conn_id_rule.py
##########
@@ -0,0 +1,44 @@
+# 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.
+
+from airflow.models import Connection
+from airflow.upgrade.rules.base_rule import BaseRule
+from airflow.utils.db import provide_session
+
+
+class SparkJDBCOperatorConnIdRule(BaseRule):
+
+ title = "Check Spark JDBC Operator default connection name"
+
+ description = """\
+In Airflow 1.10.x, the default value for SparkJDBCOperator class 'conn_id' is 'spark-default'.
+From Airflow 2.0, it has been changed to 'spark_default' to conform with the naming conventions
+of all other connection names.
+ """
+
+ @provide_session
+ def check(self, session=None):
+ for conn in session.query(Connection.conn_id):
+ if conn.conn_id == 'spark-default':
+ return (
+ "Deprecation Warning: From Airflow 2.0, SparkJDBCOperator class 'conn_id' "
+ "value has been changed to 'spark_default' to conform with the naming "
+ "conventions of all other connection names."
+ "Use 'spark_default' instead of 'spark-default'. See the link below for details: "
+ "https://github.com/apache/airflow/blob/master/"
+ "UPDATING.md#sparkjdbchook-default-connection"
Review comment:
```suggestion
"Deprecation Warning: From Airflow 2.0, the default value of 'conn_id' argument of SparkJDBCOperator class "
"has been changed to 'spark_default' to conform with the naming "
"conventions of all other connection names."
"Please rename the connection with id 'spark-default' to 'spark_default' or explicitly pass 'spark-default' to the operator. See the link below for details: "
"https://github.com/apache/airflow/blob/2.0.0/"
"UPDATING.md#sparkjdbchook-default-connection"
```
I think this would be more clearer, what do you think?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org