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