328 lines
9.3 KiB
Rust
328 lines
9.3 KiB
Rust
use serde::{Deserialize, Serialize};
|
|
use std::collections::HashMap;
|
|
|
|
// 协议：Haskell 与 Rust 之间的请求 / 响应类型。
|
|
|
|
pub type Row = HashMap<String, serde_json::Value>;
|
|
|
|
pub const USERS_TABLE: &str = "__system_users";
|
|
pub const IDENTITIES_TABLE: &str = "__system_identities";
|
|
pub const TYPES_TABLE: &str = "__system_types";
|
|
|
|
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
|
|
pub struct Account {
|
|
pub id: i64,
|
|
pub user: String,
|
|
pub password_hash: String,
|
|
pub revision: u64,
|
|
#[serde(default)]
|
|
pub registered_at: String,
|
|
#[serde(default)]
|
|
pub last_login_at: Option<String>,
|
|
#[serde(default = "default_true")]
|
|
pub can_login: bool,
|
|
#[serde(default)]
|
|
pub is_superuser: bool,
|
|
#[serde(default)]
|
|
pub system_catalog_manager: bool,
|
|
#[serde(default)]
|
|
pub allow_sudo_auth: bool,
|
|
#[serde(default = "default_true")]
|
|
pub enabled: bool,
|
|
#[serde(default)]
|
|
pub identity_version: u8,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
|
|
pub struct SchemaColumn {
|
|
pub name: String,
|
|
pub ty: String,
|
|
#[serde(default = "default_true")]
|
|
pub nullable: bool,
|
|
#[serde(default)]
|
|
pub default: Option<serde_json::Value>,
|
|
#[serde(default)]
|
|
pub auto_increment: bool,
|
|
#[serde(default)]
|
|
pub primary_key: bool,
|
|
#[serde(default)]
|
|
pub unique: bool,
|
|
#[serde(default)]
|
|
pub check: Option<String>,
|
|
}
|
|
|
|
impl Default for SchemaColumn {
|
|
/// 列定义的默认值
|
|
fn default() -> Self {
|
|
SchemaColumn {
|
|
name: String::new(),
|
|
ty: String::new(),
|
|
nullable: true,
|
|
default: None,
|
|
auto_increment: false,
|
|
primary_key: false,
|
|
unique: false,
|
|
check: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// serde 里缺省为真
|
|
fn default_true() -> bool {
|
|
true
|
|
}
|
|
|
|
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
|
|
pub struct ColumnStatWire {
|
|
pub name: String,
|
|
pub distinct: u64,
|
|
#[serde(default)]
|
|
pub capped: bool,
|
|
#[serde(default)]
|
|
pub lo: Option<f64>,
|
|
#[serde(default)]
|
|
pub hi: Option<f64>,
|
|
#[serde(default)]
|
|
pub hist: Vec<u64>,
|
|
}
|
|
|
|
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
|
|
pub struct IndexWire {
|
|
pub column: String,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
#[serde(tag = "method", rename_all = "snake_case")]
|
|
pub enum Request {
|
|
CatalogManage { command: Box<Request> },
|
|
AccountsList,
|
|
IdentityInitialize { administrator: String },
|
|
RoleCreate { user: String },
|
|
IdentityAlter { user: String, can_login: Option<bool>, is_superuser: Option<bool>, enabled: Option<bool>, system_catalog_manager: Option<bool>, allow_sudo_auth: Option<bool> },
|
|
AccountCreate { user: String, password_hash: String },
|
|
AccountReset { user: String, password_hash: String },
|
|
AccountLogin {
|
|
user: String,
|
|
#[serde(default)]
|
|
at: Option<String>,
|
|
},
|
|
AccountDrop { user: String },
|
|
/// 引导系统目录：建系统表，给了 user 就同时补首个管理员
|
|
BootstrapSystem {
|
|
#[serde(default)]
|
|
user: Option<String>,
|
|
#[serde(default)]
|
|
password_hash: Option<String>,
|
|
},
|
|
SystemStatus,
|
|
BootstrapTypes { types: Vec<Row> },
|
|
Ping,
|
|
Scan {
|
|
table: String,
|
|
#[serde(default)]
|
|
columns: Option<Vec<String>>,
|
|
},
|
|
/// 分片扫描：第 shard 片只读总页数按 shards 均分后的那一段
|
|
ScanShard {
|
|
table: String,
|
|
#[serde(default)]
|
|
columns: Option<Vec<String>>,
|
|
shard: u32,
|
|
shards: u32,
|
|
},
|
|
Insert {
|
|
table: String,
|
|
row: Row,
|
|
},
|
|
InsertBatch {
|
|
table: String,
|
|
rows: Vec<Row>,
|
|
},
|
|
DeleteKeys {
|
|
table: String,
|
|
keys: Vec<i64>,
|
|
},
|
|
LookupByIndex {
|
|
table: String,
|
|
#[serde(default = "default_id_column")]
|
|
column: String,
|
|
key: serde_json::Value,
|
|
},
|
|
RangeByIndex {
|
|
table: String,
|
|
column: String,
|
|
#[serde(default)]
|
|
lo: Option<serde_json::Value>,
|
|
#[serde(default = "default_true")]
|
|
lo_inclusive: bool,
|
|
#[serde(default)]
|
|
hi: Option<serde_json::Value>,
|
|
#[serde(default = "default_true")]
|
|
hi_inclusive: bool,
|
|
},
|
|
ReplaceAll {
|
|
table: String,
|
|
rows: Vec<Row>,
|
|
},
|
|
ListTables,
|
|
DescribeTable {
|
|
table: String,
|
|
},
|
|
CreateTable {
|
|
table: String,
|
|
columns: Vec<SchemaColumn>,
|
|
},
|
|
DropTable {
|
|
table: String,
|
|
},
|
|
ListCatalog,
|
|
CreateIndex {
|
|
table: String,
|
|
column: String,
|
|
},
|
|
DropIndex {
|
|
table: String,
|
|
column: String,
|
|
},
|
|
DropColumn {
|
|
table: String,
|
|
column: String,
|
|
},
|
|
Compact {
|
|
table: String,
|
|
},
|
|
ReplaceSchema {
|
|
table: String,
|
|
columns: Vec<SchemaColumn>,
|
|
rows: Vec<Row>,
|
|
},
|
|
/// 事务提交：把一批写操作当成一个请求原子应用
|
|
ApplyTransaction {
|
|
ops: Vec<StorageOp>,
|
|
},
|
|
}
|
|
|
|
/// 事务提交里的一条写操作
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
#[serde(tag = "op", rename_all = "snake_case")]
|
|
pub enum StorageOp {
|
|
/// 追加写入的行（提交端已先删掉要覆盖的行）
|
|
Upsert { table: String, rows: Vec<Row> },
|
|
/// 按行 id 删除
|
|
Delete { table: String, ids: Vec<i64> },
|
|
/// 整表替换（没有整数 id 的表只能这么提交）
|
|
Replace { table: String, rows: Vec<Row> },
|
|
}
|
|
|
|
impl Request {
|
|
/// 拒绝可能影响文件路径的列名
|
|
pub fn valid_columns(&self) -> bool {
|
|
let valid = |name: &str| !name.is_empty()
|
|
&& name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_');
|
|
match self {
|
|
Self::CreateIndex { column, .. } | Self::DropIndex { column, .. }
|
|
| Self::DropColumn { column, .. } | Self::LookupByIndex { column, .. }
|
|
| Self::RangeByIndex { column, .. } => valid(column),
|
|
Self::CreateTable { columns, .. } => columns.iter().all(|c| valid(&c.name)),
|
|
Self::ReplaceSchema { columns, .. } => columns.iter().all(|c| valid(&c.name)),
|
|
_ => true,
|
|
}
|
|
}
|
|
/// 普通表操作的统一访问边界
|
|
pub fn table(&self) -> Option<&str> {
|
|
match self {
|
|
Self::Scan { table, .. } | Self::ScanShard { table, .. }
|
|
| Self::Insert { table, .. }
|
|
| Self::InsertBatch { table, .. } | Self::DeleteKeys { table, .. }
|
|
| Self::LookupByIndex { table, .. } | Self::ReplaceAll { table, .. }
|
|
| Self::RangeByIndex { table, .. }
|
|
| Self::DescribeTable { table } | Self::CreateTable { table, .. }
|
|
| Self::DropTable { table } | Self::CreateIndex { table, .. }
|
|
| Self::DropIndex { table, .. } | Self::DropColumn { table, .. }
|
|
| Self::Compact { table }
|
|
| Self::ReplaceSchema { table, .. } => Some(table),
|
|
Self::Ping | Self::ListTables | Self::ListCatalog | Self::AccountsList | Self::CatalogManage { .. }
|
|
| Self::IdentityInitialize { .. } | Self::RoleCreate { .. } | Self::IdentityAlter { .. }
|
|
| Self::AccountCreate { .. } | Self::AccountReset { .. } | Self::AccountLogin { .. }
|
|
| Self::AccountDrop { .. } | Self::BootstrapSystem { .. } | Self::SystemStatus
|
|
| Self::BootstrapTypes { .. }
|
|
| Self::ApplyTransaction { .. } => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// 是不是保留系统表名
|
|
pub fn reserved_table(table: &str) -> bool {
|
|
table.to_ascii_lowercase().starts_with("__system_")
|
|
}
|
|
|
|
/// 服务自己的角色与授权表名
|
|
pub const PRIVILEGE_TABLES: [&str; 4] = [
|
|
"__system_roles",
|
|
"__system_grants",
|
|
"__system_grant_options",
|
|
"__system_members",
|
|
];
|
|
|
|
/// 是不是服务自己经请求通道读写的系统表
|
|
pub fn internal_table(table: &str) -> bool {
|
|
let name = table.to_ascii_lowercase();
|
|
PRIVILEGE_TABLES.contains(&name.as_str()) || name.starts_with("__system_domain_")
|
|
}
|
|
|
|
/// 是不是请求通道要拒绝的系统表
|
|
pub fn blocked_table(table: &str) -> bool {
|
|
reserved_table(table) && !internal_table(table)
|
|
}
|
|
|
|
/// 没写 column 时按 `id` 算
|
|
fn default_id_column() -> String {
|
|
"id".to_string()
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize)]
|
|
#[serde(tag = "status", rename_all = "snake_case")]
|
|
pub enum Response {
|
|
Accounts { accounts: Vec<Account> },
|
|
Pong,
|
|
Rows { rows: Vec<Row> },
|
|
Tables { tables: Vec<String> },
|
|
Schema {
|
|
table: String,
|
|
columns: Vec<SchemaColumn>,
|
|
#[serde(default)]
|
|
row_count: u64,
|
|
#[serde(default)]
|
|
indexes: Vec<IndexWire>,
|
|
#[serde(default)]
|
|
stats: Vec<ColumnStatWire>,
|
|
},
|
|
NoIndex,
|
|
Ok,
|
|
/// 系统目录状态
|
|
System {
|
|
initialized: bool,
|
|
#[serde(default)]
|
|
last_lsn: u64,
|
|
},
|
|
Error { message: String },
|
|
Catalog { schemas: Vec<TableSchemaWire> },
|
|
Object { database_id: u64, object_id: Option<u64> },
|
|
}
|
|
|
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
|
pub struct TableSchemaWire {
|
|
pub table: String,
|
|
#[serde(default)]
|
|
pub database_id: u64,
|
|
#[serde(default)]
|
|
pub object_id: u64,
|
|
pub columns: Vec<SchemaColumn>,
|
|
#[serde(default)]
|
|
pub row_count: u64,
|
|
#[serde(default)]
|
|
pub indexes: Vec<IndexWire>,
|
|
#[serde(default)]
|
|
pub stats: Vec<ColumnStatWire>,
|
|
}
|