Struct datafusion_common::DFField

pub struct DFField { /* private fields */ }

DFField wraps an Arrow field and adds an optional qualifier

Implementations

impl DFField

pub fn new<R: Into<OwnedTableReference>>( qualifier: Option<R>, name: &str, data_type: DataType, nullable: bool ) -> Self

Creates a new DFField

pub fn new_unqualified(name: &str, data_type: DataType, nullable: bool) -> Self

Convenience method for creating new DFField without a qualifier

pub fn from_qualified<'a>( qualifier: impl Into<TableReference<'a>>, field: impl Into<FieldRef> ) -> Self

Create a qualified field from an existing Arrow field

pub fn name(&self) -> &String

Returns an immutable reference to the DFField’s unqualified name

pub fn data_type(&self) -> &DataType

Returns an immutable reference to the DFField’s data-type

pub fn is_nullable(&self) -> bool

Indicates whether this DFField supports null values

pub fn metadata(&self) -> &HashMap<String, String>

pub fn qualified_name(&self) -> String

Returns a string to the DFField’s qualified name

pub fn qualified_column(&self) -> Column

Builds a qualified column based on self

pub fn unqualified_column(&self) -> Column

Builds an unqualified column based on self

pub fn qualifier(&self) -> Option<&OwnedTableReference>

Get the optional qualifier

pub fn field(&self) -> &FieldRef

Get the arrow field

pub fn strip_qualifier(self) -> Self

Return field with qualifier stripped

pub fn with_nullable(self, nullable: bool) -> Self

Return field with nullable specified

pub fn with_metadata(self, metadata: HashMap<String, String>) -> Self

Return field with new metadata

Trait Implementations

impl Clone for DFField

fn clone(&self) -> DFField

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DFField

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Arc<Field>> for DFField

fn from(value: FieldRef) -> Self

Converts to this type from the input type.

impl From<Field> for DFField

fn from(value: Field) -> Self

Converts to this type from the input type.

impl Hash for DFField

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DFField

fn eq(&self, other: &DFField) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DFField

impl StructuralPartialEq for DFField