Struct polars_core::prelude::ArrowSchema

pub struct ArrowSchema { /* fields omitted */ }

An ordered sequence of Field with optional metadata.

Implementations

impl Schema

pub fn empty() -> Schema

Creates an empty Schema.

pub fn new(fields: Vec<Field, Global>) -> Schema

Creates a new Schema from a sequence of Field values.

Example

let field_a = Field::new("a", DataType::Int64, false);
let field_b = Field::new("b", DataType::Boolean, false);

let schema = Schema::new(vec![field_a, field_b]);

pub const fn new_from(
    fields: Vec<Field, Global>,
    metadata: HashMap<String, String, RandomState>
) -> Schema

Creates a new Schema from a sequence of Field values and additional metadata.

Example

let field_a = Field::new("a", DataType::Int64, false);
let field_b = Field::new("b", DataType::Boolean, false);

let mut metadata: HashMap<String, String> = HashMap::new();
metadata.insert("row_count".to_string(), "100".to_string());

let schema = Schema::new_from(vec![field_a, field_b], metadata);

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

Creates a new Field with metadata.

pub fn try_merge(
    schemas: impl IntoIterator<Item = Schema>
) -> Result<Schema, ArrowError>

Merge schema into self if it is compatible. Struct fields will be merged recursively.

Example:

use arrow2::datatypes::*;

let merged = Schema::try_merge(vec![
    Schema::new(vec![
        Field::new("c1", DataType::Int64, false),
        Field::new("c2", DataType::Utf8, false),
    ]),
    Schema::new(vec![
        Field::new("c1", DataType::Int64, true),
        Field::new("c2", DataType::Utf8, false),
        Field::new("c3", DataType::Utf8, false),
    ]),
]).unwrap();

assert_eq!(
    merged,
    Schema::new(vec![
        Field::new("c1", DataType::Int64, true),
        Field::new("c2", DataType::Utf8, false),
        Field::new("c3", DataType::Utf8, false),
    ]),
);

pub const fn fields(&self) -> &Vec<Field, Global>

Returns all Fields in this schema.

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

Returns the Field at position i.

Panics

Panics iff i is larger than the number of fields in this Schema.

pub fn field_with_name(&self, name: &str) -> Result<&Field, ArrowError>

Returns the first Field named name.

pub fn fields_with_dict_id(&self, dict_id: i64) -> Vec<&Field, Global>

Returns all Fields with dictionary id dict_id.

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

Find the index of the column with the given name.

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

Returns an immutable reference to the Map of custom metadata key-value pairs.

pub fn column_with_name(&self, name: &str) -> Option<(usize, &Field)>

Look up a column by name and return a immutable reference to the column along with its index.

Trait Implementations

impl Clone for Schema

pub fn clone(&self) -> Schema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Display for Schema

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

Formats the value using the given formatter.

impl From<&'_ Schema> for Schema

fn from(a_schema: &ArrowSchema) -> Self

Performs the conversion.

impl From<Schema> for Schema

fn from(a_schema: ArrowSchema) -> Self

Performs the conversion.

impl PartialEq<Schema> for Schema

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

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

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

This method tests for !=.

impl Eq for Schema

impl StructuralEq for Schema

impl StructuralPartialEq for Schema