alamb commented on code in PR #3992:
URL: https://github.com/apache/arrow-rs/pull/3992#discussion_r1154706952
##########
arrow-schema/src/field.rs:
##########
@@ -145,6 +147,104 @@ impl Field {
}
}
+ /// Create a new [`Field`] with [`DataType::Dictionary`]
+ ///
+ /// Use [`Self::new_dict`] for more advanced dictionary options
+ pub fn new_dictionary(
+ name: impl Into<String>,
+ key: DataType,
+ value: DataType,
+ nullable: bool,
+ ) -> Self {
+ // TODO: Should this enforce `key` is a dictionary key type
+ let data_type = DataType::Dictionary(Box::new(key), Box::new(value));
+ Self::new(name, data_type, nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::Struct`]
+ pub fn new_struct(
+ name: impl Into<String>,
+ fields: impl Into<Fields>,
+ nullable: bool,
+ ) -> Self {
+ Self::new(name, DataType::Struct(fields.into()), nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::List`]
+ ///
+ /// - `name`: the name of the [`DataType::List`] field
+ /// - `value`: the list elements
+ /// - `nullable`: if the [`DataType::List`] array is nullable
+ ///
+ /// Uses "item" as the name of the child field, this can be overridden
with [`Self::new`]
+ pub fn new_list(
+ name: impl Into<String>,
+ value: impl Into<FieldRef>,
+ nullable: bool,
+ ) -> Self {
+ Self::new(name, DataType::List(value.into()), nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::LargeList`]
+ ///
+ /// - `name`: the name of the [`DataType::LargeList`] field
+ /// - `value`: the list elements
+ /// - `nullable`: if the [`DataType::LargeList`] array is nullable
+ pub fn new_large_list(
+ name: impl Into<String>,
+ value: impl Into<FieldRef>,
+ nullable: bool,
+ ) -> Self {
+ Self::new(name, DataType::LargeList(value.into()), nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::Map`]
+ ///
+ /// - `name`: the name of the [`DataType::Map`] field
+ /// - `entries`: the name of the inner [`DataType::Struct`] field
+ /// - `keys`: the map keys
+ /// - `values`: the map values
+ /// - `sorted`: if the [`DataType::Map`] array is sorted
+ /// - `nullable`: if the [`DataType::Map`] array is nullable
+ pub fn new_map(
+ name: impl Into<String>,
+ entries: impl Into<String>,
+ keys: impl Into<FieldRef>,
+ values: impl Into<FieldRef>,
+ sorted: bool,
+ nullable: bool,
+ ) -> Self {
+ let data_type = DataType::Map(
+ Arc::new(Field::new(
+ entries.into(),
+ DataType::Struct(Fields::from([keys.into(), values.into()])),
+ false, // The inner map field is always non-nullable (#1697),
+ )),
+ sorted,
+ );
+ Self::new(name, data_type, nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::Union`]
+ ///
+ /// - `name`: the name of the [`DataType::Map`] field
Review Comment:
```suggestion
/// - `name`: the name of the [`DataType::Union`] field
```
##########
arrow-schema/src/field.rs:
##########
@@ -145,6 +147,104 @@ impl Field {
}
}
+ /// Create a new [`Field`] with [`DataType::Dictionary`]
+ ///
+ /// Use [`Self::new_dict`] for more advanced dictionary options
+ pub fn new_dictionary(
+ name: impl Into<String>,
+ key: DataType,
+ value: DataType,
+ nullable: bool,
+ ) -> Self {
+ // TODO: Should this enforce `key` is a dictionary key type
+ let data_type = DataType::Dictionary(Box::new(key), Box::new(value));
+ Self::new(name, data_type, nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::Struct`]
+ pub fn new_struct(
+ name: impl Into<String>,
+ fields: impl Into<Fields>,
+ nullable: bool,
+ ) -> Self {
+ Self::new(name, DataType::Struct(fields.into()), nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::List`]
+ ///
+ /// - `name`: the name of the [`DataType::List`] field
+ /// - `value`: the list elements
+ /// - `nullable`: if the [`DataType::List`] array is nullable
+ ///
+ /// Uses "item" as the name of the child field, this can be overridden
with [`Self::new`]
+ pub fn new_list(
+ name: impl Into<String>,
+ value: impl Into<FieldRef>,
+ nullable: bool,
+ ) -> Self {
+ Self::new(name, DataType::List(value.into()), nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::LargeList`]
+ ///
+ /// - `name`: the name of the [`DataType::LargeList`] field
+ /// - `value`: the list elements
Review Comment:
```suggestion
/// - `value`: the description of each list element
```
##########
arrow-schema/src/field.rs:
##########
@@ -145,6 +147,104 @@ impl Field {
}
}
+ /// Create a new [`Field`] with [`DataType::Dictionary`]
+ ///
+ /// Use [`Self::new_dict`] for more advanced dictionary options
+ pub fn new_dictionary(
+ name: impl Into<String>,
+ key: DataType,
+ value: DataType,
+ nullable: bool,
+ ) -> Self {
+ // TODO: Should this enforce `key` is a dictionary key type
Review Comment:
In my opinion "yes"
##########
arrow-schema/src/field.rs:
##########
@@ -145,6 +147,104 @@ impl Field {
}
}
+ /// Create a new [`Field`] with [`DataType::Dictionary`]
+ ///
+ /// Use [`Self::new_dict`] for more advanced dictionary options
+ pub fn new_dictionary(
+ name: impl Into<String>,
+ key: DataType,
+ value: DataType,
+ nullable: bool,
+ ) -> Self {
+ // TODO: Should this enforce `key` is a dictionary key type
+ let data_type = DataType::Dictionary(Box::new(key), Box::new(value));
+ Self::new(name, data_type, nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::Struct`]
Review Comment:
Perhaps can we add the same style doc comments for the arguments?
##########
arrow-schema/src/field.rs:
##########
@@ -145,6 +147,104 @@ impl Field {
}
}
+ /// Create a new [`Field`] with [`DataType::Dictionary`]
+ ///
+ /// Use [`Self::new_dict`] for more advanced dictionary options
+ pub fn new_dictionary(
+ name: impl Into<String>,
+ key: DataType,
+ value: DataType,
+ nullable: bool,
+ ) -> Self {
+ // TODO: Should this enforce `key` is a dictionary key type
+ let data_type = DataType::Dictionary(Box::new(key), Box::new(value));
+ Self::new(name, data_type, nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::Struct`]
+ pub fn new_struct(
+ name: impl Into<String>,
+ fields: impl Into<Fields>,
+ nullable: bool,
+ ) -> Self {
+ Self::new(name, DataType::Struct(fields.into()), nullable)
+ }
+
+ /// Create a new [`Field`] with [`DataType::List`]
+ ///
+ /// - `name`: the name of the [`DataType::List`] field
+ /// - `value`: the list elements
Review Comment:
```suggestion
/// - `value`: the description of each list element
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
