alopex-server 0.4.1

Server component for Alopex DB
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use std::sync::Arc;

use alopex_core::columnar::encoding::Column;
use alopex_core::columnar::kvs_bridge::ColumnarKvsBridge;
use alopex_core::columnar::segment_v2::{ColumnSegmentV2, RecordBatch};
use alopex_core::columnar::ColumnarError;
use alopex_core::kv::KVTransaction;
use alopex_core::storage::format::bincode_config;
use alopex_core::types::TxnMode;
use alopex_core::KVStore;
use alopex_sql::SqlValue;
use axum::extract::Extension;
use axum::response::Response;
use axum::Json;
use bincode::config::Options;
use serde::{Deserialize, Serialize};
use std::hash::{Hash, Hasher};
use std::time::Instant;

use crate::error::{Result, ServerError};
use crate::http::{error_response, json_response, RequestContext};
use crate::server::ServerState;

#[derive(Debug, Deserialize)]
pub struct ColumnarScanRequest {
    pub segment_id: String,
}

#[derive(Debug, Deserialize)]
pub struct ColumnarStatsRequest {
    pub segment_id: String,
}

#[derive(Debug, Deserialize)]
pub struct ColumnarIndexCreateRequest {
    pub segment_id: String,
    pub column: String,
    pub index_type: String,
}

#[derive(Debug, Deserialize)]
pub struct ColumnarIndexListRequest {
    pub segment_id: String,
}

#[derive(Debug, Deserialize)]
pub struct ColumnarIndexDropRequest {
    pub segment_id: String,
    pub column: String,
}

#[derive(Debug, Deserialize)]
pub struct ColumnarIngestRequest {
    pub table: String,
    pub compression: String,
    pub segment: Vec<u8>,
}

#[derive(Debug, Serialize)]
pub struct ColumnarScanResponse {
    pub rows: Vec<Vec<SqlValue>>,
}

#[derive(Debug, Serialize)]
pub struct ColumnarStatsResponse {
    pub row_count: usize,
    pub column_count: usize,
    pub size_bytes: u64,
}

#[derive(Debug, Serialize)]
pub struct ColumnarListResponse {
    pub segments: Vec<String>,
}

#[derive(Debug, Serialize)]
pub struct ColumnarIndexInfo {
    pub column: String,
    pub index_type: String,
}

#[derive(Debug, Serialize)]
pub struct ColumnarIndexListResponse {
    pub indexes: Vec<ColumnarIndexInfo>,
}

#[derive(Debug, Serialize)]
pub struct ColumnarIngestResponse {
    pub row_count: u64,
    pub segment_id: String,
    pub size_bytes: u64,
    pub compression: String,
    pub elapsed_ms: u64,
}

#[derive(Debug, Serialize)]
pub struct ColumnarStatusResponse {
    pub success: bool,
}

pub async fn scan(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
    Json(request): Json<ColumnarScanRequest>,
) -> Response {
    match scan_impl(state.clone(), request) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

pub async fn stats(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
    Json(request): Json<ColumnarStatsRequest>,
) -> Response {
    match stats_impl(state.clone(), request) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

pub async fn list(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
) -> Response {
    match list_impl(state.clone()) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

pub async fn index_create(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
    Json(request): Json<ColumnarIndexCreateRequest>,
) -> Response {
    match index_create_impl(state.clone(), request) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

pub async fn index_list(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
    Json(request): Json<ColumnarIndexListRequest>,
) -> Response {
    match index_list_impl(state.clone(), request) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

pub async fn index_drop(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
    Json(request): Json<ColumnarIndexDropRequest>,
) -> Response {
    match index_drop_impl(state.clone(), request) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

pub async fn ingest(
    Extension(state): Extension<Arc<ServerState>>,
    Extension(ctx): Extension<RequestContext>,
    Json(request): Json<ColumnarIngestRequest>,
) -> Response {
    match ingest_impl(state.clone(), request) {
        Ok(resp) => json_response(resp, state.config.max_response_size, &ctx),
        Err(err) => error_response(err, &ctx),
    }
}

fn scan_impl(
    state: Arc<ServerState>,
    request: ColumnarScanRequest,
) -> Result<ColumnarScanResponse> {
    let bridge = ColumnarKvsBridge::new(state.store.clone());
    let (table_id, seg_id) = parse_segment_id(&request.segment_id)?;
    let column_count = bridge
        .column_count(table_id, seg_id)
        .map_err(map_columnar_error)?;
    let batches = bridge
        .read_segment(table_id, seg_id, &(0..column_count).collect::<Vec<_>>())
        .map_err(map_columnar_error)?;
    Ok(ColumnarScanResponse {
        rows: batches_to_rows(batches),
    })
}

fn stats_impl(
    state: Arc<ServerState>,
    request: ColumnarStatsRequest,
) -> Result<ColumnarStatsResponse> {
    let bridge = ColumnarKvsBridge::new(state.store.clone());
    let (table_id, seg_id) = parse_segment_id(&request.segment_id)?;
    let column_count = bridge
        .column_count(table_id, seg_id)
        .map_err(map_columnar_error)?;
    let batches = bridge
        .read_segment(table_id, seg_id, &(0..column_count).collect::<Vec<_>>())
        .map_err(map_columnar_error)?;
    let row_count: usize = batches.iter().map(|batch| batch.num_rows()).sum();
    Ok(ColumnarStatsResponse {
        row_count,
        column_count,
        size_bytes: 0,
    })
}

fn list_impl(state: Arc<ServerState>) -> Result<ColumnarListResponse> {
    let bridge = ColumnarKvsBridge::new(state.store.clone());
    let segments = bridge.list_segments().map_err(map_columnar_error)?;
    let segment_ids = segments
        .into_iter()
        .map(|(table_id, seg_id)| format!("{}:{}", table_id, seg_id))
        .collect();
    Ok(ColumnarListResponse {
        segments: segment_ids,
    })
}

fn index_create_impl(
    state: Arc<ServerState>,
    request: ColumnarIndexCreateRequest,
) -> Result<ColumnarStatusResponse> {
    validate_segment_exists(state.store.clone(), &request.segment_id)?;
    let index_type = parse_index_type(&request.index_type)?;
    let key = columnar_index_key(&request.segment_id, &request.column);
    let mut txn = state.store.begin(TxnMode::ReadWrite)?;
    txn.put(key, index_type.as_bytes().to_vec())?;
    txn.commit_self()?;
    Ok(ColumnarStatusResponse { success: true })
}

fn index_list_impl(
    state: Arc<ServerState>,
    request: ColumnarIndexListRequest,
) -> Result<ColumnarIndexListResponse> {
    validate_segment_exists(state.store.clone(), &request.segment_id)?;
    let prefix = columnar_index_prefix(&request.segment_id);
    let mut txn = state.store.begin(TxnMode::ReadOnly)?;
    let mut indexes = Vec::new();
    for (key, value) in txn.scan_prefix(&prefix)? {
        let column = parse_index_column(&request.segment_id, &key)?;
        let index_type = parse_index_type(std::str::from_utf8(&value).map_err(|_| {
            ServerError::BadRequest("columnar index type is not valid UTF-8".into())
        })?)?;
        indexes.push(ColumnarIndexInfo { column, index_type });
    }
    txn.commit_self()?;
    Ok(ColumnarIndexListResponse { indexes })
}

fn index_drop_impl(
    state: Arc<ServerState>,
    request: ColumnarIndexDropRequest,
) -> Result<ColumnarStatusResponse> {
    validate_segment_exists(state.store.clone(), &request.segment_id)?;
    let key = columnar_index_key(&request.segment_id, &request.column);
    let mut txn = state.store.begin(TxnMode::ReadWrite)?;
    let exists = txn.get(&key)?.is_some();
    if !exists {
        txn.rollback_self()?;
        return Err(ServerError::NotFound(format!(
            "columnar index {}:{} not found",
            request.segment_id, request.column
        )));
    }
    txn.delete(key)?;
    txn.commit_self()?;
    Ok(ColumnarStatusResponse { success: true })
}

fn ingest_impl(
    state: Arc<ServerState>,
    request: ColumnarIngestRequest,
) -> Result<ColumnarIngestResponse> {
    if request.table.is_empty() {
        return Err(ServerError::BadRequest("table is required".into()));
    }
    let start = Instant::now();
    let segment: ColumnSegmentV2 =
        bincode_config()
            .deserialize(&request.segment)
            .map_err(|err| {
                ServerError::BadRequest(format!("invalid columnar segment payload: {err}"))
            })?;
    let bridge = ColumnarKvsBridge::new(state.store.clone());
    let table_id = table_id(&request.table)?;
    let seg_id = bridge
        .write_segment(table_id, &segment)
        .map_err(map_columnar_error)?;
    let segment_id = format!("{}:{}", table_id, seg_id);
    Ok(ColumnarIngestResponse {
        row_count: segment.meta.num_rows,
        segment_id,
        size_bytes: segment.meta.compressed_size,
        compression: request.compression,
        elapsed_ms: start.elapsed().as_millis() as u64,
    })
}

fn validate_segment_exists(store: Arc<alopex_core::kv::AnyKV>, segment_id: &str) -> Result<()> {
    let bridge = ColumnarKvsBridge::new(store);
    let (table_id, seg_id) = parse_segment_id(segment_id)?;
    bridge
        .column_count(table_id, seg_id)
        .map_err(map_columnar_error)?;
    Ok(())
}

fn batches_to_rows(batches: Vec<RecordBatch>) -> Vec<Vec<SqlValue>> {
    let mut rows = Vec::new();
    for batch in batches {
        let num_rows = batch.num_rows();
        for row_idx in 0..num_rows {
            let mut row = Vec::with_capacity(batch.columns.len());
            for col in &batch.columns {
                row.push(column_value_to_sql_value(col, row_idx));
            }
            rows.push(row);
        }
    }
    rows
}

fn column_value_to_sql_value(col: &Column, row_idx: usize) -> SqlValue {
    match col {
        Column::Int64(vals) => vals
            .get(row_idx)
            .map(|&v| SqlValue::BigInt(v))
            .unwrap_or(SqlValue::Null),
        Column::Float32(vals) => vals
            .get(row_idx)
            .map(|&v| SqlValue::Float(v))
            .unwrap_or(SqlValue::Null),
        Column::Float64(vals) => vals
            .get(row_idx)
            .map(|&v| SqlValue::Double(v))
            .unwrap_or(SqlValue::Null),
        Column::Bool(vals) => vals
            .get(row_idx)
            .copied()
            .map(SqlValue::Boolean)
            .unwrap_or(SqlValue::Null),
        Column::Binary(vals) => vals
            .get(row_idx)
            .cloned()
            .map(SqlValue::Blob)
            .unwrap_or(SqlValue::Null),
        Column::Fixed { values, .. } => values
            .get(row_idx)
            .cloned()
            .map(SqlValue::Blob)
            .unwrap_or(SqlValue::Null),
    }
}

fn parse_segment_id(segment_id: &str) -> Result<(u32, u64)> {
    let parts: Vec<&str> = segment_id.split(':').collect();
    if parts.len() != 2 {
        return Err(ServerError::BadRequest(format!(
            "invalid segment ID format: expected 'table_id:segment_id', got '{}'",
            segment_id
        )));
    }

    let table_id: u32 = parts[0].parse().map_err(|_| {
        ServerError::BadRequest(format!("invalid table_id in segment ID: '{}'", parts[0]))
    })?;

    let seg_id: u64 = parts[1].parse().map_err(|_| {
        ServerError::BadRequest(format!("invalid segment_id in segment ID: '{}'", parts[1]))
    })?;

    Ok((table_id, seg_id))
}

fn table_id(table: &str) -> Result<u32> {
    let mut hasher = std::collections::hash_map::DefaultHasher::new();
    table.hash(&mut hasher);
    Ok((hasher.finish() & 0xffff_ffff) as u32)
}

const COLUMNAR_INDEX_PREFIX: &str = "__alopex_columnar_index__:";

fn columnar_index_key(segment: &str, column: &str) -> Vec<u8> {
    let mut key =
        String::with_capacity(COLUMNAR_INDEX_PREFIX.len() + segment.len() + column.len() + 1);
    key.push_str(COLUMNAR_INDEX_PREFIX);
    key.push_str(segment);
    key.push(':');
    key.push_str(column);
    key.into_bytes()
}

fn columnar_index_prefix(segment: &str) -> Vec<u8> {
    let mut key = String::with_capacity(COLUMNAR_INDEX_PREFIX.len() + segment.len() + 1);
    key.push_str(COLUMNAR_INDEX_PREFIX);
    key.push_str(segment);
    key.push(':');
    key.into_bytes()
}

fn parse_index_column(segment: &str, key: &[u8]) -> Result<String> {
    let prefix = columnar_index_prefix(segment);
    if !key.starts_with(&prefix) {
        return Err(ServerError::BadRequest(
            "columnar index key is invalid".into(),
        ));
    }
    let suffix = &key[prefix.len()..];
    String::from_utf8(suffix.to_vec())
        .map_err(|_| ServerError::BadRequest("columnar index column is not valid UTF-8".into()))
}

fn parse_index_type(raw: &str) -> Result<String> {
    match raw {
        "minmax" | "bloom" => Ok(raw.to_string()),
        other => Err(ServerError::BadRequest(format!(
            "unknown columnar index type: {other}"
        ))),
    }
}

fn map_columnar_error(err: ColumnarError) -> ServerError {
    match err {
        ColumnarError::NotFound => ServerError::NotFound("columnar segment not found".into()),
        ColumnarError::InvalidFormat(message) => {
            ServerError::BadRequest(format!("columnar segment invalid: {message}"))
        }
        ColumnarError::MemoryLimitExceeded { limit, requested } => ServerError::PayloadTooLarge(
            format!("memory limit {limit} exceeded by {requested} bytes"),
        ),
        other => ServerError::Core(other.into()),
    }
}