llkv-table 0.8.2-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

//! Shared catalog DDL trait for contexts that can execute plan-based schema operations.
//!
//! This trait lives in `llkv-table` so that the runtime, transaction, and session layers
//! can agree on a single contract without introducing circular dependencies. It captures
//! the common plan-driven schema mutations (create/drop table, rename table, create/drop
//! index) while letting each layer choose its own return types via associated outputs.

use llkv_plan::{
    AlterTablePlan, CreateIndexPlan, CreateTablePlan, CreateViewPlan, DropIndexPlan, DropTablePlan,
    DropViewPlan, RenameTablePlan,
};
use llkv_result::Result;

/// Common DDL operations that operate on catalog-backed tables and indexes.
///
/// Implementors provide plan-based entry points for schema mutations so higher layers
/// (runtime session, transaction staging, etc.) can share the same method signatures.
/// Associated output types keep the contract generic while still conveying the concrete
/// results used by each layer (e.g., `RuntimeStatementResult`, `TransactionResult`, or
/// unit for operations that only signal success).
pub trait CatalogDdl {
    /// Output of executing a CREATE TABLE plan.
    type CreateTableOutput;
    /// Output of executing a DROP TABLE plan.
    type DropTableOutput;
    /// Output of executing a table rename.
    type RenameTableOutput;
    /// Output of executing an ALTER TABLE plan.
    type AlterTableOutput;
    /// Output of executing a CREATE INDEX plan.
    type CreateIndexOutput;
    /// Output of executing a DROP INDEX plan.
    type DropIndexOutput;

    /// Creates a table described by the given plan.
    fn create_table(&self, plan: CreateTablePlan) -> Result<Self::CreateTableOutput>;

    /// Drops a table identified by the given plan.
    fn drop_table(&self, plan: DropTablePlan) -> Result<Self::DropTableOutput>;

    /// Creates a view described by the given plan.
    fn create_view(&self, plan: CreateViewPlan) -> Result<()>;

    /// Drops a view identified by the given plan.
    fn drop_view(&self, plan: DropViewPlan) -> Result<()>;

    /// Renames a table using the provided plan.
    fn rename_table(&self, plan: RenameTablePlan) -> Result<Self::RenameTableOutput>;

    /// Alters a table using the provided plan.
    fn alter_table(&self, plan: AlterTablePlan) -> Result<Self::AlterTableOutput>;

    /// Creates an index described by the given plan.
    fn create_index(&self, plan: CreateIndexPlan) -> Result<Self::CreateIndexOutput>;

    /// Drops a single-column index described by the given plan, returning metadata about the
    /// index when it existed.
    fn drop_index(&self, plan: DropIndexPlan) -> Result<Self::DropIndexOutput>;
}