alopex-cli 0.6.0

Command-line interface for Alopex DB
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
//! HNSW Command - HNSW index management
//!
//! Supports: create, stats, drop

use std::io::Write;
use std::path::PathBuf;

use alopex_embedded::{Database, HnswConfig, Metric};
use serde::{Deserialize, Serialize};

use crate::batch::BatchMode;
use crate::cli::{DistanceMetric, HnswCommand, OutputFormat};
use crate::client::http::{ClientError, HttpClient};
use crate::error::Result;
use crate::models::{Column, DataType, Row, Value};
use crate::output::formatter::Formatter;
use crate::output::RowCollector;
use crate::streaming::StreamingWriter;
use crate::tui::admin::{AdminBackend, AdminContext, AdminTarget, AuthCapabilities};
use crate::tui::renderer::render_output;

/// Default M parameter (max connections per node)
const DEFAULT_M: usize = 16;
/// Default ef_construction parameter
const DEFAULT_EF_CONSTRUCTION: usize = 200;

#[derive(Debug, Serialize)]
struct RemoteHnswCreateRequest {
    index: String,
    dim: usize,
    metric: String,
}

#[derive(Debug, Serialize)]
struct RemoteHnswDropRequest {
    index: String,
}

#[derive(Debug, Serialize)]
struct RemoteHnswStatsRequest {
    index: String,
}

#[derive(Debug, Deserialize)]
struct RemoteHnswStatsResponse {
    stats: RemoteHnswStats,
}

#[derive(Debug, Deserialize)]
struct RemoteHnswStats {
    node_count: u64,
    deleted_count: u64,
    memory_bytes: u64,
    avg_edges_per_node: f64,
}

#[derive(Debug, Deserialize)]
struct RemoteHnswStatusResponse {
    success: bool,
}

/// Execute an HNSW command.
///
/// # Arguments
///
/// * `db` - The database instance.
/// * `cmd` - The HNSW subcommand to execute.
/// * `writer` - The streaming writer for output.
pub fn execute<W: Write>(
    db: &Database,
    cmd: HnswCommand,
    writer: &mut StreamingWriter<W>,
) -> Result<()> {
    match cmd {
        HnswCommand::Create { name, dim, metric } => execute_create(db, &name, dim, metric, writer),
        HnswCommand::Stats { name } => execute_stats(db, &name, writer),
        HnswCommand::Drop { name } => execute_drop(db, &name, writer),
    }
}

#[allow(clippy::too_many_arguments)]
pub fn execute_tui(
    db: &Database,
    cmd: HnswCommand,
    batch_mode: &BatchMode,
    output_format: OutputFormat,
    columns: Vec<Column>,
    limit: Option<usize>,
    quiet: bool,
    connection_label: impl Into<String>,
    data_dir: Option<PathBuf>,
) -> Result<()> {
    let connection_label = connection_label.into();
    let context_message = Some(hnsw_command_context(&cmd));
    let admin_label = connection_label.clone();
    let admin_data_dir = data_dir.clone();
    let admin_launcher: Option<Box<dyn FnMut() -> Result<()> + '_>> = Some(Box::new(move || {
        let connection_label = admin_label.clone();
        let data_dir = admin_data_dir.clone();
        crate::tui::admin::run_admin_ui(AdminContext {
            connection_label,
            auth: AuthCapabilities::full(),
            backend: AdminBackend::Local {
                db,
                batch_mode,
                output_format,
                limit,
                quiet,
                data_dir,
            },
            initial_target: Some(AdminTarget::Hnsw),
        })
    }));
    let collector = RowCollector::new();
    let formatter = Box::new(collector.formatter());
    let mut sink = std::io::sink();
    let mut writer =
        StreamingWriter::new(&mut sink, formatter, columns.clone(), limit).with_quiet(quiet);
    execute(db, cmd, &mut writer)?;
    let warning = collector.truncation_warning();
    render_output(
        columns,
        collector.rows(),
        connection_label,
        context_message,
        true,
        warning,
        output_format,
        admin_launcher,
    )
}

/// Execute an HNSW command against a remote server.
pub async fn execute_remote_with_formatter<W: Write>(
    client: &HttpClient,
    cmd: &HnswCommand,
    writer: &mut W,
    formatter: Box<dyn Formatter>,
    limit: Option<usize>,
    quiet: bool,
) -> Result<()> {
    match cmd {
        HnswCommand::Create { name, dim, metric } => {
            execute_remote_create(client, name, *dim, *metric, writer, formatter, limit, quiet)
                .await
        }
        HnswCommand::Stats { name } => {
            execute_remote_stats(client, name, writer, formatter, limit, quiet).await
        }
        HnswCommand::Drop { name } => {
            execute_remote_drop(client, name, writer, formatter, limit, quiet).await
        }
    }
}

#[allow(clippy::too_many_arguments)]
pub async fn execute_remote_tui<'a>(
    client: &HttpClient,
    cmd: &HnswCommand,
    columns: Vec<Column>,
    output_format: OutputFormat,
    limit: Option<usize>,
    quiet: bool,
    connection_label: impl Into<String>,
    admin_launcher: Option<Box<dyn FnMut() -> Result<()> + 'a>>,
) -> Result<()> {
    let collector = RowCollector::new();
    let formatter = Box::new(collector.formatter());
    let mut sink = std::io::sink();
    execute_remote_with_formatter(client, cmd, &mut sink, formatter, limit, quiet).await?;
    let warning = collector.truncation_warning();
    render_output(
        columns,
        collector.rows(),
        connection_label,
        Some(hnsw_command_context(cmd)),
        true,
        warning,
        output_format,
        admin_launcher,
    )
}

/// Convert CLI distance metric to embedded Metric.
fn to_embedded_metric(metric: DistanceMetric) -> Metric {
    match metric {
        DistanceMetric::Cosine => Metric::Cosine,
        DistanceMetric::L2 => Metric::L2,
        DistanceMetric::Ip => Metric::InnerProduct,
    }
}

fn metric_to_string(metric: DistanceMetric) -> String {
    match metric {
        DistanceMetric::Cosine => "cosine".to_string(),
        DistanceMetric::L2 => "l2".to_string(),
        DistanceMetric::Ip => "ip".to_string(),
    }
}

#[allow(clippy::too_many_arguments)]
async fn execute_remote_create<W: Write>(
    client: &HttpClient,
    name: &str,
    dim: usize,
    metric: DistanceMetric,
    writer: &mut W,
    formatter: Box<dyn Formatter>,
    limit: Option<usize>,
    quiet: bool,
) -> Result<()> {
    let request = RemoteHnswCreateRequest {
        index: name.to_string(),
        dim,
        metric: metric_to_string(metric),
    };
    let response: RemoteHnswStatusResponse = client
        .post_json("hnsw/create", &request)
        .await
        .map_err(map_client_error)?;
    if response.success {
        if quiet {
            return Ok(());
        }
        let columns = hnsw_status_columns();
        let mut streaming_writer =
            StreamingWriter::new(writer, formatter, columns, limit).with_quiet(quiet);
        streaming_writer.prepare(Some(1))?;
        let row = Row::new(vec![
            Value::Text("OK".to_string()),
            Value::Text(format!("Created HNSW index: {}", name)),
        ]);
        streaming_writer.write_row(row)?;
        streaming_writer.finish()
    } else {
        Err(crate::error::CliError::InvalidArgument(
            "Failed to create HNSW index".to_string(),
        ))
    }
}

#[allow(clippy::too_many_arguments)]
async fn execute_remote_stats<W: Write>(
    client: &HttpClient,
    name: &str,
    writer: &mut W,
    formatter: Box<dyn Formatter>,
    limit: Option<usize>,
    quiet: bool,
) -> Result<()> {
    let request = RemoteHnswStatsRequest {
        index: name.to_string(),
    };
    let response: RemoteHnswStatsResponse = client
        .post_json("hnsw/stats", &request)
        .await
        .map_err(map_client_error)?;
    let stats = response.stats;
    let columns = hnsw_stats_columns();
    let mut streaming_writer =
        StreamingWriter::new(writer, formatter, columns, limit).with_quiet(quiet);
    streaming_writer.prepare(Some(4))?;
    let stats_rows = vec![
        ("node_count", Value::Int(stats.node_count as i64)),
        ("deleted_count", Value::Int(stats.deleted_count as i64)),
        ("memory_bytes", Value::Int(stats.memory_bytes as i64)),
        ("avg_edges_per_node", Value::Float(stats.avg_edges_per_node)),
    ];
    for (key, value) in stats_rows {
        let row = Row::new(vec![Value::Text(key.to_string()), value]);
        streaming_writer.write_row(row)?;
    }
    streaming_writer.finish()
}

#[allow(clippy::too_many_arguments)]
async fn execute_remote_drop<W: Write>(
    client: &HttpClient,
    name: &str,
    writer: &mut W,
    formatter: Box<dyn Formatter>,
    limit: Option<usize>,
    quiet: bool,
) -> Result<()> {
    let request = RemoteHnswDropRequest {
        index: name.to_string(),
    };
    let response: RemoteHnswStatusResponse = client
        .post_json("hnsw/drop", &request)
        .await
        .map_err(map_client_error)?;
    if response.success {
        if quiet {
            return Ok(());
        }
        let columns = hnsw_status_columns();
        let mut streaming_writer =
            StreamingWriter::new(writer, formatter, columns, limit).with_quiet(quiet);
        streaming_writer.prepare(Some(1))?;
        let row = Row::new(vec![
            Value::Text("OK".to_string()),
            Value::Text(format!("Dropped HNSW index: {}", name)),
        ]);
        streaming_writer.write_row(row)?;
        streaming_writer.finish()
    } else {
        Err(crate::error::CliError::InvalidArgument(
            "Failed to drop HNSW index".to_string(),
        ))
    }
}

fn map_client_error(err: ClientError) -> crate::error::CliError {
    match err {
        ClientError::Request { source, .. } => {
            crate::error::CliError::ServerConnection(format!("request failed: {source}"))
        }
        ClientError::InvalidUrl(message) => crate::error::CliError::InvalidArgument(message),
        ClientError::Build(message) => crate::error::CliError::InvalidArgument(message),
        ClientError::Auth(err) => crate::error::CliError::InvalidArgument(err.to_string()),
        ClientError::HttpStatus { status, body } => crate::error::CliError::InvalidArgument(
            format!("Server error: HTTP {} - {}", status.as_u16(), body),
        ),
    }
}

fn hnsw_command_context(cmd: &HnswCommand) -> String {
    match cmd {
        HnswCommand::Create { name, dim, metric } => format!(
            "hnsw create {name} --dim {dim} --metric {}",
            metric_to_string(*metric)
        ),
        HnswCommand::Stats { name } => format!("hnsw stats {name}"),
        HnswCommand::Drop { name } => format!("hnsw drop {name}"),
    }
}

/// Execute an HNSW create command.
fn execute_create<W: Write>(
    db: &Database,
    name: &str,
    dim: usize,
    metric: DistanceMetric,
    writer: &mut StreamingWriter<W>,
) -> Result<()> {
    let config = HnswConfig {
        dimension: dim,
        metric: to_embedded_metric(metric),
        m: DEFAULT_M,
        ef_construction: DEFAULT_EF_CONSTRUCTION,
    };

    db.create_hnsw_index(name, config)?;

    // Suppress status output in quiet mode
    if !writer.is_quiet() {
        writer.prepare(Some(1))?;
        let row = Row::new(vec![
            Value::Text("OK".to_string()),
            Value::Text(format!("Created HNSW index: {}", name)),
        ]);
        writer.write_row(row)?;
        writer.finish()?;
    }

    Ok(())
}

/// Execute an HNSW stats command.
fn execute_stats<W: Write>(
    db: &Database,
    name: &str,
    writer: &mut StreamingWriter<W>,
) -> Result<()> {
    let stats = db.get_hnsw_stats(name)?;

    // Output stats as rows
    writer.prepare(Some(4))?;

    // Output each stat as a row
    let stats_rows = vec![
        ("node_count", Value::Int(stats.node_count as i64)),
        ("deleted_count", Value::Int(stats.deleted_count as i64)),
        ("memory_bytes", Value::Int(stats.memory_bytes as i64)),
        ("avg_edges_per_node", Value::Float(stats.avg_edges_per_node)),
    ];

    for (key, value) in stats_rows {
        let row = Row::new(vec![Value::Text(key.to_string()), value]);
        writer.write_row(row)?;
    }

    writer.finish()?;
    Ok(())
}

/// Execute an HNSW drop command.
fn execute_drop<W: Write>(
    db: &Database,
    name: &str,
    writer: &mut StreamingWriter<W>,
) -> Result<()> {
    db.drop_hnsw_index(name)?;

    // Suppress status output in quiet mode
    if !writer.is_quiet() {
        writer.prepare(Some(1))?;
        let row = Row::new(vec![
            Value::Text("OK".to_string()),
            Value::Text(format!("Dropped HNSW index: {}", name)),
        ]);
        writer.write_row(row)?;
        writer.finish()?;
    }

    Ok(())
}

/// Create columns for HNSW stats output.
///
/// Note: value column is Text because stats include both integer and float values.
pub fn hnsw_stats_columns() -> Vec<Column> {
    vec![
        Column::new("property", DataType::Text),
        Column::new("value", DataType::Text),
    ]
}

/// Create columns for HNSW status output.
pub fn hnsw_status_columns() -> Vec<Column> {
    vec![
        Column::new("status", DataType::Text),
        Column::new("message", DataType::Text),
    ]
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::output::jsonl::JsonlFormatter;

    fn create_test_db() -> Database {
        Database::open_in_memory().unwrap()
    }

    fn create_stats_writer(output: &mut Vec<u8>) -> StreamingWriter<&mut Vec<u8>> {
        let formatter = Box::new(JsonlFormatter::new());
        let columns = hnsw_stats_columns();
        StreamingWriter::new(output, formatter, columns, None)
    }

    fn create_status_writer(output: &mut Vec<u8>) -> StreamingWriter<&mut Vec<u8>> {
        let formatter = Box::new(JsonlFormatter::new());
        let columns = hnsw_status_columns();
        StreamingWriter::new(output, formatter, columns, None)
    }

    #[test]
    fn test_create_hnsw_index() {
        let db = create_test_db();

        let mut output = Vec::new();
        {
            let mut writer = create_status_writer(&mut output);
            execute_create(&db, "test_index", 128, DistanceMetric::Cosine, &mut writer).unwrap();
        }

        let result = String::from_utf8(output).unwrap();
        assert!(result.contains("OK"));
        assert!(result.contains("Created HNSW index"));
    }

    #[test]
    fn test_create_hnsw_index_l2() {
        let db = create_test_db();

        let mut output = Vec::new();
        {
            let mut writer = create_status_writer(&mut output);
            execute_create(&db, "l2_index", 64, DistanceMetric::L2, &mut writer).unwrap();
        }

        let result = String::from_utf8(output).unwrap();
        assert!(result.contains("OK"));
        assert!(result.contains("Created HNSW index: l2_index"));
    }

    #[test]
    fn test_get_hnsw_stats() {
        let db = create_test_db();

        // Create index first
        {
            let mut output = Vec::new();
            let mut writer = create_status_writer(&mut output);
            execute_create(&db, "stats_test", 64, DistanceMetric::Cosine, &mut writer).unwrap();
        }

        // Get stats
        let mut output = Vec::new();
        {
            let mut writer = create_stats_writer(&mut output);
            execute_stats(&db, "stats_test", &mut writer).unwrap();
        }

        let result = String::from_utf8(output).unwrap();
        assert!(result.contains("node_count"));
        assert!(result.contains("memory_bytes"));
    }

    #[test]
    fn test_drop_hnsw_index() {
        let db = create_test_db();

        // Create index first
        {
            let mut output = Vec::new();
            let mut writer = create_status_writer(&mut output);
            execute_create(&db, "drop_test", 32, DistanceMetric::Cosine, &mut writer).unwrap();
        }

        // Drop index
        let mut output = Vec::new();
        {
            let mut writer = create_status_writer(&mut output);
            execute_drop(&db, "drop_test", &mut writer).unwrap();
        }

        let result = String::from_utf8(output).unwrap();
        assert!(result.contains("OK"));
        assert!(result.contains("Dropped HNSW index"));
    }

    #[test]
    fn test_create_and_query_index() {
        let db = create_test_db();

        // Create index
        {
            let mut output = Vec::new();
            let mut writer = create_status_writer(&mut output);
            execute_create(&db, "query_test", 3, DistanceMetric::Cosine, &mut writer).unwrap();
        }

        // Stats should show 0 vectors initially
        let mut output = Vec::new();
        {
            let mut writer = create_stats_writer(&mut output);
            execute_stats(&db, "query_test", &mut writer).unwrap();
        }

        let result = String::from_utf8(output).unwrap();
        assert!(result.contains("node_count"));
    }
}