Skip to content

Minor: doc how field name is to be set for WindowUDF #12757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2024
Merged

Minor: doc how field name is to be set for WindowUDF #12757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions datafusion/expr/src/udwf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,10 @@ pub trait WindowUDFImpl: Debug + Send + Sync {
}

/// The [`Field`] of the final result of evaluating this window function.
///
/// Call `field_args.name()` to get the fully qualified name for defining
/// the [`Field`]. For a complete example see the implementation in the
/// [Basic Example](WindowUDFImpl#basic-example) section.
fn field(&self, field_args: WindowUDFFieldArgs) -> Result<Field>;

/// Allows the window UDF to define a custom result ordering.
Expand Down