Struct Schema 

pub struct Schema { /* private fields */ }

Defines schema in iceberg.

Implementations

impl Schema

pub fn builder() -> SchemaBuilder

Create a schema builder.

pub fn into_builder(self) -> SchemaBuilder

Create a new schema builder from a schema.

pub fn field_by_id(&self, field_id: i32) -> Option<&NestedFieldRef>

Get field by field id.

pub fn field_by_name(&self, field_name: &str) -> Option<&NestedFieldRef>

Get field by field name.

Both full name and short name could work here.

pub fn field_by_name_case_insensitive( &self, field_name: &str, ) -> Option<&NestedFieldRef>

Get field by field name, but in case-insensitive way.

Both full name and short name could work here.

pub fn field_by_alias(&self, alias: &str) -> Option<&NestedFieldRef>

Get field by alias.

pub fn highest_field_id(&self) -> i32

Returns [highest_field_id].

pub fn schema_id(&self) -> SchemaId

Returns [schema_id].

pub fn as_struct(&self) -> &StructType

Returns [r#struct].

pub fn identifier_field_ids(&self) -> impl ExactSizeIterator<Item = i32> + '_

Returns [identifier_field_ids].

pub fn field_id_by_name(&self, name: &str) -> Option<i32>

Get field id by full name.

pub fn name_by_field_id(&self, field_id: i32) -> Option<&str>

Get full name by field id.

pub fn accessor_by_field_id(&self, field_id: i32) -> Option<Arc<StructAccessor>>

Get an accessor for retrieving data in a struct

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

Return A HashMap matching field ids to field names.

pub fn field_id_to_fields(&self) -> &HashMap<i32, NestedFieldRef>

Return a hashmap matching field ids to nested fields.

pub fn calc_min_compatible_format(&self) -> FormatVersion

Minimum FormatVersion required to represent all types in this schema.

Walks the whole schema — every field, nested ones included — and returns the highest per-type floor, so this is O(fields) rather than a cheap field read. Types only; for initial-default version floors see Schema::check_format_compatibility.

pub fn check_format_compatibility( &self, format_version: FormatVersion, ) -> Result<()>

Returns an error listing every field incompatible with format_version. Mirrors Java’s Schema.checkCompatibility(). Two checks per field:

• Type — minimum format version required to support that type, without taking nested field types into account.
• Initial default — a non-null initial_default backfills pre-existing rows, so it requires DEFAULT_VALUES_MIN_FORMAT_VERSION; write_default is not checked, as it only affects newly written rows (read identically at any version).

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Schema

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

Formats the value using the given formatter.

impl PartialEq for Schema

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Schema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Schema> for Schema

type Error = Error

The type returned in the event of a conversion error.

fn try_from(schema: &ArrowSchema) -> Result<Self>

Performs the conversion.

impl TryFrom<&Schema> for Schema

type Error = Error

The type returned in the event of a conversion error.

fn try_from(schema: &Schema) -> Result<Self>

Performs the conversion.

impl Eq for Schema