Struct FileMeta 

pub struct FileMeta {

    pub region_id: RegionId,
    pub file_id: FileId,
    pub time_range: FileTimeRange,
    pub level: Level,
    pub file_size: u64,
    pub available_indexes: SmallVec<[IndexType; 4]>,
    pub index_file_size: u64,
    pub index_file_id: Option<FileId>,
    pub num_rows: u64,
    pub num_row_groups: u64,
    pub sequence: Option<NonZeroU64>,
    pub partition_expr: Option<PartitionExpr>,
    pub num_series: u64,
}

Metadata of a SST file.

Fields

region_id: RegionId

Region that created the file. The region id may not be the id of the current region.

file_id: FileId

Compared to normal file names, FileId ignore the extension

time_range: FileTimeRange

Timestamp range of file. The timestamps have the same time unit as the data in the SST.

level: Level

SST level of the file.

file_size: u64

Size of the file.

available_indexes: SmallVec<[IndexType; 4]>

Available indexes of the file.

index_file_size: u64

Size of the index file.

index_file_id: Option<FileId>

File ID of the index file.

When this field is None, it means the index file id is the same as the file id. Only meaningful when index_file_size > 0. Used for rebuilding index files.

num_rows: u64

Number of rows in the file.

For historical reasons, this field might be missing in old files. Thus the default value 0 doesn’t means the file doesn’t contains any rows, but instead means the number of rows is unknown.

num_row_groups: u64

Number of row groups in the file.

For historical reasons, this field might be missing in old files. Thus the default value 0 doesn’t means the file doesn’t contains any rows, but instead means the number of rows is unknown.

sequence: Option<NonZeroU64>

Sequence in this file.

This sequence is the only sequence in this file. And it’s retrieved from the max sequence of the rows on generating this file.

partition_expr: Option<PartitionExpr>

Partition expression from the region metadata when the file is created.

This is stored as a PartitionExpr object in memory for convenience, but serialized as JSON string for manifest compatibility. Compatibility behavior:

• None: no partition expr was set when the file was created (legacy files).
• Some(expr): partition expression from region metadata.

num_series: u64

Number of series in the file.

The number is 0 if the series number is not available.

Implementations

impl FileMeta

pub fn exists_index(&self) -> bool

pub fn inverted_index_available(&self) -> bool

Returns true if the file has an inverted index

pub fn fulltext_index_available(&self) -> bool

Returns true if the file has a fulltext index

pub fn bloom_filter_index_available(&self) -> bool

Returns true if the file has a bloom filter index.

pub fn index_file_size(&self) -> u64

pub fn file_id(&self) -> RegionFileId

Returns the cross-region file id.

pub fn index_file_id(&self) -> RegionFileId

Returns the cross-region index file id. If the index file id is not set, returns the file id.

Trait Implementations

impl Clone for FileMeta

fn clone(&self) -> FileMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileMeta

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

Formats the value using the given formatter.

impl Default for FileMeta

fn default() -> FileMeta

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileMeta

where FileMeta: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileMeta

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

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 FileMeta

impl StructuralPartialEq for FileMeta