Struct RegionMetadataBuilder 

pub struct RegionMetadataBuilder {
    region_id: RegionId,
    column_metadatas: Vec<ColumnMetadata>,
    primary_key: Vec<ColumnId>,
    schema_version: u64,
    primary_key_encoding: PrimaryKeyEncoding,
    partition_expr: Option<String>,
}

Builder to build RegionMetadata.

Fields

region_id: RegionId

column_metadatas: Vec<ColumnMetadata>

primary_key: Vec<ColumnId>

schema_version: u64

primary_key_encoding: PrimaryKeyEncoding

partition_expr: Option<String>

Implementations

impl RegionMetadataBuilder

pub fn new(id: RegionId) -> Self

Returns a new builder.

pub fn from_existing(existing: RegionMetadata) -> Self

Creates a builder from existing RegionMetadata.

pub fn primary_key_encoding( &mut self, encoding: PrimaryKeyEncoding, ) -> &mut Self

Sets the primary key encoding mode.

pub fn partition_expr_json(&mut self, expr_json: Option<String>) -> &mut Self

Sets the partition expression in JSON string form.

pub fn push_column_metadata( &mut self, column_metadata: ColumnMetadata, ) -> &mut Self

Pushes a new column metadata to this region’s metadata.

pub fn primary_key(&mut self, key: Vec<ColumnId>) -> &mut Self

Sets the primary key of the region.

pub fn bump_version(&mut self) -> &mut Self

Increases the schema version by 1.

pub fn alter(&mut self, kind: AlterKind) -> Result<&mut Self>

Applies the alter kind to the builder.

The kind should be valid.

pub fn build(self) -> Result<RegionMetadata>

Consumes the builder and build a RegionMetadata.

pub fn build_without_validation(self) -> Result<RegionMetadata>

Builds metadata without running validation.

Intended for file/external engines that should accept arbitrary schemas coming from files.

fn build_with_options(self, validate: bool) -> Result<RegionMetadata>

fn add_columns(&mut self, columns: Vec<AddColumn>) -> Result<()>

Adds columns to the metadata if not exist.

fn drop_columns(&mut self, names: &[String])

Drops columns from the metadata if exist.

fn modify_column_types(&mut self, columns: Vec<ModifyColumnType>) -> Result<()>

Changes columns type to the metadata if exist.

fn set_indexes(&mut self, options: Vec<SetIndexOption>) -> Result<()>

fn unset_indexes(&mut self, options: Vec<UnsetIndexOption>) -> Result<()>

fn set_index( column_metadata: &mut ColumnMetadata, options: &SetIndexOption, ) -> Result<()>

fn unset_index( column_metadata: &mut ColumnMetadata, options: &UnsetIndexOption, ) -> Result<()>

fn drop_defaults(&mut self, column_names: Vec<String>) -> Result<()>

fn set_defaults(&mut self, set_defaults: &[SetDefault]) -> Result<()>