Enable placeholders with extension types (apache#17986)

## Which issue does this PR close?

- Closes apache#17862

## Rationale for this change

Most logical plan expressions now propagate metadata; however,
parameters with extension types or other field metadata cannot
participate in placeholder/parameter binding.

## What changes are included in this PR?

The DataType in the Placeholder struct was replaced with a FieldRef
along with anything that stored the "DataType" of a parameter.

Strictly speaking one could bind parameters with an extension type by
copy/pasting the placeholder replacer, which I figured out towards the
end of this change. I still think this change makes sense and opens up
the door for things like handling UUID in SQL with full parameter
binding support.

## Are these changes tested?

Yes

## Are there any user-facing changes?

Yes, one new function was added to extract the placeholder fields from a
plan.

This is a breaking change for code that specifically interacts with the
pub fields of the modified structs (ParamValues, Placeholder, and
Prepare are the main ones).

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

Author: 2 people

datafusion/common/src/datatype.rs

@@ -0,0 +1,107 @@
+// 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.
+
+//! [DataTypeExt] extension trait for converting DataTypes to Fields
+
+use crate::arrow::datatypes::{DataType, Field, FieldRef};
+use std::sync::Arc;
+
+/// DataFusion extension methods for Arrow [`DataType`]
+pub trait DataTypeExt {
+    /// Convert the type to field with nullable type and "" name
+    ///
+    /// This is used to track the places where we convert a [`DataType`]
+    /// into a nameless field to interact with an API that is
+    /// capable of representing an extension type and/or nullability.
+    fn into_nullable_field(self) -> Field;
+
+    /// Convert the type to field ref with nullable type and "" name
+    ///
+    /// Concise wrapper around [`DataTypeExt::into_nullable_field`] that
+    /// constructs a [`FieldRef`].
+    fn into_nullable_field_ref(self) -> FieldRef;
+}
+
+impl DataTypeExt for DataType {
+    fn into_nullable_field(self) -> Field {
+        Field::new("", self, true)
+    }
+
+    fn into_nullable_field_ref(self) -> FieldRef {
+        Arc::new(Field::new("", self, true))
+    }
+}
+
+/// DataFusion extension methods for Arrow [`Field`]
+pub trait FieldExt {
+    /// Returns a new Field representing a List of this Field's DataType.
+    fn into_list(self) -> Self;
+
+    /// Return a new Field representing this Field as the item type of a FixedSizeList
+    fn into_fixed_size_list(self, list_size: i32) -> Self;
+
+    /// Create a field with the default list field name ("item")
+    ///
+    /// Note that lists are allowed to have an arbitrarily named field;
+    /// however, a name other than 'item' will cause it to fail an
+    /// == check against a more idiomatically created list in
+    /// arrow-rs which causes issues.
+    fn into_list_item(self) -> Self;
+}
+
+impl FieldExt for Field {
+    fn into_list(self) -> Self {
+        DataType::List(Arc::new(self.into_list_item())).into_nullable_field()
+    }
+
+    fn into_fixed_size_list(self, list_size: i32) -> Self {
+        DataType::FixedSizeList(self.into_list_item().into(), list_size)
+            .into_nullable_field()
+    }
+
+    fn into_list_item(self) -> Self {
+        if self.name() != Field::LIST_FIELD_DEFAULT_NAME {
+            self.with_name(Field::LIST_FIELD_DEFAULT_NAME)
+        } else {
+            self
+        }
+    }
+}
+
+impl FieldExt for Arc<Field> {
+    fn into_list(self) -> Self {
+        DataType::List(self.into_list_item())
+            .into_nullable_field()
+            .into()
+    }
+
+    fn into_fixed_size_list(self, list_size: i32) -> Self {
+        DataType::FixedSizeList(self.into_list_item(), list_size)
+            .into_nullable_field()
+            .into()
+    }
+
+    fn into_list_item(self) -> Self {
+        if self.name() != Field::LIST_FIELD_DEFAULT_NAME {
+            Arc::unwrap_or_clone(self)
+                .with_name(Field::LIST_FIELD_DEFAULT_NAME)
+                .into()
+        } else {
+            self
+        }
+    }
+}

datafusion/common/src/lib.rs

@@ -39,6 +39,7 @@ pub mod alias;
 pub mod cast;
 pub mod config;
 pub mod cse;
+pub mod datatype;
 pub mod diagnostic;
 pub mod display;
 pub mod encryption;
@@ -47,6 +48,7 @@ pub mod file_options;
 pub mod format;
 pub mod hash_utils;
 pub mod instant;
+pub mod metadata;
 pub mod nested_struct;
 mod null_equality;
 pub mod parsers;