jdb_trait 0.1.1

异步存储引擎数据库抽象层 / Async database abstraction layer for storage engines
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

#![cfg_attr(docsrs, feature(doc_cfg))]

mod expr;
mod query;
mod row;
mod schema;
mod sub_table;
mod table;
mod val;

use std::{fmt::Debug, future::Future};

pub use expr::{Expr, Op, Order};
use hipstr::HipByt;
pub use query::Query;
pub use row::{AsyncRow, Row};
pub use schema::{Field, Index, Schema, SchemaVer};
pub use sub_table::SubTable;
pub use table::Table;
pub use val::Val;

/// 全局 ID 类型
pub type Id = u64;

/// 列名 Column name
pub type Col = HipByt<'static>;

/// 列偏移量 Column offset in Row
pub type ColIdx = u16;

/// 子表键 (用于路由定位子表)
/// SubTable key for routing to sub-table partition
pub type SubTableKey = Row;

/// 异步记录 Async record
#[derive(Debug)]
pub struct AsyncItem<R: AsyncRow> {
  pub sub_table: SubTableKey,
  pub id: Id,
  pub row: R,
}

pub trait IdGen: Send + Sync {
  type Error: Debug + Send + Sync;
  fn get(&self) -> impl Future<Output = Result<Id, Self::Error>> + Send;
}

pub trait Engine: Sized + Send + Sync {
  type Error: Debug + Send + Sync;
  type Gen: IdGen;
  type Table: Table;

  fn id_gen(&self) -> &Self::Gen;

  /// 打开或创建表 Open or create table
  fn open<F, Fut>(
    &self,
    name: &[u8],
    create: F,
  ) -> impl Future<Output = Result<Self::Table, Self::Error>> + Send
  where
    F: FnOnce() -> Fut + Send,
    Fut: Future<Output = Schema> + Send;
}