datafusion_doc/
udwf.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// Window UDF doc sections for use in public documentation
19pub mod window_doc_sections {
20    use crate::DocSection;
21
22    pub fn doc_sections() -> Vec<DocSection> {
23        vec![
24            DOC_SECTION_AGGREGATE,
25            DOC_SECTION_RANKING,
26            DOC_SECTION_ANALYTICAL,
27        ]
28    }
29
30    pub const DOC_SECTION_AGGREGATE: DocSection = DocSection {
31        include: true,
32        label: "Aggregate Functions",
33        description: Some("All aggregate functions can be used as window functions."),
34    };
35
36    pub const DOC_SECTION_RANKING: DocSection = DocSection {
37        include: true,
38        label: "Ranking Functions",
39        description: None,
40    };
41
42    pub const DOC_SECTION_ANALYTICAL: DocSection = DocSection {
43        include: true,
44        label: "Analytical Functions",
45        description: None,
46    };
47}
datafusion_doc/udwf.rs

datafusion_doc/
udwf.rs
