— API reference
API
reference
The classes and functions in vectrojs, vectrojs/browser, vectrojs/portable and vectrojs/serve. New here? Start with the quick start.
Core
Engine
The engine owns the WebAssembly memory and the worker threads; every table, dataset and query belongs to one.
nodebrowseredge
02Core
Table
A table of columns in engine memory, with filters, derived columns, aggregations, group-bys, joins and sorts that run on every thread.
nodebrowseredge
03Core
Query (lazy)
A recorded chain of steps over a table or dataset, optimized as a whole and run only when you ask for a result.
nodebrowseredge
04Core
sql()
Compiles one SQL SELECT over your tables and datasets into a lazy query.
nodebrowseredge
05Files and data
Dataset and DatasetWriter
A Dataset is a table in a .vectro file, read a chunk at a time; a DatasetWriter writes one.
nodebrowseredge
06Files and data
Arrow: readArrow, writeArrow
Reading and writing Apache Arrow IPC, the stream and file formats pandas, Polars, DuckDB and pyarrow use, with no dependencies.
nodebrowseredge
07Files and data
Files: blobFile, urlFile, memoryFile
File objects that datasets read from and write to where there are no Node paths, a Blob, a URL, memory or browser storage.
nodebrowseredge
08Workers and streams
SplitEngine and SplitTable
Multi-core work without shared memory, where each worker owns a slice of every table and the calling thread combines their partial answers.
nodebrowser
09Workers and streams
StreamTable
A live split table fed by CSV lines, JSON lines, Vectro frames or Arrow, with running totals over time windows.
nodebrowser
10Workers and streams
Emitter and frames
The sending side of binary streams, and the Vectro frame format it speaks.
nodebrowseredge
11More
VectorIndex
Exact nearest-neighbour search over embeddings, on every core, with filters on any other column.
nodebrowseredge
12More
DistinctSketch
A 4 KB HyperLogLog sketch that estimates distinct counts within about 1.6% and merges with other sketches.
nodebrowseredge
13More
serve, servePg, serveFlight
Servers that answer SQL over your tables through HTTP and OData, the PostgreSQL protocol and Arrow Flight SQL.
node
14More
The vectro CLI
The vectro serve command serves a folder of data files over HTTP, PostgreSQL and Flight SQL; vectro-mcp serves it to AI assistants.
node
15More
MCP tools
The tools the vectro-mcp server offers an AI assistant, with their arguments and results.
node