Struct datafusion::logical_plan::DFSchema

source · [−]

pub struct DFSchema { /* private fields */ }

Expand description

DFSchema wraps an Arrow schema and adds relation names

Implementations

source

impl DFSchema

source

pub fn empty() -> DFSchema

Creates an empty DFSchema

source

pub fn new(fields: Vec<DFField, Global>) -> Result<DFSchema, DataFusionError>

👎 Deprecated since 7.0.0:

please use new_with_metadata instead

Create a new DFSchema

source

pub fn new_with_metadata(
fields: Vec<DFField, Global>,
metadata: HashMap<String, String, RandomState>
) -> Result<DFSchema, DataFusionError>

Create a new DFSchema

source

pub fn try_from_qualified_schema(
qualifier: &str,
schema: &Schema
) -> Result<DFSchema, DataFusionError>

Create a DFSchema from an Arrow schema

source

pub fn join(&self, schema: &DFSchema) -> Result<DFSchema, DataFusionError>

Create a new schema that contains the fields from this schema followed by the fields from the supplied schema. An error will be returned if there are duplicate field names.

source

pub fn merge(&mut self, other_schema: &DFSchema)

Modify this schema by appending the fields from the supplied schema, ignoring any duplicate fields.

source

pub fn fields(&self) -> &Vec<DFField, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get a list of fields

source

pub fn field(&self, i: usize) -> &DFField

Returns an immutable reference of a specific Field instance selected using an offset within the internal fields vector

source

pub fn index_of(&self, name: &str) -> Result<usize, DataFusionError>

👎 Deprecated since 8.0.0:

please use index_of_column_by_name instead

Find the index of the column with the given unqualified name

source

pub fn index_of_column_by_name(
 &self,
 qualifier: Option<&str>,
 name: &str
) -> Result<usize, DataFusionError>

source

pub fn index_of_column(&self, col: &Column) -> Result<usize, DataFusionError>

Find the index of the column with the given qualifier and name

source

pub fn field_with_name(
 &self,
 qualifier: Option<&str>,
 name: &str
) -> Result<&DFField, DataFusionError>

Find the field with the given name

source

pub fn fields_with_qualified(&self, qualifier: &str) -> Vec<&DFField, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Find all fields having the given qualifier

source

pub fn fields_with_unqualified_name(&self, name: &str) -> Vec<&DFField, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Find all fields match the given name

source

pub fn field_with_unqualified_name(
&self,
name: &str
) -> Result<&DFField, DataFusionError>

Find the field with the given name

source

pub fn field_with_qualified_name(
 &self,
 qualifier: &str,
 name: &str
) -> Result<&DFField, DataFusionError>

Find the field with the given qualified name

source

pub fn field_from_column(
&self,
column: &Column
) -> Result<&DFField, DataFusionError>

Find the field with the given qualified column

source

pub fn matches_arrow_schema(&self, arrow_schema: &Schema) -> bool

Check to see if unqualified field names matches field names in Arrow schema

source

pub fn check_arrow_schema_type_compatible(
&self,
arrow_schema: &Schema
) -> Result<(), DataFusionError>

Check to see if fields in 2 Arrow schemas are compatible

source

pub fn strip_qualifiers(self) -> DFSchema

Strip all field qualifier in schema

source

pub fn replace_qualifier(self, qualifier: &str) -> DFSchema

Replace all field qualifier with new value in schema

source

pub fn field_names(&self) -> Vec<String, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get list of fully-qualified field names in this schema

source

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

Get metadata of this schema

Trait Implementations

source

impl Clone for DFSchema

source

fn clone(&self) -> DFSchema

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for DFSchema

source

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

Formats the value using the given formatter. Read more

source

impl Display for DFSchema

source

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

Formats the value using the given formatter. Read more

source

impl ExprSchema for DFSchema

source

fn nullable(&self, col: &Column) -> Result<bool, DataFusionError>

Is this column reference nullable?

source

fn data_type(&self, col: &Column) -> Result<&DataType, DataFusionError>

What is the datatype of this column?

source

impl PartialEq<DFSchema> for DFSchema

source

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

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

source

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

This method tests for !=.

source

impl TryFrom<Schema> for DFSchema

Create a DFSchema from an Arrow schema

type Error = DataFusionError

The type returned in the event of a conversion error.

source

fn try_from(
schema: Schema
) -> Result<DFSchema, <DFSchema as TryFrom<Schema>>::Error>

Performs the conversion.

source

impl Eq for DFSchema

source

impl StructuralEq for DFSchema

source

impl StructuralPartialEq for DFSchema

Auto Trait Implementations

impl RefUnwindSafe for DFSchema

impl Send for DFSchema

impl Sync for DFSchema

impl Unpin for DFSchema

impl UnwindSafe for DFSchema

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

Struct datafusion::logical_plan::DFSchema

Implementations

impl DFSchema

pub fn empty() -> DFSchema

pub fn new(fields: Vec<DFField, Global>) -> Result<DFSchema, DataFusionError>

pub fn new_with_metadata( fields: Vec<DFField, Global>, metadata: HashMap<String, String, RandomState>) -> Result<DFSchema, DataFusionError>

pub fn try_from_qualified_schema( qualifier: &str, schema: &Schema) -> Result<DFSchema, DataFusionError>

pub fn join(&self, schema: &DFSchema) -> Result<DFSchema, DataFusionError>

pub fn merge(&mut self, other_schema: &DFSchema)

pub fn fields(&self) -> &Vec<DFField, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn field(&self, i: usize) -> &DFField

pub fn index_of(&self, name: &str) -> Result<usize, DataFusionError>

pub fn index_of_column_by_name( &self, qualifier: Option<&str>, name: &str) -> Result<usize, DataFusionError>

pub fn index_of_column(&self, col: &Column) -> Result<usize, DataFusionError>

pub fn field_with_name( &self, qualifier: Option<&str>, name: &str) -> Result<&DFField, DataFusionError>

pub fn fields_with_qualified(&self, qualifier: &str) -> Vec<&DFField, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn fields_with_unqualified_name(&self, name: &str) -> Vec<&DFField, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn field_with_unqualified_name( &self, name: &str) -> Result<&DFField, DataFusionError>

pub fn field_with_qualified_name( &self, qualifier: &str, name: &str) -> Result<&DFField, DataFusionError>

pub fn field_from_column( &self, column: &Column) -> Result<&DFField, DataFusionError>

pub fn matches_arrow_schema(&self, arrow_schema: &Schema) -> bool

pub fn check_arrow_schema_type_compatible( &self, arrow_schema: &Schema) -> Result<(), DataFusionError>

pub fn strip_qualifiers(self) -> DFSchema

pub fn replace_qualifier(self, qualifier: &str) -> DFSchema

pub fn field_names(&self) -> Vec<String, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

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

Trait Implementations

impl Clone for DFSchema

fn clone(&self) -> DFSchema

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

impl Debug for DFSchema

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

impl Display for DFSchema

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

impl ExprSchema for DFSchema

fn nullable(&self, col: &Column) -> Result<bool, DataFusionError>

fn data_type(&self, col: &Column) -> Result<&DataType, DataFusionError>

impl PartialEq<DFSchema> for DFSchema

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

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

impl TryFrom<Schema> for DFSchema

type Error = DataFusionError

fn try_from( schema: Schema) -> Result<DFSchema, <DFSchema as TryFrom<Schema>>::Error>

impl Eq for DFSchema

impl StructuralEq for DFSchema

impl StructuralPartialEq for DFSchema

Auto Trait Implementations

impl RefUnwindSafe for DFSchema

impl Send for DFSchema

impl Sync for DFSchema

impl Unpin for DFSchema

impl UnwindSafe for DFSchema

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn new_with_metadata(
fields: Vec<DFField, Global>,
metadata: HashMap<String, String, RandomState>
) -> Result<DFSchema, DataFusionError>

pub fn try_from_qualified_schema(
qualifier: &str,
schema: &Schema
) -> Result<DFSchema, DataFusionError>

pub fn fields(&self) -> &Vec<DFField, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn index_of_column_by_name(
&self,
qualifier: Option<&str>,
name: &str
) -> Result<usize, DataFusionError>

pub fn field_with_name(
&self,
qualifier: Option<&str>,
name: &str
) -> Result<&DFField, DataFusionError>

pub fn fields_with_qualified(&self, qualifier: &str) -> Vec<&DFField, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn fields_with_unqualified_name(&self, name: &str) -> Vec<&DFField, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn field_with_unqualified_name(
&self,
name: &str
) -> Result<&DFField, DataFusionError>

pub fn field_with_qualified_name(
&self,
qualifier: &str,
name: &str
) -> Result<&DFField, DataFusionError>

pub fn field_from_column(
&self,
column: &Column
) -> Result<&DFField, DataFusionError>

pub fn check_arrow_schema_type_compatible(
&self,
arrow_schema: &Schema
) -> Result<(), DataFusionError>

pub fn field_names(&self) -> Vec<String, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn try_from(
schema: Schema
) -> Result<DFSchema, <DFSchema as TryFrom<Schema>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> Allocation for T where
T: RefUnwindSafe + Send + Sync,