qql-plan 0.4.2

Typed QQL execution plans and Qdrant route lowering
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
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
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
//! Collection / shard-key / quota IR request types.
//!
//! Mirrors the OpenAPI request schemas QQL can emit. Config types serialize to
//! the exact wire JSON; request structs serialize plan IR and are projected to
//! endpoint bodies by `ddl_rest` (create) or used directly (update).

use alloc::collections::BTreeMap;
use alloc::string::String;
use alloc::vec::Vec;
use qql_core::ast::{MemoryPlacement, VectorDatatype, VectorDistance};
use serde::{Deserialize, Deserializer, Serialize, Serializer};

/// HNSW index configuration for collection creation/update.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct HnswConfig {
    /// Edges per node (`m`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub m: Option<u64>,
    /// Candidate list size while building (`ef_construct`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ef_construct: Option<u64>,
    /// Brute-force fallback below this point count (`full_scan_threshold`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub full_scan_threshold: Option<u64>,
    /// Indexing thread cap (`max_indexing_threads`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_indexing_threads: Option<u64>,
    /// Store the HNSW graph on disk (`on_disk`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_disk: Option<bool>,
    /// Edges per node for payload-aware indexes (`payload_m`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payload_m: Option<u64>,
    /// Keep the graph inline with vector storage (`inline_storage`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub inline_storage: Option<bool>,
    /// Memory placement of the HNSW graph.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// `max_optimization_threads` wire value: an explicit thread count or `"auto"`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MaxOptimizationThreads {
    /// Let the server pick dynamically (`"auto"`).
    Auto,
    /// Explicit number of optimization threads.
    Threads(u64),
}

impl Serialize for MaxOptimizationThreads {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        match self {
            Self::Auto => serializer.serialize_str("auto"),
            Self::Threads(threads) => serializer.serialize_u64(*threads),
        }
    }
}

impl<'de> Deserialize<'de> for MaxOptimizationThreads {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct Visitor;

        impl serde::de::Visitor<'_> for Visitor {
            type Value = MaxOptimizationThreads;

            fn expecting(&self, formatter: &mut alloc::fmt::Formatter) -> alloc::fmt::Result {
                formatter.write_str("a thread count or \"auto\"")
            }

            fn visit_u64<E: serde::de::Error>(self, value: u64) -> Result<Self::Value, E> {
                Ok(MaxOptimizationThreads::Threads(value))
            }

            fn visit_i64<E: serde::de::Error>(self, value: i64) -> Result<Self::Value, E> {
                u64::try_from(value)
                    .map(MaxOptimizationThreads::Threads)
                    .map_err(|_| E::invalid_value(serde::de::Unexpected::Signed(value), &self))
            }

            fn visit_str<E: serde::de::Error>(self, value: &str) -> Result<Self::Value, E> {
                if value.eq_ignore_ascii_case("auto") {
                    Ok(MaxOptimizationThreads::Auto)
                } else {
                    Err(E::invalid_value(serde::de::Unexpected::Str(value), &self))
                }
            }
        }

        deserializer.deserialize_any(Visitor)
    }
}

/// Segment optimizer configuration for collection creation/update.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct OptimizersConfig {
    /// Deleted-vector ratio that triggers segment merges (`deleted_threshold`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deleted_threshold: Option<f64>,
    /// Minimum segment size for vacuuming (`vacuum_min_vector_number`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vacuum_min_vector_number: Option<u64>,
    /// Target segment count (`default_segment_number`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub default_segment_number: Option<u64>,
    /// Maximum segment size in bytes (`max_segment_size`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_segment_size: Option<u64>,
    /// Point count above which segments are memmaped (`memmap_threshold`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memmap_threshold: Option<u64>,
    /// Minimum points before indexing kicks in (`indexing_threshold`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub indexing_threshold: Option<u64>,
    /// Background flush interval in seconds (`flush_interval_sec`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub flush_interval_sec: Option<u64>,
    /// Explicit thread count or `"auto"` (`max_optimization_threads`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_optimization_threads: Option<MaxOptimizationThreads>,
    /// Reject queries over unoptimized segments (`prevent_unoptimized`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prevent_unoptimized: Option<bool>,
}

/// Vector quantization config (scalar/product/binary/turbo).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum QuantizationConfig {
    /// Scalar (int8) quantization (`{"scalar": …}`).
    Scalar {
        /// Scalar quantization parameters.
        scalar: ScalarQuantization,
    },
    /// Product quantization (`{"product": …}`).
    Product {
        /// Product quantization parameters.
        product: ProductQuantization,
    },
    /// Binary quantization (`{"binary": …}`).
    Binary {
        /// Binary quantization parameters.
        binary: BinaryQuantization,
    },
    /// OpenAPI `TurboQuantization`: `{ "turbo": { "bits": "bits2", … } }`.
    Turbo {
        /// Turbo quantization parameters.
        turbo: TurboQuantization,
    },
}

/// `UPDATE COLLECTION` quantization replacement: a config or `"Disabled"`.
#[derive(Debug, Clone)]
pub enum QuantizationConfigDiff {
    /// Drop the collection's quantization config (`"Disabled"`).
    Disabled,
    /// Replacement quantization settings.
    Config(QuantizationConfig),
}

impl Serialize for QuantizationConfigDiff {
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        match self {
            Self::Disabled => serializer.serialize_str("Disabled"),
            Self::Config(config) => config.serialize(serializer),
        }
    }
}

/// OpenAPI scalar quantization config (type `int8`).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ScalarQuantization {
    /// Qdrant REST/OpenAPI expects `"int8"` for scalar quantization type.
    #[serde(rename = "type")]
    pub qtype: String,
    /// Calibration quantile, e.g. `0.99`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantile: Option<f64>,
    /// Keep quantized vectors in RAM.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub always_ram: Option<bool>,
    /// Memory placement of quantized vectors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// OpenAPI product quantization config.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ProductQuantization {
    /// Compression ratio: `x4`, `x8`, `x16`, `x32`, or `x64`.
    pub compression: String,
    /// Keep quantized vectors in RAM.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub always_ram: Option<bool>,
    /// Memory placement of quantized vectors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// OpenAPI binary quantization config.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BinaryQuantization {
    /// Keep quantized vectors in RAM.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub always_ram: Option<bool>,
    /// Bit packing: `one_bit`, `two_bits`, or `one_and_half_bits`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub encoding: Option<String>,
    /// Query-side encoding: `default`, `binary`, `scalar4bits`, `scalar8bits`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub query_encoding: Option<String>,
    /// Memory placement of quantized vectors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// OpenAPI `TurboQuantQuantizationConfig`.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct TurboQuantization {
    /// OpenAPI enum: `bits1` | `bits1_5` | `bits2` | `bits4`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bits: Option<String>,
    /// Keep quantized vectors in RAM.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub always_ram: Option<bool>,
    /// Memory placement of quantized vectors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// OpenAPI `WalConfigDiff` (collection creation only).
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct WalConfig {
    /// Size of a single WAL segment in MB (`wal_capacity_mb`).
    #[serde(rename = "wal_capacity_mb", skip_serializing_if = "Option::is_none")]
    pub capacity_mb: Option<u64>,
    /// WAL segments created ahead of use (`wal_segments_ahead`).
    #[serde(rename = "wal_segments_ahead", skip_serializing_if = "Option::is_none")]
    pub segments_ahead: Option<u64>,
    /// Closed WAL segments retained (`wal_retain_closed`).
    #[serde(rename = "wal_retain_closed", skip_serializing_if = "Option::is_none")]
    pub retain_closed: Option<u64>,
}

/// OpenAPI `StrictModeConfig` (collection creation and update).
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeConfig {
    /// Whether strict mode is enabled (`enabled`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Max `limit` for APIs without their own cap (`max_query_limit`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_query_limit: Option<u64>,
    /// Max `timeout` (`max_timeout`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_timeout: Option<u64>,
    /// Allow unindexed fields in retrieval filters (`unindexed_filtering_retrieve`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unindexed_filtering_retrieve: Option<bool>,
    /// Allow unindexed fields in update filters (`unindexed_filtering_update`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unindexed_filtering_update: Option<bool>,
    /// Max HNSW ef in search params (`search_max_hnsw_ef`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search_max_hnsw_ef: Option<u64>,
    /// Whether exact search is allowed (`search_allow_exact`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search_allow_exact: Option<bool>,
    /// Max oversampling in search (`search_max_oversampling`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search_max_oversampling: Option<f64>,
    /// Max upsert batch size (`upsert_max_batchsize`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub upsert_max_batchsize: Option<u64>,
    /// Max search batch size (`search_max_batchsize`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search_max_batchsize: Option<u64>,
    /// Max vector-storage bytes, ignoring replicas (`max_collection_vector_size_bytes`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_collection_vector_size_bytes: Option<u64>,
    /// Max reads per minute per replica (`read_rate_limit`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub read_rate_limit: Option<u64>,
    /// Max writes per minute per replica (`write_rate_limit`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub write_rate_limit: Option<u64>,
    /// Max payload-storage bytes (`max_collection_payload_size_bytes`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_collection_payload_size_bytes: Option<u64>,
    /// Max estimated point count (`max_points_count`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_points_count: Option<u64>,
    /// Max filter conditions (`filter_max_conditions`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filter_max_conditions: Option<u64>,
    /// Max condition size, e.g. `MatchAny` items (`condition_max_size`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub condition_max_size: Option<u64>,
    /// Per-multivector caps (`multivector_config`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub multivector_config: Option<StrictModeMultivectorConfig>,
    /// Per-sparse-vector caps (`sparse_config`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sparse_config: Option<StrictModeSparseConfig>,
    /// Max payload index count (`max_payload_index_count`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_payload_index_count: Option<u64>,
    /// Resident-memory percent cap (`max_resident_memory_percent`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_resident_memory_percent: Option<u64>,
}

/// OpenAPI `StrictModeMultivectorConfig`: per-multivector caps by vector name.
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeMultivectorConfig {
    /// Caps keyed by multivector name (`{max_vectors}` each).
    #[serde(flatten)]
    pub vectors: BTreeMap<String, StrictModeMultivector>,
}

/// One multivector's strict-mode caps.
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeMultivector {
    /// Max vectors in the multivector (`max_vectors`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_vectors: Option<u64>,
}

/// OpenAPI `StrictModeSparseConfig`: per-sparse-vector caps by vector name.
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeSparseConfig {
    /// Caps keyed by sparse vector name (`{max_length}` each).
    #[serde(flatten)]
    pub vectors: BTreeMap<String, StrictModeSparse>,
}

/// One sparse vector's strict-mode caps.
#[derive(Debug, Clone, Default, PartialEq, Serialize)]
pub struct StrictModeSparse {
    /// Max sparse vector length (`max_length`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_length: Option<u64>,
}

/// Multivector (late-interaction) comparator; OpenAPI `max_sim` only.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum MultiVectorComparator {
    /// Maximum pairwise vector similarity.
    MaxSim,
}

/// OpenAPI `MultiVectorConfig`.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
pub struct MultiVectorConfig {
    /// Scoring comparator.
    pub comparator: MultiVectorComparator,
}

/// OpenAPI `VectorParams` (one dense vector's storage configuration).
#[derive(Debug, Clone, Serialize)]
pub struct DenseVectorParams {
    /// Vector dimension.
    pub size: u64,
    /// Distance metric; serializes as `Cosine` / `Dot` / `Euclid` / `Manhattan`.
    pub distance: VectorDistance,
    /// Per-vector HNSW overrides.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hnsw_config: Option<HnswConfig>,
    /// Per-vector quantization settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantization_config: Option<QuantizationConfig>,
    /// Legacy on-disk flag (prefer `memory`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_disk: Option<bool>,
    /// Memory placement of the original vector storage.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
    /// Storage datatype.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub datatype: Option<VectorDatatype>,
    /// Multivector settings for late-interaction vectors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub multivector_config: Option<MultiVectorConfig>,
}

/// OpenAPI `VectorsConfig`: a single unnamed config or a named map.
///
/// QQL lowering always emits [`DenseVectorsConfig::Named`] (vector definitions
/// are always named); `Single` mirrors the wire's unnamed form for total
/// conversion.
#[derive(Debug, Clone, Serialize)]
#[serde(untagged)]
pub enum DenseVectorsConfig {
    /// Bare `VectorParams` object (single unnamed vector).
    Single(DenseVectorParams),
    /// `{ name: VectorParams }` map (named vectors).
    Named(BTreeMap<String, DenseVectorParams>),
}

/// Sparse index modifier (`none` | `idf`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum SparseModifier {
    /// No modification.
    None,
    /// Inverse document frequency.
    Idf,
}

/// OpenAPI `SparseIndexParams`: custom sparse index settings.
#[derive(Debug, Clone, Serialize)]
pub struct SparseIndexParams {
    /// Vector count below which full scans are used.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub full_scan_threshold: Option<u64>,
    /// Legacy on-disk flag (prefer `memory`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_disk: Option<bool>,
    /// Memory placement of the index.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
    /// Storage datatype (`float32` / `float16` / `uint8`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub datatype: Option<VectorDatatype>,
}

/// OpenAPI `SparseVectorParams` (one sparse vector's configuration).
#[derive(Debug, Clone, Serialize)]
pub struct SparseVectorParams {
    /// Custom index settings; `None` uses the collection defaults.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub index: Option<SparseIndexParams>,
    /// Value modifier applied at query time.
    pub modifier: SparseModifier,
}

/// OpenAPI `VectorParamsDiff` (per-vector dense patch on `UpdateCollection`).
///
/// Field-wise: every unset key leaves the collection's current setting as-is.
/// The wire shape has no `datatype` field — a datatype change fails planning.
#[derive(Debug, Clone, Default, Serialize)]
pub struct VectorParamsDiff {
    /// Replacement HNSW settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hnsw_config: Option<HnswConfig>,
    /// Replacement quantization settings (`"Disabled"` clears them).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantization_config: Option<QuantizationConfigDiff>,
    /// Legacy on-disk flag (prefer `memory`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_disk: Option<bool>,
    /// Memory placement of the original vector storage.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// OpenAPI `SparseVectorParams` as a patch: `modifier` and every index key are
/// optional, so unset fields keep their current value.
#[derive(Debug, Clone, Default, Serialize)]
pub struct SparseVectorParamsDiff {
    /// Replacement sparse index settings (field-wise).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub index: Option<SparseIndexParams>,
    /// Replacement value modifier.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub modifier: Option<SparseModifier>,
}

/// OpenAPI `PayloadStorageParams`.
#[derive(Debug, Clone, Default, Serialize)]
pub struct PayloadStorageParams {
    /// Memory placement of the payload storage (`cold`/`cached`; never `pinned`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub memory: Option<MemoryPlacement>,
}

/// OpenAPI `CollectionParams` / `CollectionParamsDiff` fields QQL can set.
///
/// `CreateCollection` hoists replication/consistency/payload to the top level;
/// `UpdateCollection` nests the whole struct under `params`.
#[derive(Debug, Clone, Default, Serialize)]
pub struct CollectionParams {
    /// Number of replicas per shard.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub replication_factor: Option<u64>,
    /// Minimum replicas that must acknowledge a write.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub write_consistency_factor: Option<u64>,
    /// Number of replicas queried in parallel for reads.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub read_fan_out_factor: Option<u64>,
    /// Delay between read fan-out attempts, in milliseconds.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub read_fan_out_delay_ms: Option<u64>,
    /// Legacy flag storing payload on disk (prefer `payload.memory`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub on_disk_payload: Option<bool>,
    /// Payload storage placement.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub payload: Option<PayloadStorageParams>,
}

/// Sharding method (`auto` | `custom`).
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum ShardingMethod {
    /// Points are distributed across all available shards.
    Auto,
    /// Points are distributed according to their shard key.
    Custom,
}

/// Plan IR for `CREATE COLLECTION`; projected to the OpenAPI body at the edge.
#[derive(Debug, Clone, Default, Serialize)]
pub struct CreateCollectionRequest {
    /// Dense vector configs (single unnamed or named map).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vectors: Option<DenseVectorsConfig>,
    /// Named sparse vector configs (`modifier`, optional `index` settings).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sparse_vectors: Option<BTreeMap<String, SparseVectorParams>>,
    /// Collection-wide HNSW settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hnsw_config: Option<HnswConfig>,
    /// Collection-wide optimizer settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub optimizers_config: Option<OptimizersConfig>,
    /// Collection params (`replication_factor`, `read_fan_out_*`, payload).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<CollectionParams>,
    /// Vector quantization settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantization_config: Option<QuantizationConfig>,
    /// Write-ahead log settings (`WITH WAL`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wal_config: Option<Box<WalConfig>>,
    /// Strict-mode settings (`WITH STRICT_MODE`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub strict_mode_config: Option<Box<StrictModeConfig>>,
    /// Free-form collection metadata (`WITH METADATA`): pairs serialize as
    /// the JSON object at the transport boundary.
    #[serde(
        skip_serializing_if = "Option::is_none",
        serialize_with = "crate::value_serde::serialize_ast_pairs_opt"
    )]
    pub metadata: Option<Vec<(String, qql_core::ast::Value)>>,
    /// Number of shards (`shard_number`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shard_number: Option<u64>,
    /// `auto` or `custom` sharding method.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sharding_method: Option<ShardingMethod>,
    /// Custom shard keys created via `/shards` after collection create.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shard_keys: Option<Vec<crate::semantic::PlanShardKey>>,
}

/// Plan IR for `ALTER COLLECTION`; serializes as the OpenAPI PATCH body.
#[derive(Debug, Clone, Default, Serialize)]
pub struct UpdateCollectionRequest {
    /// Updated optimizer settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub optimizers_config: Option<OptimizersConfig>,
    /// Updated collection params.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<CollectionParams>,
    /// Updated HNSW settings.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub hnsw_config: Option<HnswConfig>,
    /// Quantization replacement (`Disabled` or a config).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub quantization_config: Option<QuantizationConfigDiff>,
    /// Strict-mode replacement (`WITH STRICT_MODE`).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub strict_mode_config: Option<Box<StrictModeConfig>>,
    /// Metadata merge (`WITH METADATA`): pairs serialize as the JSON object
    /// at the transport boundary.
    #[serde(
        skip_serializing_if = "Option::is_none",
        serialize_with = "crate::value_serde::serialize_ast_pairs_opt"
    )]
    pub metadata: Option<Vec<(String, qql_core::ast::Value)>>,
    /// Per-vector dense diffs: REST `VectorsConfigDiff` is this name-keyed map
    /// (`""` addresses the default unnamed vector).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vectors: Option<BTreeMap<String, VectorParamsDiff>>,
    /// Per-sparse-vector diffs (`sparse_vectors` on the PATCH body).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sparse_vectors: Option<BTreeMap<String, SparseVectorParamsDiff>>,
}

/// Plan IR for creating a custom shard key on a collection.
#[derive(Debug, Clone, Serialize)]
pub struct CreateShardKeyRequest {
    /// Custom shard key to create (keyword or numeric).
    pub shard_key: crate::semantic::PlanShardKey,
    /// Number of shards backing the key.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub shards_number: Option<u64>,
    /// Replication factor for the key.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub replication_factor: Option<u64>,
    /// Peer ids placing the key's shards.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub placement: Option<Vec<u64>>,
    /// Initial replica state.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub initial_state: Option<String>,
}

/// Plan IR for dropping a custom shard key from a collection.
#[derive(Debug, Clone, Serialize)]
pub struct DropShardKeyRequest {
    /// Custom shard key to remove.
    pub shard_key: crate::semantic::PlanShardKey,
}

/// Cluster-wide resource quota configuration (`GET`/`PUT /quotas`).
///
/// An unset field means the corresponding resource is uncapped. Used both as
/// the `PUT /quotas` request body and as the typed `GET /quotas` result
/// (`QuotaStatus.config`).
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct QuotaConfig {
    /// Whether quota enforcement is active.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Resident-memory cap as a percent of total (1-100).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_resident_memory_percent: Option<u64>,
    /// Disk-usage cap as a percent of total (1-100).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub max_disk_usage_percent: Option<u64>,
    /// Margin reclaimed when a cap trips, as a percent (0-100).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub release_margin_percent: Option<u64>,
}

/// Plan IR for `SET QUOTA`: the replacement [`QuotaConfig`] plus the REST-only
/// `?wait=` query flag.
#[derive(Debug, Clone, Default, Serialize)]
pub struct SetQuotaRequest {
    /// Replacement configuration; omitted keys become uncapped defaults.
    #[serde(flatten)]
    pub config: QuotaConfig,
    /// REST query param (`?wait=`), not body.
    #[serde(skip)]
    pub wait: Option<bool>,
}