amoghrajesh opened a new pull request, #66699:
URL: https://github.com/apache/airflow/pull/66699
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
http://chris.beams.io/posts/git-commit/
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 (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
Built on top of https://github.com/apache/airflow/pull/66463, so only last
commit is relevant.
### Why?
The global `[state_store] default_retention_days` config applies one
retention window to every task state key. Some keys have meaningfully different
lifetimes, ie: a submitted job ID is useful for the life of a run, while a
short lived lock key might need only hours. Adding an ability to express
per-key retention without changing the global default for everything.
### Current behaviour
All task state keys written via `PUT /state/ti/{id}/{key}` receive
`expires_at = now + default_retention_days`, regardless of the individual key's
intended lifetime as done in: https://github.com/apache/airflow/pull/66463.
### Current behaviour
All task state keys written via `PUT /state/ti/{id}/{key}` receive
`expires_at = now + default_retention_days`, regardless of the individual key's
intended lifetime.
### Proposed change
Adds an optional `retention_days` field to `TaskStatePutBody`. The
operator-supplied value always takes precedence over the global config:
- Positive -- expire this key in N days, overriding the global default.
- `0` -- never expire this key (`expires_at = NULL`), regardless of the
global default.
- None / Omitted -- fall back to `[state_store] default_retention_days` as
before.
Changes span across the full stack: `TaskStatePutBody`,
`BaseStateBackend.set()` / `aset()`, `MetastoreStateBackend._set_task_state()`
/ `_aset_task_state()`, and the execution API route.
### User implications / backcompat
None. `BaseStateBackend.set()` and `aset()` gain a new `retention_days: int
| None = None` keyword argument.
Usage: `backend.set(..., retention_days=7)` to override the retention_days
for that field.
### Testing
Using this dag to set a couple of task_states:
```python
from datetime import datetime
from airflow.sdk import task, DAG
with DAG(dag_id="my_dag_for_task_state_retention_days", schedule=None,
start_date=datetime(2022, 3, 4)) as dag:
@task
def t1(context):
task_state = context["task_state"]
task_state.set("short_lived_key", "short_lived_value",
retention_days=1)
task_state.set("long_lived_key", "long_lived_value",
retention_days=25)
task_state.set("no_lifetime_key", "forever_alive", retention_days=0)
task_state.set("default_lifetime_key", "default_lifetime_value")
t1()
```
Output:
<img width="1696" height="622" alt="image"
src="https://github.com/user-attachments/assets/4fd46286-6b67-49d1-9643-c85009147cec";
/>
- `short_lived_key` has expiry as tomorrow (may 12)
- `long_lived_key` has expiry as 05 June (25 days later)
- `no_lifetime_key` has no lifetime, ie: doesn't expire
- `default_lifetime_key` has lifetime as 30 days (2026-06-10 12:33:41) -
default
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
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]
