datafusion_functions_window/
lib.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18#![doc(
19    html_logo_url = "https://raw.githubusercontent.com/apache/datafusion/19fe44cf2f30cbdd63d4a4f52c74055163c6cc38/docs/logos/standalone_logo/logo_original.svg",
20    html_favicon_url = "https://raw.githubusercontent.com/apache/datafusion/19fe44cf2f30cbdd63d4a4f52c74055163c6cc38/docs/logos/standalone_logo/logo_original.svg"
21)]
22#![cfg_attr(docsrs, feature(doc_auto_cfg))]
23
24//! Window Function packages for [DataFusion].
25//!
26//! This crate contains a collection of various window function packages for DataFusion,
27//! implemented using the extension API.
28//!
29//! [DataFusion]: https://crates.io/crates/datafusion
30//!
31
32use std::sync::Arc;
33
34use log::debug;
35
36use datafusion_expr::registry::FunctionRegistry;
37use datafusion_expr::WindowUDF;
38
39#[macro_use]
40pub mod macros;
41
42pub mod cume_dist;
43pub mod lead_lag;
44pub mod nth_value;
45pub mod ntile;
46pub mod rank;
47pub mod row_number;
48
49pub mod planner;
50
51mod utils;
52
53/// Fluent-style API for creating `Expr`s
54pub mod expr_fn {
55    pub use super::cume_dist::cume_dist;
56    pub use super::lead_lag::lag;
57    pub use super::lead_lag::lead;
58    pub use super::nth_value::{first_value, last_value, nth_value};
59    pub use super::ntile::ntile;
60    pub use super::rank::{dense_rank, percent_rank, rank};
61    pub use super::row_number::row_number;
62}
63
64/// Returns all default window functions
65pub fn all_default_window_functions() -> Vec<Arc<WindowUDF>> {
66    vec![
67        cume_dist::cume_dist_udwf(),
68        row_number::row_number_udwf(),
69        lead_lag::lead_udwf(),
70        lead_lag::lag_udwf(),
71        rank::rank_udwf(),
72        rank::dense_rank_udwf(),
73        rank::percent_rank_udwf(),
74        ntile::ntile_udwf(),
75        nth_value::first_value_udwf(),
76        nth_value::last_value_udwf(),
77        nth_value::nth_value_udwf(),
78    ]
79}
80/// Registers all enabled packages with a [`FunctionRegistry`]
81pub fn register_all(
82    registry: &mut dyn FunctionRegistry,
83) -> datafusion_common::Result<()> {
84    let functions: Vec<Arc<WindowUDF>> = all_default_window_functions();
85
86    functions.into_iter().try_for_each(|fun| {
87        let existing_udwf = registry.register_udwf(fun)?;
88        if let Some(existing_udwf) = existing_udwf {
89            debug!("Overwrite existing UDWF: {}", existing_udwf.name());
90        }
91        Ok(()) as datafusion_common::Result<()>
92    })?;
93
94    Ok(())
95}
datafusion_functions_window/lib.rs

datafusion_functions_window/
lib.rs
