Download datafusion_2/solution/solution.patch from lolbench26/LoLBench: direct link, hf CLI and curl.
- Browser
- Download file 59.1 kB
-
https://huggingface.co/datasets/lolbench26/LoLBench/resolve/main/datafusion_2/solution/solution.patch
- Command line
-
hf download hf://datasets/lolbench26/LoLBench/datafusion_2/solution/solution.patch
-
curl -L -o solution.patch https://huggingface.co/datasets/lolbench26/LoLBench/resolve/main/datafusion_2/solution/solution.patch
59.1 kB
| diff --git a/Cargo.lock b/Cargo.lock | |
| --- a/Cargo.lock | |
| +++ b/Cargo.lock | |
| dependencies = [ | |
| "apache-avro", | |
| "arrow", | |
| "arrow-ipc", | |
| + "arrow-schema", | |
| "chrono", | |
| "criterion", | |
| "half", | |
| dependencies = [ | |
| "recursive", | |
| "sqlparser", | |
| "tokio", | |
| + "uuid", | |
| "web-time", | |
| ] | |
| name = "datafusion-expr" | |
| version = "52.1.0" | |
| dependencies = [ | |
| "arrow", | |
| + "arrow-schema", | |
| "async-trait", | |
| "chrono", | |
| "ctor", | |
| diff --git a/datafusion-examples/README.md b/datafusion-examples/README.md | |
| --- a/datafusion-examples/README.md | |
| +++ b/datafusion-examples/README.md | |
| cargo run --example dataframe -- dataframe | |
| | mem_pool_tracking | [`execution_monitoring/memory_pool_tracking.rs`](examples/execution_monitoring/memory_pool_tracking.rs) | Demonstrates memory tracking | | |
| | tracing | [`execution_monitoring/tracing.rs`](examples/execution_monitoring/tracing.rs) | Demonstrates tracing integration | | |
| +## Extension Types Examples | |
| + | |
| +### Group: `extension_types` | |
| + | |
| +#### Category: Single Process | |
| + | |
| +| Subcommand | File Path | Description | | |
| +| ----------- | --------------------------------------------------------------------------- | ------------------------------------ | | |
| +| temperature | [`extension_types/temperature.rs`](examples/extension_types/temperature.rs) | Extension type for temperature data. | | |
| + | |
| ## External Dependency Examples | |
| ### Group: `external_dependency` | |
| diff --git a/datafusion-examples/examples/extension_types/main.rs b/datafusion-examples/examples/extension_types/main.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion-examples/examples/extension_types/main.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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. | |
| + | |
| +//! # Extension type usage examples | |
| +//! | |
| +//! These examples demonstrate the API for creating and using custom extension types. | |
| +//! | |
| +//! ## Usage | |
| +//! ```bash | |
| +//! cargo run --example extension_types -- [all|temperature] | |
| +//! ``` | |
| +//! | |
| +//! Each subcommand runs a corresponding example: | |
| +//! - `all` — run all examples included in this module | |
| +//! | |
| +//! - `temperature` | |
| +//! (file: temperature.rs, desc: Extension type for temperature data.) | |
| + | |
| +mod temperature; | |
| + | |
| +use datafusion::error::{DataFusionError, Result}; | |
| +use strum::{IntoEnumIterator, VariantNames}; | |
| +use strum_macros::{Display, EnumIter, EnumString, VariantNames}; | |
| + | |
| +#[derive(EnumIter, EnumString, Display, VariantNames)] | |
| +#[strum(serialize_all = "snake_case")] | |
| +enum ExampleKind { | |
| + All, | |
| + Temperature, | |
| +} | |
| + | |
| +impl ExampleKind { | |
| + const EXAMPLE_NAME: &str = "extension_types"; | |
| + | |
| + fn runnable() -> impl Iterator<Item = ExampleKind> { | |
| + ExampleKind::iter().filter(|v| !matches!(v, ExampleKind::All)) | |
| + } | |
| + | |
| + async fn run(&self) -> Result<()> { | |
| + match self { | |
| + ExampleKind::All => { | |
| + for example in ExampleKind::runnable() { | |
| + println!("Running example: {example}"); | |
| + Box::pin(example.run()).await?; | |
| + } | |
| + } | |
| + ExampleKind::Temperature => { | |
| + temperature::temperature_example().await?; | |
| + } | |
| + } | |
| + Ok(()) | |
| + } | |
| +} | |
| + | |
| +#[tokio::main] | |
| +async fn main() -> Result<()> { | |
| + let usage = format!( | |
| + "Usage: cargo run --example {} -- [{}]", | |
| + ExampleKind::EXAMPLE_NAME, | |
| + ExampleKind::VARIANTS.join("|") | |
| + ); | |
| + | |
| + let example: ExampleKind = std::env::args() | |
| + .nth(1) | |
| + .unwrap_or_else(|| ExampleKind::All.to_string()) | |
| + .parse() | |
| + .map_err(|_| DataFusionError::Execution(format!("Unknown example. {usage}")))?; | |
| + | |
| + example.run().await | |
| +} | |
| diff --git a/datafusion-examples/examples/extension_types/temperature.rs b/datafusion-examples/examples/extension_types/temperature.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion-examples/examples/extension_types/temperature.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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 arrow::array::{ | |
| + Array, ArrowPrimitiveType, AsArray, Float32Array, Float64Array, PrimitiveArray, | |
| + RecordBatch, StringArray, | |
| +}; | |
| +use arrow::datatypes::{Float32Type, Float64Type}; | |
| +use arrow::util::display::{ArrayFormatter, DisplayIndex, FormatOptions, FormatResult}; | |
| +use arrow_schema::extension::ExtensionType; | |
| +use arrow_schema::{ArrowError, DataType, Field, Schema, SchemaRef}; | |
| +use datafusion::dataframe::DataFrame; | |
| +use datafusion::error::Result; | |
| +use datafusion::execution::SessionStateBuilder; | |
| +use datafusion::prelude::SessionContext; | |
| +use datafusion_common::internal_err; | |
| +use datafusion_common::types::DFExtensionType; | |
| +use datafusion_expr::registry::{ | |
| + DefaultExtensionTypeRegistration, ExtensionTypeRegistry, MemoryExtensionTypeRegistry, | |
| +}; | |
| +use std::fmt::{Display, Write}; | |
| +use std::sync::Arc; | |
| + | |
| +/// This example demonstrates using DataFusion's extension type API to create a custom | |
| +/// extension type [`TemperatureExtensionType`] for representing different temperature units. | |
| +pub async fn temperature_example() -> Result<()> { | |
| + let ctx = create_session_context()?; | |
| + register_temperature_table(&ctx).await?; | |
| + | |
| + // Print the example table with the custom pretty-printer. | |
| + ctx.table("example").await?.show().await | |
| +} | |
| + | |
| +/// Creates the DataFusion session context with the custom extension type implementation. | |
| +fn create_session_context() -> Result<SessionContext> { | |
| + let registry = MemoryExtensionTypeRegistry::new_empty(); | |
| + | |
| + // The registration creates a new instance of the extension type with the deserialized metadata. | |
| + let temp_registration = | |
| + DefaultExtensionTypeRegistration::new_arc(|storage_type, metadata| { | |
| + Ok(TemperatureExtensionType::new( | |
| + storage_type.clone(), | |
| + metadata, | |
| + )) | |
| + }); | |
| + registry.add_extension_type_registration(temp_registration)?; | |
| + | |
| + let state = SessionStateBuilder::default() | |
| + .with_extension_type_registry(Arc::new(registry)) | |
| + .build(); | |
| + Ok(SessionContext::new_with_state(state)) | |
| +} | |
| + | |
| +/// Registers the example table and returns the data frame. | |
| +async fn register_temperature_table(ctx: &SessionContext) -> Result<DataFrame> { | |
| + let schema = example_schema(); | |
| + | |
| + let city_names = Arc::new(StringArray::from(vec![ | |
| + "Vienna", "Tokyo", "New York", "Sydney", | |
| + ])); | |
| + | |
| + // The temperature readings in different units | |
| + let celsius_temps = vec![15.1, 22.5, 18.98, 25.0]; | |
| + let fahrenheit_temps = vec![59.18, 72.5, 66.164, 77.0]; | |
| + let kelvin_temps = vec![288.25, 295.65, 292.13, 298.15]; | |
| + | |
| + let batch = RecordBatch::try_new( | |
| + schema, | |
| + vec![ | |
| + city_names, | |
| + Arc::new(Float64Array::from(celsius_temps)), | |
| + Arc::new(Float64Array::from(fahrenheit_temps)), | |
| + Arc::new(Float32Array::from(kelvin_temps)), // Demonstrate use of different storage type | |
| + ], | |
| + )?; | |
| + | |
| + ctx.register_batch("example", batch)?; | |
| + ctx.table("example").await | |
| +} | |
| + | |
| +/// The schema of the example table. | |
| +fn example_schema() -> SchemaRef { | |
| + Arc::new(Schema::new(vec![ | |
| + Field::new("city", DataType::Utf8, false), | |
| + Field::new("celsius", DataType::Float64, false).with_extension_type( | |
| + TemperatureExtensionType::new(DataType::Float64, TemperatureUnit::Celsius), | |
| + ), | |
| + Field::new("fahrenheit", DataType::Float64, false).with_extension_type( | |
| + TemperatureExtensionType::new(DataType::Float64, TemperatureUnit::Fahrenheit), | |
| + ), | |
| + Field::new("kelvin", DataType::Float32, false).with_extension_type( | |
| + TemperatureExtensionType::new(DataType::Float32, TemperatureUnit::Kelvin), | |
| + ), | |
| + ])) | |
| +} | |
| + | |
| +/// Represents the unit of a temperature reading. | |
| +#[derive(Debug, Clone, Copy, PartialEq, Eq)] | |
| +pub enum TemperatureUnit { | |
| + Celsius, | |
| + Fahrenheit, | |
| + Kelvin, | |
| +} | |
| + | |
| +/// Represents a float that semantically represents a temperature. The temperature can be one of | |
| +/// the supported [`TemperatureUnit`]s. | |
| +/// | |
| +/// The unit is realized as an additional extension type metadata and is stored alongside the | |
| +/// extension type name in the Arrow field metadata. This metadata can also be stored within files, | |
| +/// allowing DataFusion to read temperature data from, for example, Parquet files. | |
| +/// | |
| +/// The field metadata for a Celsius temperature field will look like this (serialized as JSON): | |
| +/// ```json | |
| +/// { | |
| +/// "ARROW:extension:name": "custom.temperature", | |
| +/// "ARROW:extension:metadata": "celsius" | |
| +/// } | |
| +/// ``` | |
| +/// | |
| +/// See [the official Arrow documentation](https://arrow.apache.org/docs/format/Columnar.html#extension-types) | |
| +/// for more details on the extension type mechanism. | |
| +#[derive(Debug)] | |
| +pub struct TemperatureExtensionType { | |
| + /// Extension type instances are always for a specific storage type and metadata pairing. | |
| + /// Therefore, we store the storage type. | |
| + storage_type: DataType, | |
| + /// The unit of the temperature. | |
| + temperature_unit: TemperatureUnit, | |
| +} | |
| + | |
| +impl TemperatureExtensionType { | |
| + /// Creates a new [`TemperatureExtensionType`]. | |
| + pub fn new(storage_type: DataType, temperature_unit: TemperatureUnit) -> Self { | |
| + Self { | |
| + storage_type, | |
| + temperature_unit, | |
| + } | |
| + } | |
| +} | |
| + | |
| +/// Implementation of [`ExtensionType`] for [`TemperatureExtensionType`]. | |
| +/// | |
| +/// This implements the arrow-rs trait for reading, writing, and validating extension types. | |
| +impl ExtensionType for TemperatureExtensionType { | |
| + /// Arrow extension type name that is stored in the `ARROW:extension:name` field. | |
| + const NAME: &'static str = "custom.temperature"; | |
| + type Metadata = TemperatureUnit; | |
| + | |
| + fn metadata(&self) -> &Self::Metadata { | |
| + &self.temperature_unit | |
| + } | |
| + | |
| + /// Arrow extension type metadata is encoded as a string and stored using the | |
| + /// `ARROW:extension:metadata` key. As we only store the name of the unit, a simple string | |
| + /// suffices. Extension types can store more complex metadata using serialization formats like | |
| + /// JSON. | |
| + fn serialize_metadata(&self) -> Option<String> { | |
| + let s = match self.temperature_unit { | |
| + TemperatureUnit::Celsius => "celsius", | |
| + TemperatureUnit::Fahrenheit => "fahrenheit", | |
| + TemperatureUnit::Kelvin => "kelvin", | |
| + }; | |
| + Some(s.to_string()) | |
| + } | |
| + | |
| + /// Inverse operation of [`Self::serialize_metadata`]. This creates the [`TemperatureUnit`] | |
| + /// value from the serialized string. | |
| + fn deserialize_metadata( | |
| + metadata: Option<&str>, | |
| + ) -> std::result::Result<Self::Metadata, ArrowError> { | |
| + match metadata { | |
| + Some("celsius") => Ok(TemperatureUnit::Celsius), | |
| + Some("fahrenheit") => Ok(TemperatureUnit::Fahrenheit), | |
| + Some("kelvin") => Ok(TemperatureUnit::Kelvin), | |
| + Some(other) => Err(ArrowError::InvalidArgumentError(format!( | |
| + "Invalid metadata for temperature type: {other}" | |
| + ))), | |
| + None => Err(ArrowError::InvalidArgumentError( | |
| + "Temperature type requires metadata (unit)".to_owned(), | |
| + )), | |
| + } | |
| + } | |
| + | |
| + /// Checks that the extension type supports a given [`DataType`]. | |
| + fn supports_data_type( | |
| + &self, | |
| + data_type: &DataType, | |
| + ) -> std::result::Result<(), ArrowError> { | |
| + match data_type { | |
| + DataType::Float32 | DataType::Float64 => Ok(()), | |
| + _ => Err(ArrowError::InvalidArgumentError(format!( | |
| + "Invalid data type: {data_type} for temperature type, expected Float32 or Float64", | |
| + ))), | |
| + } | |
| + } | |
| + | |
| + fn try_new( | |
| + data_type: &DataType, | |
| + metadata: Self::Metadata, | |
| + ) -> std::result::Result<Self, ArrowError> { | |
| + let instance = Self::new(data_type.clone(), metadata); | |
| + instance.supports_data_type(data_type)?; | |
| + Ok(instance) | |
| + } | |
| +} | |
| + | |
| +/// Implementation of [`DFExtensionType`] for [`TemperatureExtensionType`]. | |
| +/// | |
| +/// This implements the trait for customizing DataFusion. | |
| +impl DFExtensionType for TemperatureExtensionType { | |
| + fn storage_type(&self) -> DataType { | |
| + self.storage_type.clone() | |
| + } | |
| + | |
| + fn serialize_metadata(&self) -> Option<String> { | |
| + ExtensionType::serialize_metadata(self) | |
| + } | |
| + | |
| + fn create_array_formatter<'fmt>( | |
| + &self, | |
| + array: &'fmt dyn Array, | |
| + options: &FormatOptions<'fmt>, | |
| + ) -> Result<Option<ArrayFormatter<'fmt>>> { | |
| + match self.storage_type { | |
| + DataType::Float32 => { | |
| + let display_index = TemperatureDisplayIndex { | |
| + array: array.as_primitive::<Float32Type>(), | |
| + null_str: options.null(), | |
| + unit: self.temperature_unit, | |
| + }; | |
| + Ok(Some(ArrayFormatter::new( | |
| + Box::new(display_index), | |
| + options.safe(), | |
| + ))) | |
| + } | |
| + DataType::Float64 => { | |
| + let display_index = TemperatureDisplayIndex { | |
| + array: array.as_primitive::<Float64Type>(), | |
| + null_str: options.null(), | |
| + unit: self.temperature_unit, | |
| + }; | |
| + Ok(Some(ArrayFormatter::new( | |
| + Box::new(display_index), | |
| + options.safe(), | |
| + ))) | |
| + } | |
| + _ => internal_err!("Wrong array type for Temperature"), | |
| + } | |
| + } | |
| +} | |
| + | |
| +/// Pretty printer for temperatures. | |
| +#[derive(Debug)] | |
| +struct TemperatureDisplayIndex<'a, TNative: ArrowPrimitiveType<Native: Display>> { | |
| + array: &'a PrimitiveArray<TNative>, | |
| + null_str: &'a str, | |
| + unit: TemperatureUnit, | |
| +} | |
| + | |
| +/// Implements the custom display logic. | |
| +impl<TNative: ArrowPrimitiveType<Native: Display>> DisplayIndex | |
| + for TemperatureDisplayIndex<'_, TNative> | |
| +{ | |
| + fn write(&self, idx: usize, f: &mut dyn Write) -> FormatResult { | |
| + if self.array.is_null(idx) { | |
| + write!(f, "{}", self.null_str)?; | |
| + return Ok(()); | |
| + } | |
| + | |
| + let value = self.array.value(idx); | |
| + let suffix = match self.unit { | |
| + TemperatureUnit::Celsius => "°C", | |
| + TemperatureUnit::Fahrenheit => "°F", | |
| + TemperatureUnit::Kelvin => "K", | |
| + }; | |
| + | |
| + write!(f, "{value:.2} {suffix}")?; | |
| + | |
| + Ok(()) | |
| + } | |
| +} | |
| + | |
| +#[cfg(test)] | |
| +mod tests { | |
| + use super::*; | |
| + use insta::assert_snapshot; | |
| + | |
| + #[tokio::test] | |
| + async fn test_print_example_table() -> Result<()> { | |
| + let ctx = create_session_context()?; | |
| + let table = register_temperature_table(&ctx).await?; | |
| + | |
| + assert_snapshot!( | |
| + table.to_string().await?, | |
| + @r" | |
| + +----------+----------+------------+----------+ | |
| + | city | celsius | fahrenheit | kelvin | | |
| + +----------+----------+------------+----------+ | |
| + | Vienna | 15.10 °C | 59.18 °F | 288.25 K | | |
| + | Tokyo | 22.50 °C | 72.50 °F | 295.65 K | | |
| + | New York | 18.98 °C | 66.16 °F | 292.13 K | | |
| + | Sydney | 25.00 °C | 77.00 °F | 298.15 K | | |
| + +----------+----------+------------+----------+ | |
| + " | |
| + ); | |
| + | |
| + Ok(()) | |
| + } | |
| +} | |
| diff --git a/datafusion/common/Cargo.toml b/datafusion/common/Cargo.toml | |
| --- a/datafusion/common/Cargo.toml | |
| +++ b/datafusion/common/Cargo.toml | |
| apache-avro = { workspace = true, features = [ | |
| ], optional = true } | |
| arrow = { workspace = true } | |
| arrow-ipc = { workspace = true } | |
| +arrow-schema = { workspace = true, features = ["canonical_extension_types"] } | |
| chrono = { workspace = true } | |
| half = { workspace = true } | |
| hashbrown = { workspace = true } | |
| paste = { workspace = true } | |
| recursive = { workspace = true, optional = true } | |
| sqlparser = { workspace = true, optional = true } | |
| tokio = { workspace = true } | |
| +uuid = { workspace = true, features = ["v4"] } | |
| [target.'cfg(target_family = "wasm")'.dependencies] | |
| web-time = "1.1.0" | |
| diff --git a/datafusion/common/src/types/canonical_extensions/mod.rs b/datafusion/common/src/types/canonical_extensions/mod.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion/common/src/types/canonical_extensions/mod.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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. | |
| + | |
| +mod uuid; | |
| diff --git a/datafusion/common/src/types/canonical_extensions/uuid.rs b/datafusion/common/src/types/canonical_extensions/uuid.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion/common/src/types/canonical_extensions/uuid.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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 crate::error::_internal_err; | |
| +use crate::types::extension::DFExtensionType; | |
| +use arrow::array::{Array, FixedSizeBinaryArray}; | |
| +use arrow::datatypes::DataType; | |
| +use arrow::util::display::{ArrayFormatter, DisplayIndex, FormatOptions, FormatResult}; | |
| +use std::fmt::Write; | |
| +use uuid::{Bytes, Uuid}; | |
| + | |
| +/// Defines the extension type logic for the canonical `arrow.uuid` extension type. | |
| +/// | |
| +/// See [`DFExtensionType`] for information on DataFusion's extension type mechanism. | |
| +impl DFExtensionType for arrow_schema::extension::Uuid { | |
| + fn storage_type(&self) -> DataType { | |
| + DataType::FixedSizeBinary(16) | |
| + } | |
| + | |
| + fn serialize_metadata(&self) -> Option<String> { | |
| + None | |
| + } | |
| + | |
| + fn create_array_formatter<'fmt>( | |
| + &self, | |
| + array: &'fmt dyn Array, | |
| + options: &FormatOptions<'fmt>, | |
| + ) -> crate::Result<Option<ArrayFormatter<'fmt>>> { | |
| + if array.data_type() != &DataType::FixedSizeBinary(16) { | |
| + return _internal_err!("Wrong array type for Uuid"); | |
| + } | |
| + | |
| + let display_index = UuidValueDisplayIndex { | |
| + array: array.as_any().downcast_ref().unwrap(), | |
| + null_str: options.null(), | |
| + }; | |
| + Ok(Some(ArrayFormatter::new( | |
| + Box::new(display_index), | |
| + options.safe(), | |
| + ))) | |
| + } | |
| +} | |
| + | |
| +/// Pretty printer for binary UUID values. | |
| +#[derive(Debug, Clone, Copy)] | |
| +struct UuidValueDisplayIndex<'a> { | |
| + array: &'a FixedSizeBinaryArray, | |
| + null_str: &'a str, | |
| +} | |
| + | |
| +impl DisplayIndex for UuidValueDisplayIndex<'_> { | |
| + fn write(&self, idx: usize, f: &mut dyn Write) -> FormatResult { | |
| + if self.array.is_null(idx) { | |
| + write!(f, "{}", self.null_str)?; | |
| + return Ok(()); | |
| + } | |
| + | |
| + let bytes = Bytes::try_from(self.array.value(idx)) | |
| + .expect("FixedSizeBinaryArray length checked in create_array_formatter"); | |
| + let uuid = Uuid::from_bytes(bytes); | |
| + write!(f, "{uuid}")?; | |
| + Ok(()) | |
| + } | |
| +} | |
| + | |
| +#[cfg(test)] | |
| +mod tests { | |
| + use super::*; | |
| + use crate::ScalarValue; | |
| + | |
| + #[test] | |
| + pub fn test_pretty_print_uuid() { | |
| + let my_uuid = Uuid::nil(); | |
| + let uuid = ScalarValue::FixedSizeBinary(16, Some(my_uuid.as_bytes().to_vec())) | |
| + .to_array_of_size(1) | |
| + .unwrap(); | |
| + | |
| + let extension_type = arrow_schema::extension::Uuid {}; | |
| + let formatter = extension_type | |
| + .create_array_formatter(uuid.as_ref(), &FormatOptions::default()) | |
| + .unwrap() | |
| + .unwrap(); | |
| + | |
| + assert_eq!( | |
| + formatter.value(0).to_string(), | |
| + "00000000-0000-0000-0000-000000000000" | |
| + ); | |
| + } | |
| +} | |
| diff --git a/datafusion/common/src/types/extension.rs b/datafusion/common/src/types/extension.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion/common/src/types/extension.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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 crate::error::Result; | |
| +use arrow::array::Array; | |
| +use arrow::util::display::{ArrayFormatter, FormatOptions}; | |
| +use arrow_schema::DataType; | |
| +use std::fmt::Debug; | |
| +use std::sync::Arc; | |
| + | |
| +/// A cheaply cloneable pointer to a [`DFExtensionType`]. | |
| +pub type DFExtensionTypeRef = Arc<dyn DFExtensionType>; | |
| + | |
| +/// Represents an implementation of a DataFusion extension type, including the storage [`DataType`]. | |
| +/// While, in general, an extension type can support several different storage types, a specific | |
| +/// instance of it is always locked into just one exact storage type and metadata pairing. | |
| +/// | |
| +/// This trait allows users to customize the behavior of DataFusion for certain types. Having this | |
| +/// ability is necessary because extension types affect how columns should be treated by the query | |
| +/// engine. This effect includes which operations are possible on a column and what are the expected | |
| +/// results from these operations. The extension type mechanism allows users to define how these | |
| +/// operations apply to a particular extension type. | |
| +/// | |
| +/// For example, adding two values of [`Int64`](arrow::datatypes::DataType::Int64) is a sensible | |
| +/// thing to do. However, if the same column is annotated with an extension type like `custom.id`, | |
| +/// the correct interpretation of a column changes. Adding together two `custom.id` values, even | |
| +/// though they are stored as integers, may no longer make sense. | |
| +/// | |
| +/// Note that DataFusion's extension type support is still young and therefore might not cover all | |
| +/// relevant use cases. Currently, the following operations can be customized: | |
| +/// - Pretty-printing values in record batches | |
| +/// | |
| +/// # Relation to Arrow's [`ExtensionType`](arrow_schema::extension::ExtensionType) | |
| +/// | |
| +/// The purpose of Arrow's [`ExtensionType`](arrow_schema::extension::ExtensionType) trait, for the | |
| +/// time being, is to allow reading and writing extension type metadata in a type-safe manner. The | |
| +/// trait does not provide any customization options. Therefore, downstream users (such as | |
| +/// DataFusion) have the flexibility to implement the extension type mechanism according to their | |
| +/// needs. [`DFExtensionType`] is DataFusion's implementation of this extension type mechanism. | |
| +/// | |
| +/// Furthermore, the current trait in arrow-rs is not dyn-compatible, which we need for implementing | |
| +/// extension type registries. In the future, the two implementations may increasingly converge. | |
| +/// | |
| +/// # Examples | |
| +/// | |
| +/// Examples for using the extension type machinery can be found in the DataFusion examples | |
| +/// directory. | |
| +pub trait DFExtensionType: Debug + Send + Sync { | |
| + /// Returns the underlying storage type. | |
| + fn storage_type(&self) -> DataType; | |
| + | |
| + /// Returns the serialized metadata. | |
| + fn serialize_metadata(&self) -> Option<String>; | |
| + | |
| + /// Returns an [`ArrayFormatter`] that can format values of this type. | |
| + /// | |
| + /// If `Ok(None)` is returned, the default implementation will be used. | |
| + /// If an error is returned, there was an error creating the formatter. | |
| + fn create_array_formatter<'fmt>( | |
| + &self, | |
| + _array: &'fmt dyn Array, | |
| + _options: &FormatOptions<'fmt>, | |
| + ) -> Result<Option<ArrayFormatter<'fmt>>> { | |
| + Ok(None) | |
| + } | |
| +} | |
| diff --git a/datafusion/common/src/types/mod.rs b/datafusion/common/src/types/mod.rs | |
| --- a/datafusion/common/src/types/mod.rs | |
| +++ b/datafusion/common/src/types/mod.rs | |
| // under the License. | |
| mod builtin; | |
| +mod canonical_extensions; | |
| +mod extension; | |
| mod field; | |
| mod logical; | |
| mod native; | |
| pub use builtin::*; | |
| +pub use extension::*; | |
| pub use field::*; | |
| pub use logical::*; | |
| pub use native::*; | |
| diff --git a/datafusion/core/src/dataframe/mod.rs b/datafusion/core/src/dataframe/mod.rs | |
| --- a/datafusion/core/src/dataframe/mod.rs | |
| +++ b/datafusion/core/src/dataframe/mod.rs | |
| use datafusion_functions_aggregate::expr_fn::{ | |
| use async_trait::async_trait; | |
| use datafusion_catalog::Session; | |
| +use datafusion_expr::extension_types::DFArrayFormatterFactory; | |
| /// Contains options that control how data is | |
| /// written out from a DataFrame | |
| impl DataFrame { | |
| let options = self.session_state.config().options().format.clone(); | |
| let arrow_options: arrow::util::display::FormatOptions = (&options).try_into()?; | |
| + let registry = self.session_state.extension_type_registry(); | |
| + let formatter_factory = DFArrayFormatterFactory::new(Arc::clone(registry)); | |
| + let arrow_options = | |
| + arrow_options.with_formatter_factory(Some(&formatter_factory)); | |
| + | |
| let results = self.collect().await?; | |
| Ok( | |
| pretty::pretty_format_batches_with_options(&results, &arrow_options)? | |
| diff --git a/datafusion/core/src/datasource/listing_table_factory.rs b/datafusion/core/src/datasource/listing_table_factory.rs | |
| --- a/datafusion/core/src/datasource/listing_table_factory.rs | |
| +++ b/datafusion/core/src/datasource/listing_table_factory.rs | |
| mod tests { | |
| use datafusion_common::parsers::CompressionTypeVariant; | |
| use datafusion_common::{DFSchema, TableReference}; | |
| + use datafusion_expr::registry::ExtensionTypeRegistryRef; | |
| #[tokio::test] | |
| async fn test_create_using_non_std_file_ext() { | |
| mod tests { | |
| ) -> &HashMap<String, Arc<datafusion_expr::WindowUDF>> { | |
| unimplemented!() | |
| } | |
| + | |
| + fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef { | |
| + unreachable!() | |
| + } | |
| + | |
| fn runtime_env(&self) -> &Arc<datafusion_execution::runtime_env::RuntimeEnv> { | |
| unimplemented!() | |
| } | |
| diff --git a/datafusion/core/src/execution/session_state.rs b/datafusion/core/src/execution/session_state.rs | |
| --- a/datafusion/core/src/execution/session_state.rs | |
| +++ b/datafusion/core/src/execution/session_state.rs | |
| use datafusion_expr::expr_rewriter::FunctionRewrite; | |
| use datafusion_expr::planner::ExprPlanner; | |
| #[cfg(feature = "sql")] | |
| use datafusion_expr::planner::{RelationPlanner, TypePlanner}; | |
| -use datafusion_expr::registry::{FunctionRegistry, SerializerRegistry}; | |
| +use datafusion_expr::registry::{ | |
| + ExtensionTypeRegistryRef, FunctionRegistry, MemoryExtensionTypeRegistry, | |
| + SerializerRegistry, | |
| +}; | |
| use datafusion_expr::simplify::SimplifyContext; | |
| use datafusion_expr::{AggregateUDF, Explain, Expr, LogicalPlan, ScalarUDF, WindowUDF}; | |
| use datafusion_optimizer::simplify_expressions::ExprSimplifier; | |
| pub struct SessionState { | |
| aggregate_functions: HashMap<String, Arc<AggregateUDF>>, | |
| /// Window functions registered in the context | |
| window_functions: HashMap<String, Arc<WindowUDF>>, | |
| + /// Extension types registry for extensions. | |
| + extension_types: ExtensionTypeRegistryRef, | |
| /// Deserializer registry for extensions. | |
| serializer_registry: Arc<dyn SerializerRegistry>, | |
| /// Holds registered external FileFormat implementations | |
| impl Session for SessionState { | |
| &self.window_functions | |
| } | |
| + fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef { | |
| + &self.extension_types | |
| + } | |
| + | |
| fn runtime_env(&self) -> &Arc<RuntimeEnv> { | |
| self.runtime_env() | |
| } | |
| pub struct SessionStateBuilder { | |
| scalar_functions: Option<Vec<Arc<ScalarUDF>>>, | |
| aggregate_functions: Option<Vec<Arc<AggregateUDF>>>, | |
| window_functions: Option<Vec<Arc<WindowUDF>>>, | |
| + extension_types: Option<ExtensionTypeRegistryRef>, | |
| serializer_registry: Option<Arc<dyn SerializerRegistry>>, | |
| file_formats: Option<Vec<Arc<dyn FileFormatFactory>>>, | |
| config: Option<SessionConfig>, | |
| impl SessionStateBuilder { | |
| scalar_functions: None, | |
| aggregate_functions: None, | |
| window_functions: None, | |
| + extension_types: None, | |
| serializer_registry: None, | |
| file_formats: None, | |
| table_options: None, | |
| impl SessionStateBuilder { | |
| existing.aggregate_functions.into_values().collect_vec(), | |
| ), | |
| window_functions: Some(existing.window_functions.into_values().collect_vec()), | |
| + extension_types: Some(existing.extension_types), | |
| serializer_registry: Some(existing.serializer_registry), | |
| file_formats: Some(existing.file_formats.into_values().collect_vec()), | |
| config: Some(new_config), | |
| impl SessionStateBuilder { | |
| .get_or_insert_with(Vec::new) | |
| .extend(SessionStateDefaults::default_window_functions()); | |
| + self.extension_types | |
| + .get_or_insert_with(|| Arc::new(MemoryExtensionTypeRegistry::new_empty())) | |
| + .extend(&SessionStateDefaults::default_extension_types()) | |
| + .expect("MemoryExtensionTypeRegistry is not read-only."); | |
| + | |
| self.table_functions | |
| .get_or_insert_with(HashMap::new) | |
| .extend( | |
| impl SessionStateBuilder { | |
| self | |
| } | |
| + /// Sets the [`ExtensionTypeRegistry`](datafusion_expr::registry::ExtensionTypeRegistry). | |
| + pub fn with_extension_type_registry( | |
| + mut self, | |
| + registry: ExtensionTypeRegistryRef, | |
| + ) -> Self { | |
| + self.extension_types = Some(registry); | |
| + self | |
| + } | |
| + | |
| /// Set the [`SerializerRegistry`] | |
| pub fn with_serializer_registry( | |
| mut self, | |
| impl SessionStateBuilder { | |
| scalar_functions, | |
| aggregate_functions, | |
| window_functions, | |
| + extension_types, | |
| serializer_registry, | |
| file_formats, | |
| table_options, | |
| impl SessionStateBuilder { | |
| scalar_functions: HashMap::new(), | |
| aggregate_functions: HashMap::new(), | |
| window_functions: HashMap::new(), | |
| + extension_types: Arc::new(MemoryExtensionTypeRegistry::default()), | |
| serializer_registry: serializer_registry | |
| .unwrap_or_else(|| Arc::new(EmptySerializerRegistry)), | |
| file_formats: HashMap::new(), | |
| impl SessionStateBuilder { | |
| }); | |
| } | |
| + if let Some(extension_types) = extension_types { | |
| + state.extension_types = extension_types; | |
| + } | |
| + | |
| if state.config.create_default_catalog_and_schema() { | |
| let default_catalog = SessionStateDefaults::default_catalog( | |
| &state.config, | |
| diff --git a/datafusion/core/src/execution/session_state_defaults.rs b/datafusion/core/src/execution/session_state_defaults.rs | |
| --- a/datafusion/core/src/execution/session_state_defaults.rs | |
| +++ b/datafusion/core/src/execution/session_state_defaults.rs | |
| use datafusion_execution::config::SessionConfig; | |
| use datafusion_execution::object_store::ObjectStoreUrl; | |
| use datafusion_execution::runtime_env::RuntimeEnv; | |
| use datafusion_expr::planner::ExprPlanner; | |
| +use datafusion_expr::registry::ExtensionTypeRegistrationRef; | |
| use datafusion_expr::{AggregateUDF, ScalarUDF, WindowUDF}; | |
| use std::collections::HashMap; | |
| use std::sync::Arc; | |
| impl SessionStateDefaults { | |
| functions_window::all_default_window_functions() | |
| } | |
| + /// Returns the list of default extension types. | |
| + /// | |
| + /// For now, we do not register any extension types by default. | |
| + pub fn default_extension_types() -> Vec<ExtensionTypeRegistrationRef> { | |
| + vec![] | |
| + } | |
| + | |
| /// returns the list of default [`TableFunction`]s | |
| pub fn default_table_functions() -> Vec<Arc<TableFunction>> { | |
| functions_table::all_default_table_functions() | |
| diff --git a/datafusion/core/src/lib.rs b/datafusion/core/src/lib.rs | |
| --- a/datafusion/core/src/lib.rs | |
| +++ b/datafusion/core/src/lib.rs | |
| //! [`RecordBatchReader`]: arrow::record_batch::RecordBatchReader | |
| //! [`Array`]: arrow::array::Array | |
| -/// DataFusion crate version | |
| -pub const DATAFUSION_VERSION: &str = env!("CARGO_PKG_VERSION"); | |
| - | |
| extern crate core; | |
| - | |
| #[cfg(feature = "sql")] | |
| extern crate sqlparser; | |
| +/// DataFusion crate version | |
| +pub const DATAFUSION_VERSION: &str = env!("CARGO_PKG_VERSION"); | |
| pub mod dataframe; | |
| pub mod datasource; | |
| diff --git a/datafusion/datasource-arrow/src/file_format.rs b/datafusion/datasource-arrow/src/file_format.rs | |
| --- a/datafusion/datasource-arrow/src/file_format.rs | |
| +++ b/datafusion/datasource-arrow/src/file_format.rs | |
| mod tests { | |
| use datafusion_execution::config::SessionConfig; | |
| use datafusion_execution::runtime_env::RuntimeEnv; | |
| use datafusion_expr::execution_props::ExecutionProps; | |
| + use datafusion_expr::registry::ExtensionTypeRegistryRef; | |
| use datafusion_expr::{AggregateUDF, Expr, LogicalPlan, ScalarUDF, WindowUDF}; | |
| use datafusion_physical_expr_common::physical_expr::PhysicalExpr; | |
| use object_store::{chunked::ChunkedStore, memory::InMemory, path::Path}; | |
| mod tests { | |
| unimplemented!() | |
| } | |
| + fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef { | |
| + unimplemented!() | |
| + } | |
| + | |
| fn runtime_env(&self) -> &Arc<RuntimeEnv> { | |
| &self.runtime_env | |
| } | |
| diff --git a/datafusion/datasource/src/url.rs b/datafusion/datasource/src/url.rs | |
| --- a/datafusion/datasource/src/url.rs | |
| +++ b/datafusion/datasource/src/url.rs | |
| mod tests { | |
| use datafusion_execution::config::SessionConfig; | |
| use datafusion_execution::runtime_env::RuntimeEnv; | |
| use datafusion_expr::execution_props::ExecutionProps; | |
| + use datafusion_expr::registry::ExtensionTypeRegistryRef; | |
| use datafusion_expr::{AggregateUDF, Expr, LogicalPlan, ScalarUDF, WindowUDF}; | |
| use datafusion_physical_expr_common::physical_expr::PhysicalExpr; | |
| use datafusion_physical_plan::ExecutionPlan; | |
| mod tests { | |
| unimplemented!() | |
| } | |
| + fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef { | |
| + unimplemented!() | |
| + } | |
| + | |
| fn runtime_env(&self) -> &Arc<RuntimeEnv> { | |
| &self.runtime_env | |
| } | |
| diff --git a/datafusion/expr/Cargo.toml b/datafusion/expr/Cargo.toml | |
| --- a/datafusion/expr/Cargo.toml | |
| +++ b/datafusion/expr/Cargo.toml | |
| recursive_protection = ["dep:recursive"] | |
| sql = ["sqlparser"] | |
| [dependencies] | |
| -arrow = { workspace = true } | |
| +arrow = { workspace = true, features = ["canonical_extension_types"] } | |
| +arrow-schema = { workspace = true, features = ["canonical_extension_types"] } | |
| async-trait = { workspace = true } | |
| chrono = { workspace = true } | |
| datafusion-common = { workspace = true, default-features = false } | |
| diff --git a/datafusion/expr/src/extension_types/array_formatter_factory.rs b/datafusion/expr/src/extension_types/array_formatter_factory.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion/expr/src/extension_types/array_formatter_factory.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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 crate::registry::ExtensionTypeRegistryRef; | |
| +use arrow::array::Array; | |
| +use arrow::util::display::{ArrayFormatter, ArrayFormatterFactory, FormatOptions}; | |
| +use arrow_schema::{ArrowError, Field}; | |
| + | |
| +/// A factory for creating [`ArrayFormatter`]s that checks whether a registered extension type can | |
| +/// format a given array based on its metadata. | |
| +#[derive(Debug)] | |
| +pub struct DFArrayFormatterFactory { | |
| + /// The extension type registry | |
| + registry: ExtensionTypeRegistryRef, | |
| +} | |
| + | |
| +impl DFArrayFormatterFactory { | |
| + /// Creates a new [`DFArrayFormatterFactory`]. | |
| + pub fn new(registry: ExtensionTypeRegistryRef) -> Self { | |
| + Self { registry } | |
| + } | |
| +} | |
| + | |
| +impl ArrayFormatterFactory for DFArrayFormatterFactory { | |
| + fn create_array_formatter<'formatter>( | |
| + &self, | |
| + array: &'formatter dyn Array, | |
| + options: &FormatOptions<'formatter>, | |
| + field: Option<&'formatter Field>, | |
| + ) -> Result<Option<ArrayFormatter<'formatter>>, ArrowError> { | |
| + let Some(field) = field else { | |
| + return Ok(None); | |
| + }; | |
| + | |
| + let Some(extension_type_name) = field.extension_type_name() else { | |
| + return Ok(None); | |
| + }; | |
| + | |
| + let Some(registration) = self | |
| + .registry | |
| + .extension_type_registration(extension_type_name) | |
| + .ok() | |
| + else { | |
| + // If the extension type is not registered, we fall back to the default formatter | |
| + return Ok(None); | |
| + }; | |
| + | |
| + registration | |
| + .create_df_extension_type(field.data_type(), field.extension_type_metadata())? | |
| + .create_array_formatter(array, options) | |
| + .map_err(ArrowError::from) | |
| + } | |
| +} | |
| diff --git a/datafusion/expr/src/extension_types/mod.rs b/datafusion/expr/src/extension_types/mod.rs | |
| new file mode 100644 | |
| --- /dev/null | |
| +++ b/datafusion/expr/src/extension_types/mod.rs | |
| +// Licensed to the Apache Software Foundation (ASF) under one | |
| +// or more contributor license agreements. See the NOTICE file | |
| +// distributed with this work for additional information | |
| +// regarding copyright ownership. The ASF licenses this file | |
| +// to you 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. | |
| + | |
| +//! This module contains code that enables DataFusion's extension type capabilities. | |
| + | |
| +mod array_formatter_factory; | |
| + | |
| +pub use array_formatter_factory::*; | |
| diff --git a/datafusion/expr/src/lib.rs b/datafusion/expr/src/lib.rs | |
| --- a/datafusion/expr/src/lib.rs | |
| +++ b/datafusion/expr/src/lib.rs | |
| pub mod expr; | |
| pub mod expr_fn; | |
| pub mod expr_rewriter; | |
| pub mod expr_schema; | |
| +pub mod extension_types; | |
| pub mod function; | |
| pub mod select_expr; | |
| pub mod groups_accumulator { | |
| diff --git a/datafusion/expr/src/registry.rs b/datafusion/expr/src/registry.rs | |
| --- a/datafusion/expr/src/registry.rs | |
| +++ b/datafusion/expr/src/registry.rs | |
| use crate::expr_rewriter::FunctionRewrite; | |
| use crate::planner::ExprPlanner; | |
| use crate::{AggregateUDF, ScalarUDF, UserDefinedLogicalNode, WindowUDF}; | |
| +use arrow::datatypes::Field; | |
| +use arrow_schema::DataType; | |
| +use arrow_schema::extension::ExtensionType; | |
| +use datafusion_common::types::{DFExtensionType, DFExtensionTypeRef}; | |
| use datafusion_common::{HashMap, Result, not_impl_err, plan_datafusion_err}; | |
| use std::collections::HashSet; | |
| -use std::fmt::Debug; | |
| -use std::sync::Arc; | |
| +use std::fmt::{Debug, Formatter}; | |
| +use std::sync::{Arc, RwLock}; | |
| /// A registry knows how to build logical expressions out of user-defined function' names | |
| pub trait FunctionRegistry { | |
| impl FunctionRegistry for MemoryFunctionRegistry { | |
| self.udwfs.keys().cloned().collect() | |
| } | |
| } | |
| + | |
| +/// A cheaply cloneable pointer to an [ExtensionTypeRegistration]. | |
| +pub type ExtensionTypeRegistrationRef = Arc<dyn ExtensionTypeRegistration>; | |
| + | |
| +/// The registration of an extension type. Implementations of this trait are responsible for | |
| +/// *creating* instances of [`DFExtensionType`] that represent the entire semantics of an extension | |
| +/// type. | |
| +/// | |
| +/// # Why do we need a Registration? | |
| +/// | |
| +/// A good question is why this trait is even necessary. Why not directly register the | |
| +/// [`DFExtensionType`] in a registration? | |
| +/// | |
| +/// While this works for extension types requiring no additional metadata (e.g., `arrow.uuid`), it | |
| +/// does not work for more complex extension types with metadata. For example, consider an extension | |
| +/// type `custom.shortened(n)` that aims to short the pretty-printing string to `n` characters. | |
| +/// Here, `n` is a parameter of the extension type and should be a field in the struct that | |
| +/// implements the [`DFExtensionType`]. The job of the registration is to read the metadata from the | |
| +/// field and create the corresponding [`DFExtensionType`] instance with the correct `n` set. | |
| +/// | |
| +/// The [`DefaultExtensionTypeRegistration`] provides a convenient way of creating registrations. | |
| +pub trait ExtensionTypeRegistration: Debug + Send + Sync { | |
| + /// The name of the extension type. | |
| + /// | |
| + /// This name will be used to find the correct [ExtensionTypeRegistration] when an extension | |
| + /// type is encountered. | |
| + fn type_name(&self) -> &str; | |
| + | |
| + /// Creates an extension type instance from the optional metadata. The name of the extension | |
| + /// type is not a parameter as it's already defined by the registration itself. | |
| + fn create_df_extension_type( | |
| + &self, | |
| + storage_type: &DataType, | |
| + metadata: Option<&str>, | |
| + ) -> Result<DFExtensionTypeRef>; | |
| +} | |
| + | |
| +/// A cheaply cloneable pointer to an [ExtensionTypeRegistry]. | |
| +pub type ExtensionTypeRegistryRef = Arc<dyn ExtensionTypeRegistry>; | |
| + | |
| +/// Manages [`ExtensionTypeRegistration`]s, which allow users to register custom behavior for | |
| +/// extension types. | |
| +/// | |
| +/// Each registration is connected to the extension type name, which can also be looked up to get | |
| +/// the registration. | |
| +pub trait ExtensionTypeRegistry: Debug + Send + Sync { | |
| + /// Returns a reference to registration of an extension type named `name`. | |
| + /// | |
| + /// Returns an error if there is no extension type with that name. | |
| + fn extension_type_registration( | |
| + &self, | |
| + name: &str, | |
| + ) -> Result<ExtensionTypeRegistrationRef>; | |
| + | |
| + /// Creates a [`DFExtensionTypeRef`] from the type information in the `field`. | |
| + /// | |
| + /// The result `Ok(None)` indicates that there is no extension type metadata. Returns an error | |
| + /// if the extension type in the metadata is not found. | |
| + fn create_extension_type_for_field( | |
| + &self, | |
| + field: &Field, | |
| + ) -> Result<Option<DFExtensionTypeRef>> { | |
| + let Some(extension_type_name) = field.extension_type_name() else { | |
| + return Ok(None); | |
| + }; | |
| + | |
| + let registration = self.extension_type_registration(extension_type_name)?; | |
| + registration | |
| + .create_df_extension_type(field.data_type(), field.extension_type_metadata()) | |
| + .map(Some) | |
| + } | |
| + | |
| + /// Returns all registered [ExtensionTypeRegistration]. | |
| + fn extension_type_registrations(&self) -> Vec<Arc<dyn ExtensionTypeRegistration>>; | |
| + | |
| + /// Registers a new [ExtensionTypeRegistrationRef], returning any previously registered | |
| + /// implementation. | |
| + /// | |
| + /// Returns an error if the type cannot be registered, for example, if the registry is | |
| + /// read-only. | |
| + fn add_extension_type_registration( | |
| + &self, | |
| + extension_type: ExtensionTypeRegistrationRef, | |
| + ) -> Result<Option<ExtensionTypeRegistrationRef>>; | |
| + | |
| + /// Extends the registry with the provided extension types. | |
| + /// | |
| + /// Returns an error if the type cannot be registered, for example, if the registry is | |
| + /// read-only. | |
| + fn extend(&self, extension_types: &[ExtensionTypeRegistrationRef]) -> Result<()> { | |
| + for extension_type in extension_types.iter().cloned() { | |
| + self.add_extension_type_registration(extension_type)?; | |
| + } | |
| + Ok(()) | |
| + } | |
| + | |
| + /// Deregisters an extension type registration with the name `name`, returning the | |
| + /// implementation that was deregistered. | |
| + /// | |
| + /// Returns an error if the type cannot be deregistered, for example, if the registry is | |
| + /// read-only. | |
| + fn remove_extension_type_registration( | |
| + &self, | |
| + name: &str, | |
| + ) -> Result<Option<ExtensionTypeRegistrationRef>>; | |
| +} | |
| + | |
| +/// A factory that creates instances of extension types from a storage [`DataType`] and the | |
| +/// metadata. | |
| +pub type ExtensionTypeFactory<TExtensionType> = dyn Fn(&DataType, <TExtensionType as ExtensionType>::Metadata) -> Result<TExtensionType> | |
| + + Send | |
| + + Sync; | |
| + | |
| +/// A default implementation of [ExtensionTypeRegistration] that parses the metadata from the | |
| +/// given extension type and passes it to a constructor function. | |
| +pub struct DefaultExtensionTypeRegistration< | |
| + TExtensionType: ExtensionType + DFExtensionType + 'static, | |
| +> { | |
| + /// A function that creates an instance of [`DFExtensionTypeRef`] from the storage type and the | |
| + /// metadata. | |
| + factory: Box<ExtensionTypeFactory<TExtensionType>>, | |
| +} | |
| + | |
| +impl<TExtensionType: ExtensionType + DFExtensionType + 'static> | |
| + DefaultExtensionTypeRegistration<TExtensionType> | |
| +{ | |
| + /// Creates a new registration for an extension type. | |
| + /// | |
| + /// The factory is not required to validate the storage [`DataType`], as the compatibility will | |
| + /// be checked by the registration using [`ExtensionType::supports_data_type`]. However, the | |
| + /// factory may still choose to do so. | |
| + pub fn new_arc( | |
| + factory: impl Fn(&DataType, TExtensionType::Metadata) -> Result<TExtensionType> | |
| + + Send | |
| + + Sync | |
| + + 'static, | |
| + ) -> ExtensionTypeRegistrationRef { | |
| + Arc::new(Self { | |
| + factory: Box::new(factory), | |
| + }) | |
| + } | |
| +} | |
| + | |
| +impl<TExtensionType: ExtensionType + DFExtensionType> ExtensionTypeRegistration | |
| + for DefaultExtensionTypeRegistration<TExtensionType> | |
| +{ | |
| + fn type_name(&self) -> &str { | |
| + TExtensionType::NAME | |
| + } | |
| + | |
| + fn create_df_extension_type( | |
| + &self, | |
| + storage_type: &DataType, | |
| + metadata: Option<&str>, | |
| + ) -> Result<DFExtensionTypeRef> { | |
| + let metadata = TExtensionType::deserialize_metadata(metadata)?; | |
| + let type_instance = self.factory.as_ref()(storage_type, metadata)?; | |
| + type_instance | |
| + .supports_data_type(storage_type) | |
| + .map_err(|_| { | |
| + plan_datafusion_err!( | |
| + "Extension type {} obtained from registration does not support the storage data type {}", | |
| + TExtensionType::NAME, | |
| + storage_type | |
| + ) | |
| + })?; | |
| + | |
| + Ok(Arc::new(type_instance) as DFExtensionTypeRef) | |
| + } | |
| +} | |
| + | |
| +impl<TExtensionType: ExtensionType + DFExtensionType> Debug | |
| + for DefaultExtensionTypeRegistration<TExtensionType> | |
| +{ | |
| + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { | |
| + f.debug_struct("DefaultExtensionTypeRegistration") | |
| + .field("type_name", &TExtensionType::NAME) | |
| + .finish() | |
| + } | |
| +} | |
| + | |
| +/// An [`ExtensionTypeRegistry`] that uses in memory [`HashMap`]s. | |
| +#[derive(Clone, Debug)] | |
| +pub struct MemoryExtensionTypeRegistry { | |
| + /// Holds a mapping between the name of an extension type and its logical type. | |
| + extension_types: Arc<RwLock<HashMap<String, ExtensionTypeRegistrationRef>>>, | |
| +} | |
| + | |
| +impl Default for MemoryExtensionTypeRegistry { | |
| + fn default() -> Self { | |
| + Self::new_empty() | |
| + } | |
| +} | |
| + | |
| +impl MemoryExtensionTypeRegistry { | |
| + /// Creates an empty [MemoryExtensionTypeRegistry]. | |
| + pub fn new_empty() -> Self { | |
| + Self { | |
| + extension_types: Arc::new(RwLock::new(HashMap::new())), | |
| + } | |
| + } | |
| + | |
| + /// Pre-registers the [canonical extension types](https://arrow.apache.org/docs/format/CanonicalExtensions.html) | |
| + /// in the extension type registry. | |
| + pub fn new_with_canonical_extension_types() -> Self { | |
| + let mapping = [DefaultExtensionTypeRegistration::new_arc(|_, _| { | |
| + Ok(arrow_schema::extension::Uuid {}) | |
| + })]; | |
| + | |
| + let mut extension_types = HashMap::new(); | |
| + for registration in mapping.into_iter() { | |
| + extension_types.insert(registration.type_name().to_owned(), registration); | |
| + } | |
| + | |
| + Self { | |
| + extension_types: Arc::new(RwLock::new(HashMap::from(extension_types))), | |
| + } | |
| + } | |
| + | |
| + /// Creates a new [MemoryExtensionTypeRegistry] with the provided `types`. | |
| + /// | |
| + /// # Errors | |
| + /// | |
| + /// Returns an error if one of the `types` is a native type. | |
| + pub fn new_with_types( | |
| + types: impl IntoIterator<Item = ExtensionTypeRegistrationRef>, | |
| + ) -> Result<Self> { | |
| + let extension_types = types | |
| + .into_iter() | |
| + .map(|t| (t.type_name().to_owned(), t)) | |
| + .collect::<HashMap<_, _>>(); | |
| + Ok(Self { | |
| + extension_types: Arc::new(RwLock::new(extension_types)), | |
| + }) | |
| + } | |
| + | |
| + /// Returns a list of all registered types. | |
| + pub fn all_extension_types(&self) -> Vec<ExtensionTypeRegistrationRef> { | |
| + self.extension_types | |
| + .read() | |
| + .expect("Extension type registry lock poisoned") | |
| + .values() | |
| + .cloned() | |
| + .collect() | |
| + } | |
| +} | |
| + | |
| +impl ExtensionTypeRegistry for MemoryExtensionTypeRegistry { | |
| + fn extension_type_registration( | |
| + &self, | |
| + name: &str, | |
| + ) -> Result<ExtensionTypeRegistrationRef> { | |
| + self.extension_types | |
| + .write() | |
| + .expect("Extension type registry lock poisoned") | |
| + .get(name) | |
| + .ok_or_else(|| plan_datafusion_err!("Logical type not found.")) | |
| + .cloned() | |
| + } | |
| + | |
| + fn extension_type_registrations(&self) -> Vec<Arc<dyn ExtensionTypeRegistration>> { | |
| + self.extension_types | |
| + .read() | |
| + .expect("Extension type registry lock poisoned") | |
| + .values() | |
| + .cloned() | |
| + .collect() | |
| + } | |
| + | |
| + fn add_extension_type_registration( | |
| + &self, | |
| + extension_type: ExtensionTypeRegistrationRef, | |
| + ) -> Result<Option<ExtensionTypeRegistrationRef>> { | |
| + Ok(self | |
| + .extension_types | |
| + .write() | |
| + .expect("Extension type registry lock poisoned") | |
| + .insert(extension_type.type_name().to_owned(), extension_type)) | |
| + } | |
| + | |
| + fn remove_extension_type_registration( | |
| + &self, | |
| + name: &str, | |
| + ) -> Result<Option<ExtensionTypeRegistrationRef>> { | |
| + Ok(self | |
| + .extension_types | |
| + .write() | |
| + .expect("Extension type registry lock poisoned") | |
| + .remove(name)) | |
| + } | |
| +} | |
| + | |
| +impl From<HashMap<String, ExtensionTypeRegistrationRef>> for MemoryExtensionTypeRegistry { | |
| + fn from(value: HashMap<String, ExtensionTypeRegistrationRef>) -> Self { | |
| + Self { | |
| + extension_types: Arc::new(RwLock::new(value)), | |
| + } | |
| + } | |
| +} | |
| diff --git a/datafusion/ffi/src/session/mod.rs b/datafusion/ffi/src/session/mod.rs | |
| --- a/datafusion/ffi/src/session/mod.rs | |
| +++ b/datafusion/ffi/src/session/mod.rs | |
| use std::collections::HashMap; | |
| use std::ffi::c_void; | |
| use std::sync::Arc; | |
| +use crate::arrow_wrappers::WrappedSchema; | |
| +use crate::execution::FFI_TaskContext; | |
| +use crate::execution_plan::FFI_ExecutionPlan; | |
| +use crate::physical_expr::FFI_PhysicalExpr; | |
| +use crate::proto::logical_extension_codec::FFI_LogicalExtensionCodec; | |
| +use crate::session::config::FFI_SessionConfig; | |
| +use crate::udaf::FFI_AggregateUDF; | |
| +use crate::udf::FFI_ScalarUDF; | |
| +use crate::udwf::FFI_WindowUDF; | |
| +use crate::util::FFIResult; | |
| +use crate::{df_result, rresult, rresult_return}; | |
| use abi_stable::StableAbi; | |
| use abi_stable::std_types::{RHashMap, RResult, RStr, RString, RVec}; | |
| use arrow_schema::SchemaRef; | |
| use datafusion_execution::TaskContext; | |
| use datafusion_execution::config::SessionConfig; | |
| use datafusion_execution::runtime_env::RuntimeEnv; | |
| use datafusion_expr::execution_props::ExecutionProps; | |
| +use datafusion_expr::registry::{ExtensionTypeRegistryRef, MemoryExtensionTypeRegistry}; | |
| use datafusion_expr::{ | |
| AggregateUDF, AggregateUDFImpl, Expr, LogicalPlan, ScalarUDF, ScalarUDFImpl, | |
| WindowUDF, WindowUDFImpl, | |
| use datafusion_session::Session; | |
| use prost::Message; | |
| use tokio::runtime::Handle; | |
| -use crate::arrow_wrappers::WrappedSchema; | |
| -use crate::execution::FFI_TaskContext; | |
| -use crate::execution_plan::FFI_ExecutionPlan; | |
| -use crate::physical_expr::FFI_PhysicalExpr; | |
| -use crate::proto::logical_extension_codec::FFI_LogicalExtensionCodec; | |
| -use crate::session::config::FFI_SessionConfig; | |
| -use crate::udaf::FFI_AggregateUDF; | |
| -use crate::udf::FFI_ScalarUDF; | |
| -use crate::udwf::FFI_WindowUDF; | |
| -use crate::util::FFIResult; | |
| -use crate::{df_result, rresult, rresult_return}; | |
| - | |
| pub mod config; | |
| /// A stable struct for sharing [`Session`] across FFI boundaries. | |
| pub struct ForeignSession { | |
| scalar_functions: HashMap<String, Arc<ScalarUDF>>, | |
| aggregate_functions: HashMap<String, Arc<AggregateUDF>>, | |
| window_functions: HashMap<String, Arc<WindowUDF>>, | |
| + extension_types: ExtensionTypeRegistryRef, | |
| table_options: TableOptions, | |
| runtime_env: Arc<RuntimeEnv>, | |
| props: ExecutionProps, | |
| impl TryFrom<&FFI_SessionRef> for ForeignSession { | |
| scalar_functions, | |
| aggregate_functions, | |
| window_functions, | |
| + extension_types: Arc::new(MemoryExtensionTypeRegistry::default()), | |
| runtime_env: Default::default(), | |
| props: Default::default(), | |
| }) | |
| impl Session for ForeignSession { | |
| &self.window_functions | |
| } | |
| + fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef { | |
| + &self.extension_types | |
| + } | |
| + | |
| fn runtime_env(&self) -> &Arc<RuntimeEnv> { | |
| &self.runtime_env | |
| } | |
| diff --git a/datafusion/session/src/session.rs b/datafusion/session/src/session.rs | |
| --- a/datafusion/session/src/session.rs | |
| +++ b/datafusion/session/src/session.rs | |
| use datafusion_execution::TaskContext; | |
| use datafusion_execution::config::SessionConfig; | |
| use datafusion_execution::runtime_env::RuntimeEnv; | |
| use datafusion_expr::execution_props::ExecutionProps; | |
| +use datafusion_expr::registry::ExtensionTypeRegistryRef; | |
| use datafusion_expr::{AggregateUDF, Expr, LogicalPlan, ScalarUDF, WindowUDF}; | |
| use datafusion_physical_plan::{ExecutionPlan, PhysicalExpr}; | |
| use parking_lot::{Mutex, RwLock}; | |
| pub trait Session: Send + Sync { | |
| /// Return reference to window functions | |
| fn window_functions(&self) -> &HashMap<String, Arc<WindowUDF>>; | |
| + /// Return a reference to the extension type registry | |
| + fn extension_type_registry(&self) -> &ExtensionTypeRegistryRef; | |
| + | |
| /// Return the runtime env | |
| fn runtime_env(&self) -> &Arc<RuntimeEnv>; | |