Skip to content

Feature Index

Feature and tutorial coverage map. Every available feature has an entry here with what it does and a link to a hands-on tutorial or reference page. Features that need an opt-in build name the Cargo feature that turns them on.

For the release history, see the changelog.


SQL / DML / Query Execution

FeatureWhat it doesDocs
Full SQL CoreJOINs, CTEs, subqueries, set ops, aggregates, CASESQL_REFERENCE
Aggregate expressionsSUM(a)+SUM(b), CAST(AVG()), CASE on COUNTSQL_FEATURES
Window functionsFull SQL:2003 frame specWINDOW_FUNCTIONS_QUICKREF
Common table expressionsWITH RECURSIVE depth controlSQL_FEATURES
SubqueriesScalar, derived, IN/EXISTSSQL_FEATURES
String concatenation ||NULL propagation, auto-castChangelog
EXTRACT / date functionsEPOCH, YEAR, MONTH, etc.Release notes
INSERT … SELECTFK/trigger/RLS-aware bulk insertSQL_FEATURES
ON CONFLICT (Upsert)DO UPDATE SET … EXCLUDED + MySQL ON DUPLICATE KEYUPSERT_QUICKREF
Parameterized LIMIT/OFFSETLIMIT $1 OFFSET $2 with type coercionRelease notes
Keyset paginationConstant-time deep pagination (~30 µs)KEYSET_PAGINATION_QUICKREF, Release notes
Top-K sort optimizationLIMIT-driven early termination, O(N log k)Release notes
Generate_series / unnestTable-valued functionsChangelog
EXPLAIN / cost plannerJSON/XML/YAML output, ANALYZEEXPLAIN_AND_OPTIMIZATION
Implicit comma-joinsFROM t1, t2 WHERE … (WordPress compat)Changelog
Recursive CTEsDepth-limited graph traversal in SQLSQL_FEATURES
gen_random_uuid / uuid_generate_v4UUID generationRelease notes

DDL / Schema

FeatureWhat it doesDocs
CREATE TABLEAll constraints + DEFAULT expressions + CHECKSQL_REFERENCE
PRIMARY KEY (inline + table)Both syntaxesprimary-keys
Foreign keysCASCADE, SET NULL, RESTRICTforeign-keys
UNIQUE constraintsPer-column + multi-column; ON CONFLICT detectionSQL_FEATURES
CHECK constraintsExpression-based row validationSQL_FEATURES
GENERATED ALWAYS AS IDENTITYSQL:2016 identity columnsRelease notes
SERIAL / BIGSERIAL / AUTO_INCREMENTPG + MySQL aliasSQL_REFERENCE
DEFAULT expressionsDEFAULT now(), DEFAULT CURRENT_USERChangelog
ALTER TABLEMultiple ops in single stmtSQL_REFERENCE
CREATE INDEXB-tree, ART, HNSW, GINvector-search, STORAGE_FILTERING
CREATE SEQUENCE / nextvalProcess-scoped sequence storeRelease notes
CREATE EXTENSION hdb_codeCode-graph bootstrap (opt-in)CODE_GRAPH_TUTORIAL
CREATE SEMANTIC HASH INDEXMerkle-tree subtree invalidationSEMANTIC_HASH_INDEX_QUICKREF
TRUNCATEFast clear with ART purgeSQL_FEATURES
Per-column storage modesDictionary / Content-Addressed / Columnarper-column-storage
FeatureWhat it doesDocs
Adaptive Radix Tree (ART)Zero-copy PK lookups, O(k)PRODUCT_QUANTIZATION_IMPLEMENTATION
HNSW vector searchNative k-NN, about 16x (internal tests, Nano 3.32.1 vs unquantized HNSW, see benchmarks) PQVECTOR_SEARCH_TUTORIAL
BM25 full-text searchtsvector / tsquery / @@ / ts_rank_cdFULL_TEXT_SEARCH
Hybrid searchBM25 + vector via RRF/MMRFULL_TEXT_SEARCH
GIN indexes (FTS)ORM/migration compat (no-op currently)Release notes
SIMD predicate pushdownStorage-level filtering via bloom/zone-map/SIMDSTORAGE_FILTERING
Centrality-biased HNSWPost-rerank with centrality weightingRelease notes
UUID literal coercionPK lookup with UUID columnsRelease notes

Transactions / Concurrency / MVCC

FeatureWhat it doesDocs
ACID transactionsSnapshot isolation, all-or-nothingSQL_REFERENCE
Explicit transactionsBEGIN / COMMIT / ROLLBACKSQL_REFERENCE
SavepointsNested rollback boundariesSQL_FEATURES
MVCCSnapshot iso, read-your-writes../architecture/multi_user_transactions.md
Optimistic conflict detectionVector clocks, field-level merge (opt-in sync-experimental build)Changelog

Time-Travel / Branching

FeatureWhat it doesDocs
Git-like branchesCOW isolation for dev/test/A-BBRANCHING_TIME_TRAVEL_TUTORIAL, branching
Selective branch syncReplicate specific branches to remotesRelease notes
AS OF TIMESTAMPQuery historical snapshotstime-travel, BRANCHING_TIME_TRAVEL_TUTORIAL
AS OF TRANSACTIONQuery by txn IDtime-travel
MERGE BRANCH / DROP BRANCHBranch lifecyclebranching
ON BRANCH overridePer-call branch redirect (MCP/LSP)Release notes

Encryption / Security / Compliance

FeatureWhat it doesDocs
AES-256-GCM TDEDatabase-level transparent encryptionENCRYPTION_TUTORIAL, ENCRYPTION
Zero-knowledge encryptionKeys are derived and data encrypted on the client; the server never sees plaintext keysencryption
FIPS 140-3AWS-LC FIPS provider, Cert #4816 (opt-in fips build)FIPS_COMPLIANCE_TUTORIAL
SCRAM-SHA-256 authPG-standard password hashingSCRAM_SHA256_AUTHENTICATION
TLS / SSLEncrypted wire (PG + MySQL)POSTGRESQL_SSL_QUICK_REFERENCE
Row-Level Security (RLS)Per-tenant isolation via policies (embedded API and REPL; SQL CREATE POLICY and wire/REST enforcement planned)RLS_POLICY_MANAGEMENT_TUTORIAL, rls
JWT sessionsStateless authJWT_AUTH_QUICK_REFERENCE
OAuth2 (Google/GitHub)PKCE, auto user creationAUTH_AND_OAUTH
Audit loggingTamper-proof SHA-256 chainAUDIT_LOGGING_TUTORIAL, AUDIT_LOGGING
Argon2id KDFMemory-hard password hashingENCRYPTION_TUTORIAL

Stored Procedures / Triggers / Functions

FeatureWhat it doesDocs
PL/pgSQL functions and proceduresSQL statements, SELECT INTO, RETURN; control flow (IF / LOOP / WHILE / FOR / RAISE) plannedprocedural-language
TriggersAccepted; bodies run only for BEFORE-row NEW.col = expr assignments (full trigger bodies planned)triggers, TRIGGER_EXECUTION_QUICK_REFERENCE
Scalar functions100+ built-inSQL_REFERENCE
Aggregate functionsCOUNT, SUM, AVG, MIN, MAX, STDDEVSQL_REFERENCE
User-defined functionsComposite types via JSONSQL_REFERENCE

JSON / JSONB

FeatureWhat it doesDocs
JSONB typeSchemaless docsSQL_REFERENCE
JSONB operators->, ->>, @>, ?, #-SQL_REFERENCE
JSON path queriesNested navigationSQL_REFERENCE
json_aggJSON array aggregationChangelog

Backend-as-a-Service (BaaS)

FeatureWhat it doesDocs
REST API (PostgREST-style)eq, neq, gt, gte, lt, lte, like, ilike, is, in plus not. on /rest/v1/{table} (the /rest/v1 table routes are a known issue in the current release; more operators planned)BAAS_REST_API_TUTORIAL
Auth signup/token/auth/v1/signup, /auth/v1/tokenAUTH_AND_OAUTH
OAuth2 Google/GitHubPKCE flowAUTH_AND_OAUTH
RLS on RESTPlanned: JWT-based row-level security for REST requestsBAAS_REST_API_TUTORIAL
Realtime WebSocketPhoenix-protocol channels. Known issue: realtime events are not delivered in the current release; tracked by the Nano teamREALTIME_WEBSOCKET
ChangeNotifierEvent broadcast for REST table writesChangelog
Swagger UIAuto-generated /docsSWAGGER_UI_QUICKSTART

Protocol Compatibility

FeatureWhat it doesDocs
PostgreSQL Wire v3psql, libpq, psycopg2, pg, JDBCPOSTGRESQL_WIRE_PROTOCOL
PG Extended QueryParse / Bind / Execute / DescribePARAMETERIZED_QUERIES
MySQL Wire v10mysql, JDBC, mysql2, mysqli, WordPressMYSQL_WIRE
MySQL Prepared Stmts$N substitution, COM_STMT_PREPAREMYSQL_WIRE
Unix Domain SocketsZero-TCP for same-hostUNIX_SOCKETS_QUICKSTART
Flush message (H)Pipelined queriesChangelog
Multi-statement queries;-separated stmtsRelease notes
MySQL SHOW commandsSHOW TABLES/COLUMNS/INDEXChangelog
MySQL date/time functionsDATE_FORMAT, DATE_ADD, UNIX_TIMESTAMPChangelog
MySQL identifier quotingBacktick / double-quote / case-foldingRelease notes
heliosdb_capability_report()Migration tool discoveryRelease notes

Materialized Views

FeatureWhat it doesDocs
MV creationPersistent query resultsMATERIALIZED_VIEWS_TUTORIAL
Refresh MVFull recomputematerialized-views
Incremental MVDelta computationINCREMENTAL_MATERIALIZED_VIEWS
Concurrent MV refreshMulti-MV in parallelCONCURRENT_MV_REFRESH_QUICK_REF
MV schedulerCPU-aware auto refreshMATERIALIZED_VIEWS_TUTORIAL
MV dependency trackingCascading invalidationINCREMENTAL_MATERIALIZED_VIEWS

Code-Graph (opt-in --features code-graph)

FeatureWhat it doesDocs
Code-graph bootstrapTree-sitter AST for 8 languagesCODE_GRAPH_TUTORIAL
Symbol extractionFunctions, classes, methods, typesCODE_GRAPH_TUTORIAL
Reference resolutionCross-file linking (exact/heuristic)Release notes
lsp_definition”Where is X defined?”CODE_GRAPH_TUTORIAL
lsp_references”Who uses X?”CODE_GRAPH_TUTORIAL
lsp_call_hierarchyBFS over CALLS edgesCODE_GRAPH_TUTORIAL
lsp_hoverSignature lookupCODE_GRAPH_TUTORIAL
lsp_document_symbolsFile outlineRelease notes
lsp_rename_preview/applyIdentifier-boundary write-backRelease notes
Symbol embeddingsbody_vec VECTOR(n) lazy columnCODE_GRAPH_TUTORIAL
Pluggable embeddersNoopEmbedder + HttpEmbedderCODE_GRAPH_TUTORIAL
code-embed featurefastembed-rs (BGESmallENV15, 384-dim)CODE_GRAPH_TUTORIAL
Runtime grammar registryDynamic grammar loadingChangelog
Pluggable extractorsPer-language runtime registrationChangelog
Semantic Hash IndexMerkle-tree subtree invalidationSEMANTIC_HASH_INDEX_QUICKREF
_hdb_code_languages viewList static + runtime grammarsChangelog

Graph-RAG (opt-in --features graph-rag)

FeatureWhat it doesDocs
Universal node/edge schema_hdb_graph_nodes & _hdb_graph_edges plain tablesGRAPH_RAG_TUTORIAL
Symbol projectiongraph_rag_project_symbols()GRAPH_RAG_TUTORIAL
BFS graph searchSeed → expand → subgraphGRAPH_RAG_TUTORIAL
Centrality weightingPost-rerank scoring biasGRAPH_RAG_TUTORIAL
Vector entity linkerCross-modal MENTIONS via cosineGRAPH_RAG_TUTORIAL
Docling PDF/Office ingestiongraph_rag_ingest_*DOCLING_INGESTION
Graph traversal toolsheliosdb_graph_traverse / _path / _add_edgeRelease notes

MCP Endpoint (opt-in --features mcp-endpoint)

FeatureWhat it doesDocs
MCP JSON-RPC dispatcherNative server for Claude Code/Cursor/AiderMCP_ENDPOINT
16-tool catalogue10 DB-backed + 6 RAGMCP_ENDPOINT
MCP resource URIsheliosdb://schema/{table} etc.MCP_ENDPOINT
WebSocket transportReal-time tool callsMCP_ENDPOINT
Stdio transportLibrary only (no engine subcommand); for stdio MCP use the HeliosDB CodeKB MCP binaryMCP_ENDPOINT
SSE transportServer-sent eventsMCP_ENDPOINT
Progress notificationsStreaming notifications/progressMCP_ENDPOINT
HTTP POST + SSE pairingForward progress to SSERelease notes
Verbose tool discoverytools/list?verbose=true + helios/infoMCP_ENDPOINT

Persistence / WAL / Replication

FeatureWhat it doesDocs
RocksDB LSM storageWrite-optimised KV storeArchitecture
Write-ahead logDurability guaranteeWAL_QUICK_REFERENCE
WAL streaming replicationWarm standby, async repl (default build)HA_HANDS_ON_TUTORIAL
Branch-based replicationSelective branch sync (opt-in ha-branch-replication build)Release notes
Multi-primary active-activeVector-clock conflict resolution (opt-in ha-tier2 build)high-availability
ShardingConsistent hash ring (opt-in ha-tier3 build)high-availability
Content-addressed dedupCross-node BLAKE3 dedup (opt-in ha-dedup build)high-availability
In-memory mode--memory for tests/CIIN_MEMORY_MODE_QUICKREF

Backup / Restore / Dump

FeatureWhat it doesDocs
Database dumpzstd / gzip / brotli / lz4BACKUP_RESTORE
Selective exportPer-table/schemaBACKUP_RESTORE
Import/export formatsCSV, JSON, JSONL, Parquet, Arrow, SQLBACKUP_RESTORE
SQLite importOne-shot .sqlite conversionfeatures/sqlite/

Observability

FeatureWhat it doesDocs
Tracing / structured loggingtracing macrosTRACING_GUIDE
EXPLAIN ANALYZECost-based plans, JSON/XML/YAMLEXPLAIN_AND_OPTIMIZATION
CPU monitoring (sysinfo)MV scheduler awarenessChangelog
Result cache128-entry LRU + dml/ddl invalidationChangelog
Audit logTamper-proof SHA-256AUDIT_LOGGING_TUTORIAL

Embedded Rust API

FeatureWhat it doesDocs
In-process databaseZero-network, no daemonAPI_REFERENCE, docs.rs
Async runtime (Tokio)Non-blocking I/OAPI_REFERENCE
Code indexing APIcode_index(opts) idempotentCODE_GRAPH_TUTORIAL
Branch operationscreate/switch/list/mergeAPI_REFERENCE
Transaction controlbegin/commit/rollback/savepointAPI_REFERENCE

SDKs & Bindings

LanguageWhat it offersDocs
Rust (heliosdb-nano)Embedded APIdocs.rs
Python (source SDK in HeliosDB-SDKs)psycopg2 + REST; realtime subscriptions are a known issue (tracked)api/python-sdk.md, PYTHON_VECTOR_APP
TypeScript (source SDK in HeliosDB-SDKs, not published to npm)REST + Auth fluent API; realtime subscriptions are a known issue (tracked)api/typescript-sdk.md, NODEJS_BAAS_APP
Gopgx-style + RESTapi/go-sdk.md, GO_EMBEDDED_APP
ORMs (any)SQLAlchemy / Django / Prisma / Drizzle / TypeORM / Sequelize / Hibernate / GORM / SeaORM / DieselORM_SUPPORT, DRIZZLE_PRISMA_COMPAT

Tooling / CLI

FeatureWhat it doesDocs
heliosdb-nano binary~32 MB single executableREADME
REPLZero-setup interactive SQLREPL_COMMAND_REFERENCE
DistributionGitHub Release binaries, the ghcr.io/heliosdatabase/heliosdb-nano container image and the heliosdb-nano crateREADME