Struct PuffinIndexMetaEntry 

pub struct PuffinIndexMetaEntry {

    pub table_dir: String,
    pub index_file_path: String,
    pub region_id: RegionId,
    pub table_id: TableId,
    pub region_number: RegionNumber,
    pub region_group: RegionGroup,
    pub region_sequence: RegionSeq,
    pub file_id: String,
    pub index_file_size: Option<u64>,
    pub index_type: String,
    pub target_type: String,
    pub target_key: String,
    pub target_json: String,
    pub blob_size: u64,
    pub meta_json: Option<String>,
    pub node_id: Option<u64>,
}

An entry describing puffin index metadata for inspection.

Fields

table_dir: String

The table directory this index belongs to.

index_file_path: String

The full path of the index file in object store.

region_id: RegionId

The region id referencing the index file.

table_id: TableId

The table id referencing the index file.

region_number: RegionNumber

The region number referencing the index file.

region_group: RegionGroup

The region group referencing the index file.

region_sequence: RegionSeq

The region sequence referencing the index file.

file_id: String

Engine-specific file identifier (string form).

index_file_size: Option<u64>

Size of the index file in object store (if available).

index_type: String

Logical index type (bloom_filter, fulltext_bloom, fulltext_tantivy, inverted).

target_type: String

Target type (column, …).

target_key: String

Encoded target key string.

target_json: String

Structured JSON describing the target.

blob_size: u64

Size of the blob storing this target.

meta_json: Option<String>

Structured JSON describing index-specific metadata (if available).

node_id: Option<u64>

Node id associated with the index file (if known).

Implementations

impl PuffinIndexMetaEntry

pub fn schema() -> SchemaRef

Returns the schema describing puffin index metadata entries.

pub fn to_record_batch(entries: &[Self]) -> Result<DfRecordBatch, ArrowError>

Converts a list of puffin index metadata entries to a record batch.

pub fn reserved_table_name_for_inspection() -> &'static str

Reserved internal inspect table name for puffin index metadata.

pub fn build_plan( scan_request: ScanRequest, ) -> Result<LogicalPlan, DataFusionError>

Builds a logical plan for scanning puffin index metadata entries.

Trait Implementations

impl Clone for PuffinIndexMetaEntry

fn clone(&self) -> PuffinIndexMetaEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PuffinIndexMetaEntry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PuffinIndexMetaEntry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PuffinIndexMetaEntry

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

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 PuffinIndexMetaEntry

impl StructuralPartialEq for PuffinIndexMetaEntry