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 ddl;
38// TODO: Please don't separate these
39pub mod diagnostics;
40pub mod gather;
41pub mod metadata;
42pub mod reserved;
43pub mod resolvers;
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 use catalog::{CatalogManager, CreateTableResult, FieldResolver, TableCatalogSnapshot};
55pub use catalog::{SingleColumnIndexDescriptor, SingleColumnIndexRegistration};
56pub use constraints::{
57    CheckConstraint, ConstraintColumnInfo, ConstraintEnforcementMode, ConstraintExpressionRef,
58    ConstraintId, ConstraintKind, ConstraintRecord, ConstraintService, ConstraintState,
59    ForeignKeyAction, ForeignKeyChildRowsFetch, ForeignKeyColumn, ForeignKeyConstraint,
60    ForeignKeyParentRowsFetch, ForeignKeyRowFetch, ForeignKeyTableInfo, InsertColumnConstraint,
61    InsertMultiColumnUnique, InsertUniqueColumn, PrimaryKeyConstraint, UniqueConstraint, UniqueKey,
62    ValidatedForeignKey, build_composite_unique_key, column_in_foreign_keys,
63    column_in_multi_column_unique, column_in_primary_or_unique, decode_constraint_row_id,
64    encode_constraint_row_id, ensure_multi_column_unique, ensure_primary_key,
65    ensure_single_column_unique, unique_key_component, validate_alter_table_operation,
66    validate_check_constraints, validate_foreign_key_rows, validate_foreign_keys,
67};
68pub use ddl::CatalogDdl;
69pub use ddl::{ObjectNameExt, OrderCreateTablesExt, TableConstraintExt};
70pub use diagnostics::{TablePagerIngestionDiagnostics, TablePagerIngestionSample};
71pub use llkv_compute::compute_binary;
72pub use llkv_compute::eval::{AffineExpr, ScalarEvaluator as NumericKernels};
73pub use metadata::MultiColumnUniqueRegistration;
74pub use metadata::{ForeignKeyDescriptor, MetadataManager};
75pub use reserved::{
76    CATALOG_TABLE_ID, INFORMATION_SCHEMA_TABLE_ID_START, TEMPORARY_TABLE_ID_START,
77    is_information_schema_table,
78};
79pub use resolvers::{canonical_table_name, resolve_table_name};
80pub type NumericArrayMap = llkv_compute::eval::NumericArrayMap<FieldId>;
81pub use sys_catalog::{
82    ColMeta, CustomTypeMeta, MultiColumnIndexEntryMeta, SingleColumnIndexEntryMeta, SysCatalog,
83    TableMeta, TableMultiColumnIndexMeta, TableSingleColumnIndexMeta, TableTriggerMeta,
84    TriggerEntryMeta, TriggerEventMeta, TriggerTimingMeta,
85};
86pub use table::Table;
87pub use types::{FieldId, ROW_ID_FIELD_ID, RowId, TableColumn, TableId};
88pub use view::{ForeignKeyView, TableConstraintSummaryView, TableView};
89
90pub use llkv_scan::row_stream::RowStream;
91
92// TODO: Don't re-export, and call directly
93pub use llkv_plan::{
94    PLAN_GRAPH_VERSION, PlanAnnotations, PlanEdge, PlanEdgeMetadata, PlanExpression, PlanField,
95    PlanGraph, PlanGraphBuilder, PlanGraphError, PlanGraphResult, PlanGraphVersion, PlanInput,
96    PlanNode, PlanNodeId, PlanOperator,
97};
llkv_table/lib.rs

llkv_table/
lib.rs
