justinpakzad opened a new pull request, #59874:
URL: https://github.com/apache/airflow/pull/59874
<!--
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/
-->
closes: #57812
This PR implements bulk XCom deletion functionality. The issue reported that
it's not possible to delete all XComs for a dag run using the `XCom.delete()`
method since task_id and key are required arguments, and direct database
manipulation isn't possible in Airflow 3.
I used the wildcard pattern that I noticed being used in other endpoints in
the codebase. The endpoint can now support both single and bulk deletion
operations. When task_id or key is set to ~, the endpoint skips filtering on
that parameter, allowing for bulk deletion.
I updated delete endpoint to conditionally build the query based on whether
wildcards are present. It's worth noting that this handles deletion from the
database only and not custom backends.
I've also added the corresponding changes to the client-side
`XComOperations.delete()` method to convert None values to ~ before making the
API call, and updated the `BaseXCom.delete()` method to accept optional task_id
and key parameters.
I created tests to cover the different deletion patterns: deleting all XComs
for a run, deleting all keys for a specific task, and deleting a specific key
across all tasks.
Open to any feedback on the approach. Thanks.
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.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
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/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]
