llkv-table 0.8.5-alpha

Columnar table using the LLKV toolkit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Table abstraction and system catalog for LLKV.
//!
//! This crate provides the [`Table`] type, which builds on `llkv-column-map`'s
//! columnar storage to offer a higher-level, schema-aware interface. It includes:
//!
//! - **[`Table`]**: Schema-aware table abstraction with append, scan, and schema operations
//! - **[`SysCatalog`]**: System catalog (table 0) that stores table and column metadata
//! - **[`TableMeta`]** and **[`ColMeta`]**: Metadata structures for tables and columns
//! - **Schema management**: Arrow schema integration with field ID tracking
//! - **Scan operations**: Projection, filtering, ordering, and computed columns
//! - **MVCC integration**: Automatic handling of `created_by` and `deleted_by` columns
//!
//! # Architecture
//!
//! Tables use [`ColumnStore`](llkv_column_map::ColumnStore) for physical storage but add:
//! - Schema validation and enforcement
//! - Field ID assignment and tracking
//! - System catalog for metadata persistence
//! - MVCC column management
//! - Row ID filtering (for transaction visibility)
//!
//! # Table IDs
//!
//! - **Table 0**: Reserved for the system catalog (stores [`TableMeta`] and [`ColMeta`])
//! - **Tables 1+**: User tables
//!
//! See [`CATALOG_TABLE_ID`] and [`is_reserved_table_id`](reserved::is_reserved_table_id).
//!
//! # System Catalog
//!
//! The [`SysCatalog`] stores table metadata in table 0, which is a reserved system table.
#![forbid(unsafe_code)]

pub mod catalog;
pub mod constants;
pub mod constraints;
pub mod ddl;
// TODO: Please don't separate these
pub mod diagnostics;
pub mod gather;
pub mod metadata;
pub mod reserved;
pub mod resolvers;
pub mod schema_ext;
mod sys_catalog;
pub mod view;
pub mod expr {
    pub use llkv_expr::expr::*;
}

pub mod table;
pub mod types;

pub use catalog::{CatalogManager, CreateTableResult, FieldResolver, TableCatalogSnapshot};
pub use catalog::{SingleColumnIndexDescriptor, SingleColumnIndexRegistration};
pub use constraints::{
    CheckConstraint, ConstraintColumnInfo, ConstraintEnforcementMode, ConstraintExpressionRef,
    ConstraintId, ConstraintKind, ConstraintRecord, ConstraintService, ConstraintState,
    ForeignKeyAction, ForeignKeyChildRowsFetch, ForeignKeyColumn, ForeignKeyConstraint,
    ForeignKeyParentRowsFetch, ForeignKeyRowFetch, ForeignKeyTableInfo, InsertColumnConstraint,
    InsertMultiColumnUnique, InsertUniqueColumn, PrimaryKeyConstraint, UniqueConstraint, UniqueKey,
    ValidatedForeignKey, build_composite_unique_key, column_in_foreign_keys,
    column_in_multi_column_unique, column_in_primary_or_unique, decode_constraint_row_id,
    encode_constraint_row_id, ensure_multi_column_unique, ensure_primary_key,
    ensure_single_column_unique, unique_key_component, validate_alter_table_operation,
    validate_check_constraints, validate_foreign_key_rows, validate_foreign_keys,
};
pub use ddl::CatalogDdl;
pub use ddl::{ObjectNameExt, OrderCreateTablesExt, TableConstraintExt};
pub use diagnostics::{TablePagerIngestionDiagnostics, TablePagerIngestionSample};
pub use llkv_compute::compute_binary;
pub use llkv_compute::eval::{AffineExpr, ScalarEvaluator as NumericKernels};
pub use metadata::MultiColumnUniqueRegistration;
pub use metadata::{ForeignKeyDescriptor, MetadataManager};
pub use reserved::{
    CATALOG_TABLE_ID, INFORMATION_SCHEMA_TABLE_ID_START, TEMPORARY_TABLE_ID_START,
    is_information_schema_table,
};
pub use resolvers::{canonical_table_name, resolve_table_name};
pub type NumericArrayMap = llkv_compute::eval::NumericArrayMap<FieldId>;
pub use sys_catalog::{
    ColMeta, CustomTypeMeta, MultiColumnIndexEntryMeta, SingleColumnIndexEntryMeta, SysCatalog,
    TableMeta, TableMultiColumnIndexMeta, TableSingleColumnIndexMeta, TableTriggerMeta,
    TriggerEntryMeta, TriggerEventMeta, TriggerTimingMeta,
};
pub use table::Table;
pub use types::{FieldId, ROW_ID_FIELD_ID, RowId, TableColumn, TableId};
pub use view::{ForeignKeyView, TableConstraintSummaryView, TableView};

pub use llkv_scan::row_stream::RowStream;

// TODO: Don't re-export, and call directly
pub use llkv_plan::{
    PLAN_GRAPH_VERSION, PlanAnnotations, PlanEdge, PlanEdgeMetadata, PlanExpression, PlanField,
    PlanGraph, PlanGraphBuilder, PlanGraphError, PlanGraphResult, PlanGraphVersion, PlanInput,
    PlanNode, PlanNodeId, PlanOperator,
};