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

datafusion_functions_table/
lib.rs
