Skip to content

docs: clarify AssetAlias usage#67392

Open
Will-thom wants to merge 1 commit into
apache:mainfrom
Will-thom:issue-52250-assetalias-docs
Open

docs: clarify AssetAlias usage#67392
Will-thom wants to merge 1 commit into
apache:mainfrom
Will-thom:issue-52250-assetalias-docs

Conversation

@Will-thom

@Will-thom Will-thom commented May 23, 2026

Copy link
Copy Markdown

Closes #52250. Clarifies when to use AssetAlias: when the concrete asset URI is only known at runtime, while the task still needs to declare a stable outlet dependency. Validation: git diff --check for airflow-core/docs/authoring-and-scheduling/assets.rst and targeted text search.


Important

🛠️ Maintainer triage note for @Will-thom · by @potiuk · 2026-06-17 18:53 UTC

Some review feedback from Lee-W, RNHTTR is waiting on you:

The ball is in your court — you've been assigned to this PR. Reply or push a fix in each thread, then mark them resolved.

Automated triage — may be imperfect; a maintainer takes the next look.

@potiuk potiuk added the ready for maintainer review Set after triaging when all criteria pass. label May 27, 2026
@eladkal eladkal requested a review from Lee-W June 10, 2026 11:24
@eladkal eladkal added this to the Airflow 3.3.0 milestone Jun 10, 2026
@eladkal eladkal added the type:doc-only Changelog: Doc Only label Jun 10, 2026
@eladkal eladkal requested a review from RNHTTR June 10, 2026 11:24

@Lee-W Lee-W left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one nit

Dynamic data events emitting and asset creation through AssetAlias
-----------------------------------------------------------------------
An asset alias can be used to emit asset events of assets with association to the aliases. Downstreams can depend on resolved asset. This feature allows you to define complex dependencies for Dag executions based on asset updates.
Use ``AssetAlias`` when a task must declare an asset dependency before the concrete asset URI is

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use ``AssetAlias`` when a task must declare an asset dependency before the concrete asset URI is
Use ``AssetAlias`` when a task must declare an asset dependency before the concrete asset attributes (i.e., URI, name) are

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

imo we should not use "i.e.". What about

Use AssetAlias when a task must declare an asset dependency before the Asset's fixed attributes (like URI or name) are available.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as lone as we use both name and uri, I'm good 👀

-----------------------------------------------------------------------
An asset alias can be used to emit asset events of assets with association to the aliases. Downstreams can depend on resolved asset. This feature allows you to define complex dependencies for Dag executions based on asset updates.
Use ``AssetAlias`` when a task must declare an asset dependency before the concrete asset URI is
known. The alias is listed in ``outlets`` as a stable name, and the task resolves it at runtime by

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "stable name" mean? What does "concrete" mean?

Use ``AssetAlias`` when a task must declare an asset dependency before the concrete asset URI is
known. The alias is listed in ``outlets`` as a stable name, and the task resolves it at runtime by
adding one or more concrete ``Asset`` objects through ``outlet_events`` or yielded ``Metadata``.
Downstream Dags can depend on the alias, and Airflow triggers them when events are emitted for the

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"trigger" is kind of an overloaded term in Airflow. Maybe we should say "...and Airflow initiates a Dag run when..."

@vatsrahul1001

Copy link
Copy Markdown
Contributor

@Will-thom can you resolve open conversations?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation ready for maintainer review Set after triaging when all criteria pass. type:doc-only Changelog: Doc Only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs on AssetAlias are confusing

7 participants