Struct WriteRequest

pub struct WriteRequest {
    pub region_id: RegionId,
    pub op_type: OpType,
    pub rows: Rows,
    name_to_index: HashMap<String, usize>,
    has_null: Vec<bool>,
    pub hint: Option<WriteHint>,
    pub(crate) region_metadata: Option<RegionMetadataRef>,
}

Request to write a region.

Fields

region_id: RegionId

Region to write.

op_type: OpType

Type of the write request.

rows: Rows

Rows to write.

name_to_index: HashMap<String, usize>

Map column name to column index in rows.

has_null: Vec<bool>

Whether each column has null.

hint: Option<WriteHint>

Write hint.

region_metadata: Option<RegionMetadataRef>

Region metadata on the time of this request is created.

Implementations

impl WriteRequest

pub fn new( region_id: RegionId, op_type: OpType, rows: Rows, region_metadata: Option<RegionMetadataRef>, ) -> Result<WriteRequest>

Creates a new request.

Returns Err if rows are invalid.

pub fn with_hint(self, hint: Option<WriteHint>) -> Self

Sets the write hint.

pub fn primary_key_encoding(&self) -> PrimaryKeyEncoding

Returns the encoding hint.

pub(crate) fn estimated_size(&self) -> usize

Returns estimated size of the request.

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

Gets column index by name.

pub(crate) fn check_schema(&self, metadata: &RegionMetadata) -> Result<()>

Checks schema of rows is compatible with schema of the region.

If column with default value is missing, it returns a special FillDefault error.

pub(crate) fn fill_missing_columns( &mut self, metadata: &RegionMetadata, ) -> Result<()>

Tries to fill missing columns.

Currently, our protobuf format might be inefficient when we need to fill lots of null values.

pub(crate) fn maybe_fill_missing_columns( &mut self, metadata: &RegionMetadata, ) -> Result<()>

Checks the schema and fill missing columns.

fn fill_columns(&mut self, columns: Vec<&ColumnMetadata>) -> Result<()>

Fills default value for specific columns.

fn check_missing_column(&self, column: &ColumnMetadata) -> Result<()>

Checks whether we should allow a row doesn’t provide this column.

fn column_default_value(&self, column: &ColumnMetadata) -> Result<Value>

Returns the default value for specific column.

Trait Implementations

impl Debug for WriteRequest

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

Formats the value using the given formatter.