llkv_table/
lib.rs

1//! Table abstraction and system catalog for LLKV.
2//!
3//! This crate provides the [`Table`] type, which builds on [`llkv-column-map`]'s
4//! columnar storage to offer a higher-level, schema-aware interface. It includes:
5//!
6//! - **[`Table`]**: Schema-aware table abstraction with append, scan, and schema operations
7//! - **[`SysCatalog`]**: System catalog (table 0) that stores table and column metadata
8//! - **[`TableMeta`]** and **[`ColMeta`]**: Metadata structures for tables and columns
9//! - **Schema management**: Arrow schema integration with field ID tracking
10//! - **Scan operations**: Projection, filtering, ordering, and computed columns
11//! - **MVCC integration**: Automatic handling of `created_by` and `deleted_by` columns
12//!
13//! # Architecture
14//!
15//! Tables use [`ColumnStore`](llkv_column_map::ColumnStore) for physical storage but add:
16//! - Schema validation and enforcement
17//! - Field ID assignment and tracking
18//! - System catalog for metadata persistence
19//! - MVCC column management
20//! - Row ID filtering (for transaction visibility)
21//!
22//! # Table IDs
23//!
24//! - **Table 0**: Reserved for the system catalog (stores [`TableMeta`] and [`ColMeta`])
25//! - **Tables 1+**: User tables
26//!
27//! See [`CATALOG_TABLE_ID`] and [`is_reserved_table_id`](reserved::is_reserved_table_id).
28//!
29//! # System Catalog
30//!
31//! The [`SysCatalog`] stores table metadata in table 0, which is a reserved system table.
32#![forbid(unsafe_code)]
33
34pub mod catalog;
35pub mod constants;
36pub mod constraints;
37pub mod gather;
38pub mod metadata;
39pub mod mvcc;
40mod planner;
41pub mod reserved;
42pub mod resolvers;
43mod scalar_eval;
44pub mod schema_ext;
45mod sys_catalog;
46pub mod view;
47pub mod expr {
48    pub use llkv_expr::expr::*;
49}
50
51pub mod table;
52pub mod types;
53
54pub mod stream;
55
56pub use catalog::{CatalogManager, CreateTableResult, FieldResolver, TableCatalogSnapshot};
57pub use constraints::{
58    CheckConstraint, ConstraintColumnInfo, ConstraintExpressionRef, ConstraintId, ConstraintKind,
59    ConstraintRecord, ConstraintService, ConstraintState, ForeignKeyAction,
60    ForeignKeyChildRowsFetch, ForeignKeyColumn, ForeignKeyConstraint, ForeignKeyParentRowsFetch,
61    ForeignKeyRowFetch, ForeignKeyTableInfo, InsertColumnConstraint, InsertMultiColumnUnique,
62    InsertUniqueColumn, PrimaryKeyConstraint, UniqueConstraint, UniqueKey, ValidatedForeignKey,
63    build_composite_unique_key, decode_constraint_row_id, encode_constraint_row_id,
64    ensure_multi_column_unique, ensure_primary_key, ensure_single_column_unique,
65    unique_key_component, validate_check_constraints, validate_foreign_key_rows,
66    validate_foreign_keys,
67};
68pub use metadata::MultiColumnUniqueRegistration;
69pub use metadata::{ForeignKeyDescriptor, MetadataManager};
70pub use reserved::CATALOG_TABLE_ID;
71pub use resolvers::{canonical_table_name, resolve_table_name};
72pub use stream::{ColumnStream, ColumnStreamBatch};
73pub use sys_catalog::{
74    ColMeta, MultiColumnUniqueEntryMeta, SysCatalog, TableMeta, TableMultiColumnUniqueMeta,
75};
76pub use table::Table;
77pub use types::{FieldId, ROW_ID_FIELD_ID, RowId, TableColumn, TableId};
78pub use view::{ForeignKeyView, TableConstraintSummaryView, TableView};
79
80pub use planner::plan_graph::{
81    PLAN_GRAPH_VERSION, PlanAnnotations, PlanEdge, PlanEdgeMetadata, PlanExpression, PlanField,
82    PlanGraph, PlanGraphBuilder, PlanGraphError, PlanGraphResult, PlanGraphVersion, PlanInput,
83    PlanNode, PlanNodeId, PlanOperator,
84};
llkv_table/lib.rs

llkv_table/
lib.rs
