1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use syn::{Error, Result};
mod gen;
mod parse;
mod struct_type;
mod types;
mod utils;
/// Derive `StructType` for user defined struct.
///
/// Structs that implement `StructType` can be used as Arrow struct types.
///
/// # Examples
///
/// ```ignore
/// #[derive(StructType)]
/// struct KeyValue<'a> {
/// key: &'a str,
/// value: &'a str,
/// }
/// ```
///
/// ```ignore
/// #[function("split_kv(string) -> struct KeyValue")]
/// fn split_kv(kv: &str) -> Option<KeyValue<'_>> {
/// let (key, value) = kv.split_once('=')?;
/// Some(KeyValue { key, value })
/// }
/// ```
#[proc_macro_derive(StructType)]
pub fn struct_type(tokens: proc_macro::TokenStream) -> proc_macro::TokenStream {
match struct_type::gen(tokens.into()) {
Ok(output) => output.into(),
Err(err) => err.to_compile_error().into(),
}
}
/// Defining a function on Arrow arrays.
///
/// # Table of Contents
///
/// - [SQL Function Signature](#sql-function-signature)
/// - [Multiple Function Definitions](#multiple-function-definitions)
/// - [Rust Function Signature](#rust-function-signature)
/// - [Nullable Arguments](#nullable-arguments)
/// - [Return Value](#return-value)
/// - [Optimization](#optimization)
/// - [Functions Returning Strings](#functions-returning-strings)
/// - [Table Function](#table-function)
/// - [Registration and Invocation](#registration-and-invocation)
/// - [Appendix: Type Matrix](#appendix-type-matrix)
///
/// The following example demonstrates a simple usage:
///
/// ```ignore
/// #[function("add(int, int) -> int")]
/// fn add(x: i32, y: i32) -> i32 {
/// x + y
/// }
/// ```
///
/// # SQL Function Signature
///
/// Each function must have a signature, specified in the `function("...")` part of the macro
/// invocation. The signature follows this pattern:
///
/// ```text
/// name ( [arg_types],* [...] ) [ -> [setof] return_type ]
/// ```
///
/// Where `name` is the function name.
///
/// `arg_types` is a comma-separated list of argument types. The allowed data types are listed in
/// in the `name` column of the appendix's [type matrix]. Wildcards or `auto` can also be used, as
/// explained below. If the function is variadic, the last argument can be denoted as `...`.
///
/// When `setof` appears before the return type, this indicates that the function is a set-returning
/// function (table function), meaning it can return multiple values instead of just one. For more
/// details, see the section on table functions.
///
/// If no return type is specified, the function returns `null`.
///
/// ## Multiple Function Definitions
///
/// Multiple `#[function]` macros can be applied to a single generic Rust function to define
/// multiple SQL functions of different types. For example:
///
/// ```ignore
/// #[function("add(int16, int16) -> int16")]
/// #[function("add(int32, int32) -> int32")]
/// #[function("add(int64, int64) -> int64")]
/// fn add<T: Add>(x: T, y: T) -> T {
/// x + y
/// }
/// ```
///
/// # Rust Function Signature
///
/// The `#[function]` macro can handle various types of Rust functions.
/// Each argument corresponds to the *Rust type* `T` in the [type matrix].
/// The return value type can be any type that implements `AsRef<T>`.
///
/// ## Nullable Arguments
///
/// The functions above will only be called when all arguments are not null. If null arguments need
/// to be considered, the `Option` type can be used:
///
/// ```ignore
/// #[function("add(int, int) -> int")]
/// fn add(x: Option<i32>, y: i32) -> i32 {...}
/// ```
///
/// ## Return Value
///
/// Similarly, the return value type can be one of the following:
///
/// - `T`: Indicates that a non-null value is always returned, and errors will not occur.
/// - `Option<T>`: Indicates that a null value may be returned, but errors will not occur.
/// - `Result<T>`: Indicates that an error may occur, but a null value will not be returned.
/// - `Result<Option<T>>`: Indicates that a null value may be returned, and an error may also occur.
///
/// ## Optimization
///
/// When all input and output types of the function are *primitive type* (int2, int4, int8, float4, float8)
/// and do not contain any Option or Result, the `#[function]` macro will automatically
/// generate SIMD vectorized execution code.
///
/// Therefore, try to avoid returning `Option` and `Result` whenever possible.
///
/// ## Functions Returning Strings
///
/// For functions that return string types, you can also use the writer style function signature to
/// avoid memory copying and dynamic memory allocation:
///
/// ```ignore
/// #[function("trim(string) -> string")]
/// fn trim(s: &str, writer: &mut impl Write) {
/// writer.write_str(s.trim()).unwrap();
/// }
/// ```
///
/// If errors may be returned, then the return value should be `Result<()>`:
///
/// ```ignore
/// #[function("trim(string) -> string")]
/// fn trim(s: &str, writer: &mut impl Write) -> Result<()> {
/// writer.write_str(s.trim()).unwrap();
/// Ok(())
/// }
/// ```
///
/// If null values may be returned, then the return value should be `Option<()>`:
///
/// ```ignore
/// #[function("trim(string) -> string")]
/// fn trim(s: &str, writer: &mut impl Write) -> Option<()> {
/// if s.is_empty() {
/// None
/// } else {
/// writer.write_str(s.trim()).unwrap();
/// Some(())
/// }
/// }
/// ```
///
/// # Table Function
///
/// A table function is a special kind of function that can return multiple values instead of just
/// one. Its function signature must include the `setof` keyword, and the Rust function should
/// return an iterator of the form `impl Iterator<Item = T>` or its derived types.
///
/// For example:
/// ```ignore
/// #[function("generate_series(int32, int32) -> setof int32")]
/// fn generate_series(start: i32, stop: i32) -> impl Iterator<Item = i32> {
/// start..=stop
/// }
/// ```
///
/// Likewise, the return value `Iterator` can include `Option` or `Result` either internally or
/// externally. For instance:
///
/// - `impl Iterator<Item = Result<T>>`
/// - `Result<impl Iterator<Item = T>>`
/// - `Result<impl Iterator<Item = Result<Option<T>>>>`
///
/// # Registration and Invocation
///
/// Every function defined by `#[function]` is automatically registered in the global function registry.
///
/// You can lookup the function by name and types:
///
/// ```ignore
/// use arrow_udf::sig::REGISTRY;
/// use arrow_schema::DataType::Int32;
///
/// let sig = REGISTRY.get("add", &[Int32, Int32], &Int32).unwrap();
/// ```
///
/// # Appendix: Type Matrix
///
/// ## Base Types
///
/// | Arrow data type | Aliases | Rust type as argument | Rust type as return value |
/// | -------------------- | ------------------ | ------------------------------ | ------------------------------ |
/// | `boolean` | `bool` | `bool` | `bool` |
/// | `int8` | | `i8` | `i8` |
/// | `int16` | `smallint` | `i16` | `i16` |
/// | `int32` | `int` | `i32` | `i32` |
/// | `int64` | `bigint` | `i64` | `i64` |
/// | `float32` | `real` | `f32` | `f32` |
/// | `float32` | `double precision` | `f64` | `f64` |
/// | `date32` | `date` | [`chrono::NaiveDate`] | [`chrono::NaiveDate`] |
/// | `time64` | `time` | [`chrono::NaiveTime`] | [`chrono::NaiveTime`] |
/// | `timestamp` | | [`chrono::NaiveDateTime`] | [`chrono::NaiveDateTime`] |
/// | `timestamptz` | | not supported yet | not supported yet |
/// | `interval` | | [`arrow_udf::types::Interval`] | [`arrow_udf::types::Interval`] |
/// | `string` | `varchar` | `&str` | `impl AsRef<str>`, e.g. `String`, `Box<str>`, `&str` |
/// | `binary` | `bytea` | `&[u8]` | `impl AsRef<[u8]>`, e.g. `Vec<u8>`, `Box<[u8]>`, `&[u8]` |
///
/// ## Extension Types
///
/// We also support the following extension types that are not part of the Arrow data types:
///
/// | Data type | Metadata | Rust type as argument | Rust type as return value |
/// | ----------- | ------------------- | ------------------------------ | ------------------------------ |
/// | `decimal` | `arrowudf.decimal` | [`rust_decimal::Decimal`] | [`rust_decimal::Decimal`] |
/// | `json` | `arrowudf.json` | [`serde_json::Value`] | [`serde_json::Value`] |
///
/// ## Array Types
///
/// | SQL type | Rust type as argument | Rust type as return value |
/// | -------------------- | ------------------------- | ------------------------------ |
/// | `int8[]` | `&[i8]` | `impl Iterator<Item = i8>` |
/// | `int16[]` | `&[i16]` | `impl Iterator<Item = i16>` |
/// | `int32[]` | `&[i32]` | `impl Iterator<Item = i32>` |
/// | `int64[]` | `&[i64]` | `impl Iterator<Item = i64>` |
/// | `float32[]` | `&[f32]` | `impl Iterator<Item = f32>` |
/// | `float64[]` | `&[f64]` | `impl Iterator<Item = f64>` |
/// | `string[]` | [`&StringArray`] | `impl Iterator<Item = &str>` |
/// | `binary[]` | [`&BinaryArray`] | `impl Iterator<Item = &[u8]>` |
/// | `largestring[]` | [`&LargeStringArray`] | `impl Iterator<Item = &str>` |
/// | `largebinary[]` | [`&LargeBinaryArray`] | `impl Iterator<Item = &[u8]>` |
/// | `others[]` | not supported yet | not supported yet |
///
/// ## Composite Types
///
/// | SQL type | Rust type as argument | Rust type as return value |
/// | --------------------- | ------------------------- | ------------------------------ |
/// | `struct<..>` | `UserDefinedStruct` | `UserDefinedStruct` |
///
/// [type matrix]: #appendix-type-matrix
/// [`rust_decimal::Decimal`]: https://docs.rs/rust_decimal/1.33.1/rust_decimal/struct.Decimal.html
/// [`chrono::NaiveDate`]: https://docs.rs/chrono/0.4.31/chrono/naive/struct.NaiveDate.html
/// [`chrono::NaiveTime`]: https://docs.rs/chrono/0.4.31/chrono/naive/struct.NaiveTime.html
/// [`chrono::NaiveDateTime`]: https://docs.rs/chrono/0.4.31/chrono/naive/struct.NaiveDateTime.html
/// [`arrow_udf::types::Interval`]: https://docs.rs/arrow_udf/0.1.0/arrow_udf/types/struct.Interval.html
/// [`serde_json::Value`]: https://docs.rs/serde_json/1.0.108/serde_json/enum.Value.html
/// [`&StringArray`]: https://docs.rs/arrow/50.0.0/arrow/array/type.StringArray.html
/// [`&BinaryArray`]: https://docs.rs/arrow/50.0.0/arrow/array/type.BinaryArray.html
/// [`&LargeStringArray`]: https://docs.rs/arrow/50.0.0/arrow/array/type.LargeStringArray.html
/// [`&LargeBinaryArray`]: https://docs.rs/arrow/50.0.0/arrow/array/type.LargeBinaryArray.html
#[proc_macro_attribute]
pub fn function(attr: TokenStream, item: TokenStream) -> TokenStream {
fn inner(attr: TokenStream, item: TokenStream) -> Result<TokenStream2> {
let fn_attr: FunctionAttr = syn::parse(attr)?;
let user_fn: UserFunctionAttr = syn::parse(item.clone())?;
let mut tokens: TokenStream2 = item.into();
for attr in fn_attr.expand() {
tokens.extend(attr.generate_function_descriptor(&user_fn)?);
}
Ok(tokens)
}
match inner(attr, item) {
Ok(tokens) => tokens.into(),
Err(e) => e.to_compile_error().into(),
}
}
#[derive(Debug, Clone, Default)]
struct FunctionAttr {
/// Function name
name: String,
/// Input argument types
args: Vec<String>,
/// Return type
ret: String,
/// Whether it is a table function
is_table_function: bool,
/// Whether it is an append-only aggregate function
append_only: bool,
/// Optional function for batch evaluation.
batch_fn: Option<String>,
/// State type for aggregate function.
/// If not specified, it will be the same as return type.
state: Option<String>,
/// Initial state value for aggregate function.
/// If not specified, it will be NULL.
init_state: Option<String>,
/// Type inference function.
type_infer: Option<String>,
/// Generic type.
generic: Option<String>,
/// Whether the function is volatile.
volatile: bool,
/// Generated batch function name.
/// If not specified, the macro will not generate batch function.
output: Option<String>,
}
/// Attributes from function signature `fn(..)`
#[derive(Debug, Clone)]
#[allow(dead_code)]
struct UserFunctionAttr {
/// Function name
name: String,
/// Whether the function is async.
async_: bool,
/// Whether contains argument `&Context`.
context: bool,
/// Whether contains argument `&mut impl Write`.
write: bool,
/// Whether the last argument type is `retract: bool`.
retract: bool,
/// Whether each argument type is `Option<T>`.
args_option: Vec<bool>,
/// If the first argument type is `&mut T`, then `Some(T)`.
first_mut_ref_arg: Option<String>,
/// The return type kind.
return_type_kind: ReturnTypeKind,
/// The kind of inner type `T` in `impl Iterator<Item = T>`
iterator_item_kind: Option<ReturnTypeKind>,
/// The core return type without `Option` or `Result`.
core_return_type: String,
/// The number of generic types.
generic: usize,
/// The span of return type.
return_type_span: proc_macro2::Span,
}
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
enum ReturnTypeKind {
T,
Option,
Result,
ResultOption,
}
impl ReturnTypeKind {
/// Returns true if the type is `Result<..>`.
const fn is_result(&self) -> bool {
matches!(self, ReturnTypeKind::Result | ReturnTypeKind::ResultOption)
}
}
impl FunctionAttr {
/// Return a unique name that can be used as an identifier.
fn ident_name(&self) -> String {
format!("{}_{}_{}", self.name, self.args.join("_"), self.ret)
.replace("[]", "array")
.replace("...", "variadic")
.replace(['<', ' ', ',', ':'], "_")
.replace('>', "")
.replace("__", "_")
}
/// Return a unique signature of the function.
fn normalize_signature(&self) -> String {
format!(
"{}({}){}{}",
self.name,
self.args.join(","),
if self.is_table_function { "->>" } else { "->" },
self.ret
)
}
}
impl UserFunctionAttr {
/// Returns true if the function is like `fn(T1, T2, .., Tn) -> T`.
fn is_pure(&self) -> bool {
!self.async_
&& !self.write
&& !self.context
&& self.args_option.iter().all(|b| !b)
&& self.return_type_kind == ReturnTypeKind::T
}
/// Returns true if the function may return error.
fn has_error(&self) -> bool {
self.return_type_kind.is_result()
|| matches!(&self.iterator_item_kind, Some(k) if k.is_result())
}
}