Struct PartitionSpec

pub struct PartitionSpec { /* private fields */ }

Partition spec that defines how to produce a tuple of partition values from a record.

A PartitionSpec is originally obtained by binding an UnboundPartitionSpec to a schema and is only guaranteed to be valid for that schema. The main difference between PartitionSpec and UnboundPartitionSpec is that the former has field ids assigned, while field ids are optional for UnboundPartitionSpec.

Implementations

impl PartitionSpec

pub fn builder(schema: impl Into<SchemaRef>) -> PartitionSpecBuilder

Create a new partition spec builder with the given schema.

pub fn fields(&self) -> &[PartitionField]

Fields of the partition spec

pub fn spec_id(&self) -> i32

Spec id of the partition spec

pub fn unpartition_spec() -> Self

Get a new unpartitioned partition spec

pub fn is_unpartitioned(&self) -> bool

Returns if the partition spec is unpartitioned.

A PartitionSpec is unpartitioned if it has no fields or all fields are Transform::Void transform.

pub fn partition_type(&self, schema: &Schema) -> Result<StructType>

Returns the partition type of this partition spec.

pub fn into_unbound(self) -> UnboundPartitionSpec

Convert to unbound partition spec

pub fn with_spec_id(self, spec_id: i32) -> Self

Change the spec id of the partition spec

pub fn has_sequential_ids(&self) -> bool

Check if this partition spec has sequential partition ids. Sequential ids start from 1000 and increment by 1 for each field. This is required for spec version 1

pub fn highest_field_id(&self) -> Option<i32>

Get the highest field id in the partition spec.

pub fn is_compatible_with(&self, other: &PartitionSpec) -> bool

Check if this partition spec is compatible with another partition spec.

Returns true if the partition spec is equal to the other spec with partition field ids ignored and spec_id ignored. The following must be identical:

• The number of fields
• Field order
• Field names
• Source column ids
• Transforms

pub fn partition_to_path(&self, data: &Struct, schema: SchemaRef) -> String

Returns partition path string containing partition type and partition value as key-value pairs.

Trait Implementations

impl Clone for PartitionSpec

fn clone(&self) -> PartitionSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PartitionSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PartitionSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PartitionSpec> for UnboundPartitionSpec

fn from(spec: PartitionSpec) -> Self

Converts to this type from the input type.

impl PartialEq for PartitionSpec

fn eq(&self, other: &PartitionSpec) -> 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 PartitionSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PartitionSpec

impl StructuralPartialEq for PartitionSpec