Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Add/update doccomments in the read_buffer (#2245) 

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
pull/24376/head
Andrew Lamb 2021-08-10 17:26:02 -04:00 committed by GitHub
parent 0c300a4abb
commit 8626e9980b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
read_buffer/src/row_group.rs
View File

@ -1483,6 +1483,7 @@ impl ColumnType {
}
#[derive(Debug, Clone)]
/// Row Group metadata per Column
pub struct ColumnMeta {
pub typ: crate::schema::ColumnType,
pub logical_data_type: LogicalDataType,
@ -1524,19 +1525,20 @@ impl PartialEq for ColumnMeta {
}
#[derive(Default, Debug)]
/// The metadata for a RowGroup
pub struct MetaData {
// The total size in bytes of all column data in the `RowGroup`.
/// The total size in bytes of all column data in the `RowGroup`.
pub columns_size: usize,
// The total number of rows in the `RowGroup`.
/// The total number of rows in the `RowGroup`.
pub rows: u32,
// The distinct set of columns for this `RowGroup` (all of these columns
// will appear in all of the `Table`'s `RowGroup`s) and the range of values
// for each of those columns.
//
// This can be used to skip the table entirely if a logical predicate can't
// possibly match based on the range of values a column has.
/// The distinct set of columns for this `RowGroup` (all of these columns
/// will appear in all of the `Table`'s `RowGroup`s) and the range of values
/// for each of those columns.
///
/// This can be used to skip the table entirely if a logical predicate can't
/// possibly match based on the range of values a column has.
pub columns: BTreeMap<String, ColumnMeta>,
pub column_names: Vec<String>,

6
read_buffer/src/table.rs
View File

@ -540,8 +540,10 @@ impl Table {
}
}
// TODO(edd): reduce owned strings here by, e.g., using references as keys.
// Does not implement `Default`; must contain some data.
/// Table level MetaData
///
/// TODO(edd): reduce owned strings here by, e.g., using references as keys.
/// Does not implement `Default`; must contain some data.
#[derive(Clone)]
pub struct MetaData {
// The total size of all row-group data associated with the table in bytes.