Scans visible vectors in a collection starting at an optional key. Each item includes the key, embedding, metadata, and commit metadata exposed by the executor output.

Paginated responses use opaque cursors. Clients should pass the returned cursor back to the same command shape and must not parse cursor contents.

Examples

Scan stored vectors from the start, in key order.

CLI

$ strata vector collection create docs 3 cosine
$ strata vector upsert docs a [1.0,0.0,0.0]
$ strata vector upsert docs b [0.0,1.0,0.0]
$ strata vector scan docs

Wire

{"collection":"docs","dimension":3,"metric":"cosine","type":"vector_create_collection"}
{"collection":"docs","key":"a","type":"vector_upsert","vector":[1.0,0.0,0.0]}
{"collection":"docs","key":"b","type":"vector_upsert","vector":[0.0,1.0,0.0]}
{"collection":"docs","type":"vector_scan"}

Parameters

Name	Type	Required	Description
collection	string	yes	Collection name.
limit	integer	no	Optional row limit.
start	string	no	Optional inclusive start key.

Plus the optional scope: branch and space (default to the session branch and the "default" space).

Returns

Page<VectorVersionedData, String>.

Errors

• failed_precondition.engine.runtime_closed
• not_found.engine.branch
• invalid_argument.engine.product_space
• invalid_argument.engine.vector_collection
• invalid_argument.engine.vector_key
• not_found.engine.vector_collection

Invocation

• CLI: strata vector scan
• Wire type: vector_scan