qql-cli 0.4.1

Command-line interface, REPL, converter, and migration tools for QQL
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
//! Shared CLI runtime: executor construction, embed settings, explain.

#[cfg(all(feature = "edge", feature = "fastembed"))]
use std::io::IsTerminal;

/// Resolve dense embedder settings from env (`EMBED_*`) over persisted config.
/// Returns `(endpoint, model, expected_dim, dim_source)`.
pub(crate) fn resolve_embed_settings() -> (Option<String>, String, usize, String) {
    let config = qql::config::QqlConfig::load()
        .ok()
        .flatten()
        .unwrap_or_default();
    let endpoint = std::env::var("EMBED_URL")
        .ok()
        .filter(|v| !v.trim().is_empty())
        .or_else(|| {
            config
                .embedding_endpoint
                .clone()
                .filter(|v| !v.trim().is_empty())
        });
    let model = std::env::var("EMBED_MODEL")
        .ok()
        .filter(|v| !v.trim().is_empty())
        .or_else(|| config.embedding_model.clone())
        .unwrap_or_else(|| "all-minilm:l6-v2".to_string());
    if let Ok(raw) = std::env::var("EMBED_DIM")
        && let Ok(dim) = raw.trim().parse::<usize>()
        && dim > 0
    {
        return (endpoint, model, dim, "EMBED_DIM".to_string());
    }
    if config.embedding_dimension > 0 {
        return (
            endpoint,
            model,
            config.embedding_dimension,
            "config embedding_dimension".to_string(),
        );
    }
    (endpoint, model, 384, "default 384".to_string())
}

/// Classify a backend failure as unreachable vs auth vs other for doctor output.
pub(crate) fn classify_backend_failure(code: &str, message: &str) -> &'static str {
    if code == "QQL-TRANSPORT" || code == "QQL-BACKEND-JSON" && message.contains("request id") {
        // Transport covers refused connections, DNS, and timeouts.
        "unreachable"
    } else if code == "QQL-BACKEND-AUTH" {
        "auth"
    } else if message.contains("connection refused")
        || message.contains("Connection refused")
        || message.contains("dns error")
        || message.contains("failed to lookup address")
    {
        "unreachable"
    } else {
        "other"
    }
}

pub(crate) fn dense_vector_sizes(info: &qql::client::CollectionInfo) -> Vec<(String, u64)> {
    info.schema
        .vectors
        .iter()
        .map(|v| (v.name.clone().unwrap_or_default(), v.size))
        .collect()
}

#[cfg(feature = "rest")]
pub(crate) async fn probe_embed_dim(
    endpoint: &str,
    model: &str,
    dim: usize,
) -> Result<usize, qql_core::error::QqlError> {
    let api_key = std::env::var("EMBED_KEY").unwrap_or_default();
    let embedder =
        qql::embedder::HttpEmbedder::try_with_options(qql::embedder::HttpEmbedderOptions {
            endpoint: endpoint.to_string(),
            api_key,
            model: model.to_string(),
            dimension: dim.max(1),
            ..Default::default()
        })?;
    embedder.probe_dimension("qql doctor probe").await
}

/// Explain a query, binding `params` on the AST — the same binding `run`
/// uses — so placeholders (`:rows`, `:q`, `?`) explain exactly as executed.
pub(crate) fn explain_query_bound(
    query: &str,
    params: Option<&serde_json::Value>,
) -> Result<String, String> {
    let Some(params) = params else {
        return explain_query(query);
    };
    let mut statements = qql_core::parser::Parser::parse_all(query).map_err(|e| e.to_string())?;
    for stmt in &mut statements {
        qql_core::params_json::bind_stmt_with_params(stmt, params).map_err(|e| e.to_string())?;
    }
    Ok(qql_core::explain::explain_nodes(&statements))
}

/// Open the interactive REPL against `url` (or the local edge backend).
pub async fn handle_connect(
    url: &str,
    use_edge: bool,
    initial_params: Option<&serde_json::Value>,
) -> Result<(), Box<dyn std::error::Error>> {
    let executor = executor(url, use_edge)?;
    let initial = executor
        .execute("SHOW COLLECTIONS", qql::executor::OnError::Stop)
        .await;
    if let Err(error) = initial {
        executor.close().await?;
        return Err(error.into());
    }
    crate::repl::run_repl(url, use_edge, executor, initial_params).await
}

pub fn explain_query_str(query: &str) -> Result<String, String> {
    explain_query(query)
}

pub(crate) fn executor(
    url: &str,
    use_edge: bool,
) -> Result<qql::executor::Executor, Box<dyn std::error::Error>> {
    executor_for(url, use_edge, None)
}

pub(crate) fn executor_for(
    url: &str,
    use_edge: bool,
    api_key: Option<String>,
) -> Result<qql::executor::Executor, Box<dyn std::error::Error>> {
    if use_edge {
        #[cfg(feature = "edge")]
        {
            return edge_executor();
        }
        #[cfg(not(feature = "edge"))]
        {
            return Err(
                "edge support is not installed (this binary is standard edition); install the full edition with: curl -fsSL https://qql.veristamp.in/install.sh | bash -s -- --full (or cargo install qql-cli --locked --features full)"
                    .into(),
            );
        }
    }

    let config = qql::config::QqlConfig::load()?.unwrap_or_default();

    #[cfg(feature = "grpc")]
    let use_grpc = url.starts_with("grpc://") || url.contains(":6334");
    #[cfg(not(feature = "grpc"))]
    let use_grpc = false;

    let client: Box<dyn qql::client::QdrantOps> = if use_grpc {
        #[cfg(feature = "grpc")]
        {
            Box::new(qql::grpc::GrpcQdrant::from_url(
                url,
                api_key
                    .clone()
                    .or_else(|| std::env::var("QDRANT_API_KEY").ok())
                    .or_else(|| config.secret.clone()),
            )?)
        }
        #[cfg(not(feature = "grpc"))]
        {
            return Err("gRPC support is disabled in this build".into());
        }
    } else {
        #[cfg(feature = "rest")]
        {
            Box::new(qql::rest::RestQdrant::new(
                url.to_owned(),
                api_key
                    .or_else(|| std::env::var("QDRANT_API_KEY").ok())
                    .or_else(|| config.secret.clone()),
            ))
        }
        #[cfg(not(feature = "rest"))]
        {
            return Err(
                "REST support is disabled in this build; use a gRPC URL (:6334) or rebuild with --features rest"
                    .into(),
            );
        }
    };

    let env_embed_type = std::env::var("EMBED_TYPE").ok();
    let is_fastembed = env_embed_type.as_deref() == Some("fastembed")
        || (env_embed_type.is_none() && std::env::var("QQL_FASTEMBED").is_ok());

    #[cfg(feature = "fastembed")]
    if is_fastembed {
        let model = std::env::var("EMBED_MODEL")
            .ok()
            .or(config.embedding_model.clone());
        let fast_emb = qql_edge::FastEmbedder::try_with_options(qql_edge::FastEmbedderOptions {
            model,
            ..Default::default()
        })?;
        return Ok(qql::executor::Executor::with_embedder(
            client,
            Some(config),
            Some(std::sync::Arc::new(fast_emb)),
        ));
    }
    #[cfg(not(feature = "fastembed"))]
    if is_fastembed {
        return Err(
            "fastembed support is not compiled into this binary (standard edition); install the full edition with: curl -fsSL https://qql.veristamp.in/install.sh | bash -s -- --full (or cargo install qql-cli --locked --features full)"
                .into(),
        );
    }

    let env_url = std::env::var("EMBED_URL").ok();
    let embedder = if let Some(endpoint) = env_url.as_ref().or(config.embedding_endpoint.as_ref()) {
        if !endpoint.trim().is_empty() {
            #[cfg(feature = "rest")]
            {
                let api_key = std::env::var("EMBED_KEY")
                    .ok()
                    .unwrap_or_else(|| config.embedding_api_key.clone().unwrap_or_default());
                let model = std::env::var("EMBED_MODEL").ok().unwrap_or_else(|| {
                    config
                        .embedding_model
                        .clone()
                        .unwrap_or_else(|| "all-minilm:l6-v2".to_string())
                });
                let dimension = std::env::var("EMBED_DIM")
                    .ok()
                    .and_then(|s| s.parse().ok())
                    .unwrap_or(if config.embedding_dimension > 0 {
                        config.embedding_dimension
                    } else {
                        384
                    });
                let multi_endpoint = std::env::var("MULTI_EMBED_URL")
                    .ok()
                    .or_else(|| config.multi_embedding_endpoint.clone());
                let multi_api_key = std::env::var("MULTI_EMBED_KEY")
                    .ok()
                    .or_else(|| config.multi_embedding_api_key.clone());
                let multi_model = std::env::var("MULTI_EMBED_MODEL")
                    .ok()
                    .or_else(|| config.multi_embedding_model.clone());
                let multi_dimension = std::env::var("MULTI_EMBED_DIM")
                    .ok()
                    .and_then(|s| s.parse().ok())
                    .unwrap_or(config.multi_embedding_dimension);
                let image_endpoint = std::env::var("IMAGE_EMBED_URL")
                    .ok()
                    .or_else(|| config.image_embedding_endpoint.clone());
                let image_api_key = std::env::var("IMAGE_EMBED_KEY")
                    .ok()
                    .or_else(|| config.image_embedding_api_key.clone());
                let image_model = std::env::var("IMAGE_EMBED_MODEL")
                    .ok()
                    .or_else(|| config.image_embedding_model.clone());
                let image_dimension = std::env::var("IMAGE_EMBED_DIM")
                    .ok()
                    .and_then(|s| s.parse().ok())
                    .unwrap_or(config.image_embedding_dimension);
                let rerank_endpoint = std::env::var("RERANK_URL")
                    .ok()
                    .or_else(|| config.rerank_endpoint.clone());
                let rerank_api_key = std::env::var("RERANK_KEY")
                    .ok()
                    .or_else(|| config.rerank_api_key.clone());
                let rerank_model = std::env::var("RERANK_MODEL")
                    .ok()
                    .or_else(|| config.rerank_model.clone());
                let http_emb = qql::embedder::HttpEmbedder::try_with_options(
                    qql::embedder::HttpEmbedderOptions {
                        endpoint: endpoint.clone(),
                        api_key,
                        model,
                        dimension,
                        multi_endpoint,
                        multi_api_key,
                        multi_model,
                        multi_dimension,
                        image_endpoint,
                        image_api_key,
                        image_model,
                        image_dimension,
                        rerank_endpoint,
                        rerank_api_key,
                        rerank_model,
                        bm25_k1: config.bm25_k1,
                        bm25_b: config.bm25_b,
                        bm25_avg_len: config.bm25_avg_len,
                        bm25_language: config.bm25_language.clone(),
                        bm25_tokenizer: config.bm25_tokenizer.clone(),
                        bm25_lowercase: config.bm25_lowercase,
                        bm25_ascii_folding: config.bm25_ascii_folding,
                        bm25_stopwords: config.bm25_stopwords.clone(),
                        bm25_stemmer: config.bm25_stemmer.clone(),
                        bm25_min_token_len: config.bm25_min_token_len,
                        bm25_max_token_len: config.bm25_max_token_len,
                        bm25_stopwords_languages: config.bm25_stopwords_languages.clone(),
                    },
                )?;
                Some(std::sync::Arc::new(http_emb) as std::sync::Arc<dyn qql::embedder::Embedder>)
            }
            #[cfg(not(feature = "rest"))]
            {
                let _ = endpoint;
                return Err(
                    "HTTP embedding requires the rest feature; rebuild with --features rest".into(),
                );
            }
        } else {
            None
        }
    } else {
        None
    };

    Ok(qql::executor::Executor::with_embedder(
        client,
        Some(config),
        embedder,
    ))
}

#[cfg(feature = "edge")]
pub(crate) fn edge_executor() -> Result<qql::executor::Executor, Box<dyn std::error::Error>> {
    let config = crate::config::EdgeConfig::load()?.apply_environment();
    let wal_segment_capacity = qql_edge::wal_segment_capacity_bytes(config.wal_segment_mb)?;
    match config.embedder.as_str() {
        "fastembed" => {
            #[cfg(feature = "fastembed")]
            {
                let is_tty = std::io::stdout().is_terminal();
                let show_progress = config.show_download_progress || is_tty;
                let model_name = config.model.as_deref().unwrap_or("BGESmallENV15");
                if show_progress {
                    eprintln!(
                        "ℹ Initializing local edge embedder (model: '{model_name}'). Model weights are downloaded on first run if not cached."
                    );
                }
                let options = qql_edge::LocalExecutorOptions {
                    on_disk_payload: config.on_disk_payload,
                    wal_segment_capacity,
                    model: config.model,
                    sparse_model: config.sparse_model,
                    multi_model: config.multi_model.or(config.multi_embed_model.clone()),
                    image_model: config.image_model.or(config.image_embed_model.clone()),
                    reranker_model: config.reranker_model.clone(),
                    cache_dir: config.cache_dir,
                    show_download_progress: show_progress,
                    bm25_k1: config.bm25_k1,
                    bm25_b: config.bm25_b,
                    bm25_avg_len: config.bm25_avg_len,
                    bm25_language: config.bm25_language,
                    bm25_tokenizer: config.bm25_tokenizer,
                    bm25_lowercase: config.bm25_lowercase,
                    bm25_ascii_folding: config.bm25_ascii_folding,
                    bm25_min_token_len: config.bm25_min_token_len,
                    bm25_max_token_len: config.bm25_max_token_len,
                    bm25_stopwords: config.bm25_stopwords,
                    bm25_stemmer: config.bm25_stemmer,
                    bm25_stopwords_languages: config.bm25_stopwords_languages,
                };
                qql_edge::local_executor_with_options(config.data_dir, options)
                    .map_err(|error| format!("edge initialization failed: {error}").into())
            }
            #[cfg(not(feature = "fastembed"))]
            {
                let _ = wal_segment_capacity;
                Err("the 'fastembed' embedder requires fastembed support; install the full edition with: curl -fsSL https://qql.veristamp.in/install.sh | bash -s -- --full (or cargo install qql-cli --locked --features full)".into())
            }
        }
        "http" => {
            let endpoint = config.embed_url.ok_or(
                "the edge HTTP embedder requires embed_url; run `qql config edge --embedder http --embed-url <URL>`",
            )?;
            qql_edge::http_executor_with_options_and_wal(
                config.data_dir,
                config.on_disk_payload,
                wal_segment_capacity,
                qql::embedder::HttpEmbedderOptions {
                    endpoint,
                    api_key: config.embed_key,
                    model: config.embed_model,
                    dimension: config.embed_dimension,
                    multi_endpoint: config.multi_embed_url,
                    multi_api_key: config.multi_embed_key,
                    multi_model: config.multi_embed_model,
                    multi_dimension: config.multi_embed_dimension,
                    image_endpoint: config.image_embed_url,
                    image_api_key: config.image_embed_key,
                    image_model: config.image_embed_model,
                    image_dimension: config.image_embed_dimension,
                    rerank_endpoint: None,
                    rerank_api_key: None,
                    rerank_model: config.reranker_model,
                    bm25_k1: config.bm25_k1,
                    bm25_b: config.bm25_b,
                    bm25_avg_len: config.bm25_avg_len,
                    bm25_language: config.bm25_language.clone(),
                    bm25_tokenizer: config.bm25_tokenizer.clone(),
                    bm25_lowercase: config.bm25_lowercase,
                    bm25_ascii_folding: config.bm25_ascii_folding,
                    bm25_stopwords: config.bm25_stopwords.clone(),
                    bm25_stemmer: config.bm25_stemmer.clone(),
                    bm25_min_token_len: config.bm25_min_token_len,
                    bm25_max_token_len: config.bm25_max_token_len,
                    bm25_stopwords_languages: config.bm25_stopwords_languages.clone(),
                },
            )
            .map_err(|error| format!("edge initialization failed: {error}").into())
        }
        other => Err(format!(
            "unknown configured edge embedder '{other}'; expected 'fastembed' or 'http'"
        )
        .into()),
    }
}

// ── Explain implementation ────────────────────────────────────

pub(crate) fn explain_query(query: &str) -> Result<String, String> {
    // Try multi-statement first — if the input has semicolons we get a
    // per-statement breakdown.  Falls back to single-statement for simple
    // queries (parse_all rejects them with a confusing semicolon error).
    match qql::executor::Executor::explain_all(query) {
        Ok(plan) if !plan.is_empty() => Ok(plan),
        Ok(_) | Err(_) => qql::executor::Executor::explain(query).map_err(|e| e.to_string()),
    }
}