Struct rustdb::table::Table

pub struct Table {
    pub file: Rc<SortedFile>,
    pub info: Rc<ColInfo>,
    pub ixlist: RefCell<IxList>,
    pub id: i64,
    pub id_gen: Cell<i64>,
    pub id_gen_dirty: Cell<bool>,
}

Database base table. Underlying file, type information about the columns and id allocation.

Fields

file: Rc<SortedFile>

Underlying SortedFile.

info: Rc<ColInfo>

Type information about the columns.

ixlist: RefCell<IxList>

List of indexes. ( Maybe could eliminate the RefCell )

id: i64

Table id in sys.Table.

id_gen: Cell<i64>

Row id allocator.

id_gen_dirty: Cell<bool>

Row id allocator has changed.

Implementations

impl Table

pub fn new(id: i64, root_page: u64, id_gen: i64, info: Rc<ColInfo>) -> Rc<Table>

Construct a table with specified info.

pub fn save(&self, db: &DB, op: SaveOp)

Save or Rollback underlying files.

pub fn free_pages(&self, db: &DB)

Drop the underlying file storage ( the table is not useable after this ).

pub fn insert(&self, db: &DB, row: &mut Row)

Insert specified row into the table.

pub fn remove(&self, db: &DB, row: &Row)

Remove specified loaded row from the table.

pub fn index_from(
    self: &Rc<Table>,
    b: &Block<'_>,
    we: &mut Expr
) -> (Option<CExpPtr<bool>>, Option<CTableExpression>)

Look for indexed table expression based on supplied WHERE expression (we).

pub fn id_get(&self, db: &DB, id: u64) -> Option<(PagePtr, usize)>

Get record with specified id.

pub fn ix_get(
    &self,
    db: &DB,
    key: Vec<Value>,
    index: usize
) -> Option<(PagePtr, usize)>

Get record with matching key, using specified index.

pub fn scan(&self, db: &DB) -> Asc

Scan all the records in the table.

pub fn scan_id(self: &Rc<Table>, db: &DB, id: i64) -> IdScan

Get a single record with specified id.

pub fn scan_key(
    self: &Rc<Table>,
    db: &DB,
    key: Value,
    index: usize
) -> IndexScan

Get records with matching key.

pub fn scan_keys(
    self: &Rc<Table>,
    db: &DB,
    keys: Vec<Value>,
    index: usize
) -> IndexScan

Get records with matching keys.

pub fn add_index(&self, root: u64, cols: Vec<usize>)

Add the specified index to the table.

pub fn delete_index(&self, db: &DB, ix: usize)

Delete the specified index.

pub fn init_index(&self, db: &DB)

Initialises last index ( called just after add_index ).

pub fn access<'d, 't>(&'t self, p: &'d Page, off: usize) -> Access<'d, 't>

Utility for accessing fields by number.

pub fn write_access<'d, 't>(
    &'t self,
    p: &'d mut Page,
    off: usize
) -> WriteAccess<'d, 't>

Utility for updating fields by number.

pub fn row(&self) -> Row

Construct a row for the table.

pub fn alloc_id(&self) -> i64

Allocate row id.

pub fn id_allocated(&self, id: i64)

Update id allocator if supplied row id exceeds current value.

pub fn repack(&self, db: &DB, k: usize) -> i64

Repack the file pages.

pub fn get_used(&self, db: &DB, to: &mut HashSet<u64>)

Add the all the pages used by the table to the specified set.