Joffreybvn opened a new pull request, #32319:
URL: https://github.com/apache/airflow/pull/32319
<!--
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.
-->
<!--
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 an 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/
-->
The ODBCHook returns pyodbc.Row objects when used with
SQLExecuteQueryOperator to do SELECT queries, which cause serialization errors
in the XCom backend. This PR follows the [discussion started
here](https://github.com/apache/airflow/discussions/32058#discussioncomment-6263179).
---
A good place to implement the transformation of Row into tuples is after the
execution of the handler, in the
[`run()`](https://github.com/apache/airflow/blob/main/airflow/providers/common/sql/hooks/sql.py#L355)
method. There, the raw data structure is available. Doing it later would imply
to deal with potential nested structure (ex: list of results).
Thus, I propose to add method in the DBApiHook to make the result of a query
serializable. So that child Hook classes can override it to implement their own
logic.
I see that many Hooks based on `DbApiHook` have a custom run method. But
considering @potiuk comment about "[the most standard the
better](https://github.com/apache/airflow/discussions/32058#discussioncomment-6263179)",
I'd ideally go for an extra internal method that Hooks can override, rather
than copying the full run() method just to implement a small change.
Considering also that the pyodbc.Row may not be the only case where a custom
object causes issues ([Databricks could be rewrote to handle that
issue](https://github.com/apache/airflow/pull/31780/files) at Hook level). And
considering that this pattern already exists with the
[`serialize_cell`](https://github.com/apache/airflow/blob/main/airflow/providers/common/sql/hooks/sql.py#L478)
method which get overidden by child hooks.
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+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 a
newsfragment file, named `{pr_number}.significant.rst` or
`{issue_number}.significant.rst`, in
[newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
