datafusion_functions_table/
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// Make sure fast / cheap clones on Arc are explicit:
24// https://github.com/apache/datafusion/issues/11143
25#![cfg_attr(not(test), deny(clippy::clone_on_ref_ptr))]
26
27pub mod generate_series;
28
29use datafusion_catalog::TableFunction;
30use std::sync::Arc;
31
32/// Returns all default table functions
33pub fn all_default_table_functions() -> Vec<Arc<TableFunction>> {
34    vec![generate_series(), range()]
35}
36
37/// Creates a singleton instance of a table function
38/// - `$module`: A struct implementing `TableFunctionImpl` to create the function from
39/// - `$name`: The name to give to the created function
40///
41/// This is used to ensure creating the list of `TableFunction` only happens once.
42#[macro_export]
43macro_rules! create_udtf_function {
44    ($module:path, $name:expr) => {
45        paste::paste! {
46            pub fn [<$name:lower>]() -> Arc<TableFunction> {
47                static INSTANCE: std::sync::LazyLock<Arc<TableFunction>> =
48                    std::sync::LazyLock::new(|| {
49                        std::sync::Arc::new(TableFunction::new(
50                            $name.to_string(),
51                            Arc::new($module {}),
52                        ))
53                    });
54                std::sync::Arc::clone(&INSTANCE)
55            }
56        }
57    };
58}
59
60create_udtf_function!(generate_series::GenerateSeriesFunc, "generate_series");
61create_udtf_function!(generate_series::RangeFunc, "range");
datafusion_functions_table/lib.rs

datafusion_functions_table/
lib.rs
