You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: API.md
+49Lines changed: 49 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -262,3 +262,52 @@ FROM vector_quantize_scan('documents', 'embedding', vector_as_f32('[0.1, 0.2, 0.
262
262
```
263
263
264
264
---
265
+
266
+
## 🔁 Streaming Interfaces
267
+
268
+
### `vector_full_scan_stream` and `vector_quantize_scan_stream`
269
+
270
+
**Returns:**`Virtual Table (rowid, distance)`
271
+
272
+
**Description:**
273
+
These streaming interfaces provide the same functionality as `vector_full_scan` and `vector_quantize_scan`, respectively, but are designed for incremental or filtered processing of results.
274
+
Unlike their non-streaming counterparts, these functions **omit the fourth parameter (`k`)** and allow you to use standard SQL clauses such as `WHERE` and `LIMIT` to control filtering and result count.
275
+
276
+
This makes them ideal for combining vector search with additional query conditions or progressive result consumption in streaming applications.
277
+
278
+
**Parameters:**
279
+
280
+
*`table` (TEXT): Name of the target table.
281
+
*`column` (TEXT): Column containing vectors.
282
+
*`vector` (BLOB or JSON): The query vector.
283
+
284
+
**Key Differences from Non-Streaming Variants:**
285
+
286
+
| Function | Equivalent To | Requires `k`| Supports `WHERE`| Supports `LIMIT`|
0 commit comments