qdrant-datafusion 0.1.1

Qdrant integration for Apache DataFusion
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
#![allow(unused_crate_dependencies)]

mod common;

const TRACING_DIRECTIVES: &[(&str, &str)] = &[
    ("testcontainers", "debug"),
    ("hyper", "error"),
    ("tonic", "error"),
    // --
];

#[cfg(feature = "test-utils")]
e2e_test!(table_provider_named, tests::test_table_provider_named, TRACING_DIRECTIVES, None);

#[cfg(feature = "test-utils")]
e2e_test!(table_provider_unnamed, tests::test_table_provider_unnamed, TRACING_DIRECTIVES, None);

#[cfg(feature = "test-utils")]
e2e_test!(table_provider, tests::test_table_provider, TRACING_DIRECTIVES, None);

#[cfg(feature = "test-utils")]
mod tests {
    use std::sync::Arc;

    use datafusion::arrow;
    use datafusion::datasource::TableProvider;
    use datafusion::physical_plan::{DisplayAs, DisplayFormatType};
    use datafusion::prelude::*;
    use qdrant_client::Qdrant;
    use qdrant_client::qdrant::{
        CreateCollectionBuilder, Distance, MultiVectorComparator, MultiVectorConfig, NamedVectors,
        PointStruct, SparseVectorParamsBuilder, SparseVectorsConfigBuilder, UpsertPointsBuilder,
        Vector, VectorParamsBuilder, VectorsConfigBuilder,
    };
    use qdrant_datafusion::error::Result;
    use qdrant_datafusion::table::{QdrantScanExec, QdrantTableProvider};
    use qdrant_datafusion::test_utils::QdrantContainer;
    use tracing::debug;

    fn create_qdrant_client(c: &Arc<QdrantContainer>) -> Result<Qdrant> {
        let api_key = c.get_api_key();
        let url = c.get_url();
        eprintln!(">> Connecting to Qdrant @ {url}");
        Qdrant::from_url(&url).api_key(api_key).build().map_err(Into::into)
    }

    /// Simple test coverage for `TableProvider` and `ScanExec`
    pub(super) async fn test_table_provider(c: Arc<QdrantContainer>) -> Result<()> {
        struct QdrantScanExecDebug(QdrantScanExec);
        impl std::fmt::Display for QdrantScanExecDebug {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                self.0.fmt_as(DisplayFormatType::Default, f)?;
                self.0.fmt_as(DisplayFormatType::TreeRender, f)
            }
        }

        eprintln!("> Testing TableProvider coverage methods");
        let client = create_qdrant_client(&c)?;

        let collection_name = "test_coverage";

        // Create simple collection
        let _ = client
            .create_collection(
                CreateCollectionBuilder::new(collection_name)
                    .vectors_config(VectorParamsBuilder::new(2, Distance::Cosine)),
            )
            .await?;

        // Insert one simple point
        let mut payload = qdrant_client::Payload::new();
        payload.insert("title", "Test Point");

        let points = vec![PointStruct::new(1, Vector::new_dense(vec![0.1, 0.2]), payload)];

        drop(client.upsert_points(UpsertPointsBuilder::new(collection_name, points)).await?);

        // Create TableProvider
        let table_provider = QdrantTableProvider::try_new(client.clone(), collection_name).await?;

        // Test Debug implementation
        eprintln!("QdrantTableProvider debug: {table_provider:?}");

        // Test as_any method by checking downcast
        let any_ref = table_provider.as_any();
        let is_correct_type = any_ref.downcast_ref::<QdrantTableProvider>().is_some();
        eprintln!("QdrantTableProvider as_any downcast success: {is_correct_type}");
        assert!(is_correct_type);

        // Test table_type method
        let table_type = table_provider.table_type();
        eprintln!("QdrantTableProvider table_type: {table_type:?}");
        assert_eq!(table_type, datafusion::datasource::TableType::Base);

        let ctx = SessionContext::new();
        let scan = table_provider.scan(&ctx.state(), None, &[], None).await.unwrap();
        let qdrant_scan = scan.as_any().downcast_ref::<QdrantScanExec>().unwrap();
        eprintln!("QdrantScanExec debug: {qdrant_scan:?}");
        let scan_display = QdrantScanExecDebug(qdrant_scan.clone());
        eprintln!("Physical plan debug: {scan_display}");

        eprintln!(">> ✅ TableProvider coverage test completed!");
        eprintln!("   - QdrantTableProvider Debug, as_any, table_type: ✅");
        eprintln!("   - QdrantScanExec Debug and DisplayAs: ✅");

        Ok(())
    }

    /// Test heterogeneous vector sets - different points have different vector fields
    #[expect(clippy::too_many_lines)]
    pub(super) async fn test_table_provider_named(c: Arc<QdrantContainer>) -> Result<()> {
        eprintln!(
            "> Testing HETEROGENEOUS vector fields - different points have different vectors"
        );
        let client = create_qdrant_client(&c)?;

        let collection_name = "test_heterogeneous";

        // Create collection using PROPER BUILDERS as per Qdrant docs
        // Dense vectors: can be named or unnamed, regular or multi
        // Sparse vectors: MUST be named

        // Use VectorsConfigBuilder for named dense vectors
        let mut vectors_config = VectorsConfigBuilder::default();
        let _ = vectors_config.add_named_vector_params(
            "test_embedding",
            VectorParamsBuilder::new(2, Distance::Cosine).build(),
        );
        let _ = vectors_config.add_named_vector_params(
            "text_embedding",
            VectorParamsBuilder::new(3, Distance::Cosine).build(),
        );
        let _ = vectors_config.add_named_vector_params(
            "image_embedding",
            VectorParamsBuilder::new(4, Distance::Dot).build(),
        );
        let _ = vectors_config.add_named_vector_params(
            "audio_embedding",
            VectorParamsBuilder::new(2, Distance::Euclid).build(),
        );
        let _ = vectors_config.add_named_vector_params(
            "multi_embeddings",
            VectorParamsBuilder::new(2, Distance::Dot)
                .multivector_config(MultiVectorConfig {
                    comparator: MultiVectorComparator::MaxSim.into(),
                })
                .build(),
        );

        // Add sparse vectors (MUST be named per docs)
        let mut sparse_config = SparseVectorsConfigBuilder::default();
        let _ =
            sparse_config.add_named_vector_params("keywords", SparseVectorParamsBuilder::default());

        let _ = client
            .create_collection(
                CreateCollectionBuilder::new(collection_name)
                    .vectors_config(vectors_config)
                    .sparse_vectors_config(sparse_config),
            )
            .await?;

        // Point 1: ONLY has test_embedding + keywords sparse
        let mut payload1 = qdrant_client::Payload::new();
        payload1.insert("title", "Point 1");

        let mut named_vectors1 = NamedVectors::default();
        named_vectors1 =
            named_vectors1.add_vector("test_embedding", Vector::new_dense(vec![0.1, 0.2]));
        named_vectors1 =
            named_vectors1.add_vector("keywords", Vector::new_sparse(vec![0, 5], vec![0.1, 0.9]));
        named_vectors1 = named_vectors1.add_vector(
            "multi_embeddings",
            Vector::new_multi(vec![vec![0.7, 0.8], vec![0.9, 0.1]]),
        );
        // Deliberately NO audio_embedding or text_embedding or image_embedding!

        // Point 2: Has text_embedding + image_embedding + keywords
        let mut payload2 = qdrant_client::Payload::new();
        payload2.insert("title", "Point 2");

        let mut named_vectors2 = NamedVectors::default();
        named_vectors2 =
            named_vectors2.add_vector("text_embedding", Vector::new_dense(vec![0.3, 0.4, 0.5]));
        named_vectors2 = named_vectors2
            .add_vector("image_embedding", Vector::new_dense(vec![0.6, 0.7, 0.8, 0.9]));
        named_vectors2 =
            named_vectors2.add_vector("keywords", Vector::new_sparse(vec![1, 3], vec![0.7, 0.4]));
        // Deliberately NO test_embedding or audio_embedding!

        // Point 3: Has text_embedding + audio_embedding + keywords
        let mut payload3 = qdrant_client::Payload::new();
        payload3.insert("title", "Point 3");

        let mut named_vectors3 = NamedVectors::default();
        named_vectors3 =
            named_vectors3.add_vector("text_embedding", Vector::new_dense(vec![0.11, 0.12, 0.13]));
        named_vectors3 =
            named_vectors3.add_vector("audio_embedding", Vector::new_dense(vec![0.14, 0.15]));
        named_vectors3 = named_vectors3
            .add_vector("keywords", Vector::new_sparse(vec![2, 4, 6], vec![0.2, 0.6, 0.8]));
        // Deliberately NO test_embedding or image_embedding!

        let points = vec![
            PointStruct::new(1, named_vectors1, payload1),
            PointStruct::new(2, named_vectors2, payload2),
            PointStruct::new(3, named_vectors3, payload3),
        ];

        drop(client.upsert_points(UpsertPointsBuilder::new(collection_name, points)).await?);

        // Create TableProvider and test
        debug!(">> Creating QdrantTableProvider for heterogeneous vectors");
        let table_provider = QdrantTableProvider::try_new(client.clone(), collection_name).await?;

        let ctx = SessionContext::new();
        drop(ctx.register_table("hetero_table", Arc::new(table_provider))?);

        // Test: SELECT * - Should show all fields, with nulls where vectors missing
        eprintln!(">> Test: SELECT * FROM hetero_table (heterogeneous vectors)");
        let df = ctx.sql("SELECT * FROM hetero_table").await?;
        let results = df.collect().await?;

        eprintln!(">>> Heterogeneous vectors query results:");
        for (i, batch) in results.iter().enumerate() {
            let schema = batch.schema();
            eprintln!("    Batch {i}: {} rows, {} columns", batch.num_rows(), batch.num_columns());
            debug!("      Schema: {schema:?}");

            // Should have all vector fields defined in collection config
            assert_eq!(batch.num_rows(), 3);

            let field_names: Vec<&str> =
                schema.fields().iter().map(|f| f.name().as_str()).collect();
            eprintln!("    Field names: {field_names:?}");

            // All vector fields should be present in schema
            assert!(field_names.contains(&"test_embedding"));
            assert!(field_names.contains(&"text_embedding"));
            assert!(field_names.contains(&"image_embedding"));
            assert!(field_names.contains(&"audio_embedding"));
            assert!(field_names.contains(&"multi_embeddings"));
            assert!(field_names.contains(&"keywords_indices"));
            assert!(field_names.contains(&"keywords_values"));
            assert!(field_names.contains(&"id"));
            assert!(field_names.contains(&"payload"));

            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 2: Projection - Only dense vector
        eprintln!(">> Test 2: SELECT text_embedding FROM hetero_table (dense only)");
        let df = ctx.sql("SELECT text_embedding FROM hetero_table").await?;
        let results = df.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 1);
            assert_eq!(batch.schema().field(0).name(), "text_embedding");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 3: Projection - Only sparse vectors
        eprintln!(">> Test 3: SELECT keywords_indices, keywords_values FROM hetero_table");
        let df = ctx.sql("SELECT keywords_indices, keywords_values FROM hetero_table").await?;
        let results = df.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 2);
            assert_eq!(batch.schema().field(0).name(), "keywords_indices");
            assert_eq!(batch.schema().field(1).name(), "keywords_values");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 4: Projection - Mix of different dense vectors
        eprintln!(">> Test 4: SELECT test_embedding, image_embedding FROM hetero_table");
        let df = ctx.sql("SELECT test_embedding, image_embedding FROM hetero_table").await?;
        let results = df.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 2);
            assert_eq!(batch.schema().field(0).name(), "test_embedding");
            assert_eq!(batch.schema().field(1).name(), "image_embedding");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 5: Projection - Dense + sparse mixed
        eprintln!(">> Test 5: SELECT text_embedding, keywords_indices FROM hetero_table");
        let df = ctx.sql("SELECT text_embedding, keywords_indices FROM hetero_table").await?;
        let results = df.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 2);
            assert_eq!(batch.schema().field(0).name(), "text_embedding");
            assert_eq!(batch.schema().field(1).name(), "keywords_indices");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 6: Projection - No vectors, only metadata
        eprintln!(">> Test 6: SELECT id, payload FROM hetero_table (no vectors)");
        let df = ctx.sql("SELECT id, payload FROM hetero_table").await?;
        let results = df.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 2);
            assert_eq!(batch.schema().field(0).name(), "id");
            assert_eq!(batch.schema().field(1).name(), "payload");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 7: Projection - Single field that many points don't have
        eprintln!(">> Test 7: SELECT audio_embedding FROM hetero_table (mostly nulls)");
        let df = ctx.sql("SELECT audio_embedding FROM hetero_table").await?;
        let results = df.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 1);
            assert_eq!(batch.schema().field(0).name(), "audio_embedding");
            // Should show mostly nulls except point 3
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        eprintln!(">> ✅ Named vectors TableProvider test completed!");
        eprintln!("   - Point 1: only test_embedding + multi_embeddings + keywords");
        eprintln!("   - Point 2: only text_embedding + image_embedding + keywords");
        eprintln!("   - Point 3: only text_embedding + audio_embedding + keywords");
        eprintln!("   - Schema contains ALL vector fields with proper nulls");
        eprintln!("   - Multi-vectors: List<List<Float32>> schema and extraction: ✅");
        eprintln!("   - Projection works for all vector field combinations: ✅");
        eprintln!("   - Heterogeneous data with nulls handled correctly: ✅");

        Ok(())
    }

    /// Test true unnamed vectors
    pub(super) async fn test_table_provider_unnamed(c: Arc<QdrantContainer>) -> Result<()> {
        eprintln!("> Testing UNNAMED vectors - single vector field");
        let client = create_qdrant_client(&c)?;

        let collection_name = "test_unnamed_only";

        // Create collection with SINGLE UNNAMED VECTOR using Config::Params
        // This creates the "vector" field in our schema
        let _ = client
            .create_collection(
                CreateCollectionBuilder::new(collection_name)
                    .vectors_config(VectorParamsBuilder::new(3, Distance::Cosine)),
            )
            .await?;

        // Insert points with UNNAMED vectors
        let mut payload1 = qdrant_client::Payload::new();
        payload1.insert("title", "Unnamed Point 1");

        let mut payload2 = qdrant_client::Payload::new();
        payload2.insert("title", "Unnamed Point 2");

        let mut payload3 = qdrant_client::Payload::new();
        payload3.insert("title", "Unnamed Point 3");

        let points = vec![
            // Use Vector::new_dense for unnamed vectors
            PointStruct::new(1, Vector::new_dense(vec![0.1, 0.2, 0.3]), payload1),
            PointStruct::new(2, Vector::new_dense(vec![0.4, 0.5, 0.6]), payload2),
            PointStruct::new(3, Vector::new_dense(vec![0.7, 0.8, 0.9]), payload3),
        ];

        drop(client.upsert_points(UpsertPointsBuilder::new(collection_name, points)).await?);

        // Create TableProvider and test
        debug!(">> Creating QdrantTableProvider for unnamed vectors");
        let table_provider = QdrantTableProvider::try_new(client.clone(), collection_name).await?;

        let ctx = SessionContext::new();
        drop(ctx.register_table("unnamed_table", Arc::new(table_provider))?);

        // Test: SELECT * - Should show "vector" field
        eprintln!(">> Test: SELECT * FROM unnamed_table (unnamed vectors)");
        let results = ctx.sql("SELECT * FROM unnamed_table").await?.collect().await?;

        eprintln!(">>> Unnamed vectors query results:");
        for (i, batch) in results.iter().enumerate() {
            let schema = batch.schema();
            eprintln!("    Batch {i}: {} rows, {} columns", batch.num_rows(), batch.num_columns());

            // Should have: id, payload, vector
            assert_eq!(batch.num_rows(), 3);
            assert_eq!(batch.num_columns(), 3);

            let field_names: Vec<&str> =
                schema.fields().iter().map(|f| f.name().as_str()).collect();
            eprintln!("    Field names: {field_names:?}");

            // Should contain the unnamed "vector" field
            assert!(field_names.contains(&"vector"));
            assert!(field_names.contains(&"id"));
            assert!(field_names.contains(&"payload"));

            // Should NOT contain any named vector fields
            assert!(!field_names.contains(&"text_embedding"));
            assert!(!field_names.contains(&"image_embedding"));

            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 2: Projection - Only vector field
        eprintln!(">> Test 2: SELECT vector FROM unnamed_table");
        let results = ctx.sql("SELECT vector FROM unnamed_table").await?.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 1);
            assert_eq!(batch.schema().field(0).name(), "vector");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 3: Projection - Only metadata fields
        eprintln!(">> Test 3: SELECT id, payload FROM unnamed_table (no vectors)");
        let results = ctx.sql("SELECT id, payload FROM unnamed_table").await?.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 2);
            assert_eq!(batch.schema().field(0).name(), "id");
            assert_eq!(batch.schema().field(1).name(), "payload");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 4: Projection - Only ID field
        eprintln!(">> Test 4: SELECT id FROM unnamed_table");
        let results = ctx.sql("SELECT id FROM unnamed_table").await?.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 1);
            assert_eq!(batch.schema().field(0).name(), "id");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 5: Projection - Mixed order
        eprintln!(">> Test 5: SELECT payload, vector, id FROM unnamed_table (reordered)");
        let sql = "SELECT payload, vector, id FROM unnamed_table";
        let results = ctx.sql(sql).await?.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 3);
            assert_eq!(batch.schema().field(0).name(), "payload");
            assert_eq!(batch.schema().field(1).name(), "vector");
            assert_eq!(batch.schema().field(2).name(), "id");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 6: Projection - Only payload
        eprintln!(">> Test 6: SELECT payload FROM unnamed_table");
        let results = ctx.sql("SELECT payload FROM unnamed_table").await?.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_columns(), 1);
            assert_eq!(batch.schema().field(0).name(), "payload");
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        // Test 7: LIMIT query to cover TableScan limit functionality
        eprintln!(">> Test 7: SELECT * FROM unnamed_table LIMIT 2");
        let results = ctx.sql("SELECT * FROM unnamed_table LIMIT 2").await?.collect().await?;

        for batch in &results {
            assert_eq!(batch.num_rows(), 2); // Should be limited to 2 rows
            assert_eq!(batch.num_columns(), 3);
            arrow::util::pretty::print_batches(std::slice::from_ref(batch)).unwrap();
        }

        eprintln!(">> ✅ Unnamed vectors TableProvider test completed!");
        eprintln!("   - Collection uses Config::Params (not ParamsMap)");
        eprintln!("   - Schema contains 'vector' field (not named fields)");
        eprintln!("   - All points have the same unnamed vector structure");
        eprintln!("   - Vector field accessible via 'vector' name in SQL");
        eprintln!("   - Projection works for all field combinations: ✅");
        eprintln!("   - Schema projection optimizes Qdrant queries: ✅");
        eprintln!("   - LIMIT queries work correctly: ✅");

        Ok(())
    }
}