Package ai.velr

package ai.velr

Java and Kotlin bindings for the embedded Velr property-graph database.

The main entry point is Velr. Connections are synchronous and own child handles such as transactions, streams, tables, rows, savepoints, and explain traces. Close handles when they are no longer needed, preferably with try-with-resources in Java or use in Kotlin.

Query result values are exposed as Cell objects. Vector embedding callbacks receive typed Velr property values through VectorEmbeddingInput and VectorEmbeddingField. Arrow C Data Interface and Arrow IPC binding are available through ArrowColumn, Velr.bindArrow(String, java.util.List), and Velr.bindArrowIpc(String, byte[]).

Class	Description
ArrowColumn	One Arrow C Data Interface column to bind under a logical table name.
ArrowColumn.Chunk	One Arrow C Data Interface chunk in a column.
Cell	One value returned by a Velr result table.
CellType	Runtime kind of a value returned in a Velr result row.
ExplainTrace	Explain or explain-analyze trace returned by Velr.
MigrationReport	Result of an explicit Velr schema migration check or migration run.
MigrationStatus	Outcome of an explicit Velr schema migration.
QueryOptions	Query execution options for bounded result previews and Cypher parameter binding.
QueryOptions.Builder	Builder for QueryOptions.
Rows	Streaming row cursor for a result table.
Savepoint	Transaction savepoint handle.
Stream	Streaming result-table handle returned by Velr.exec(String).
StreamTx	Streaming result-table handle returned by VelrTx.exec(String).
Table	One result table returned by a query.
TransactionCallback<T>	Callback run inside a Velr transaction.
VectorEmbedder	Callback used by Velr vector indexes to produce embeddings.
VectorEmbeddingField	One Velr property value passed to a vector embedding callback.
VectorEmbeddingInput	One source row or query payload passed to a registered vector embedding callback.
VectorEmbeddingPurpose	Why Velr is requesting vectors from a registered embedder.
VectorEntityKind	Graph entity kind for vector embedding inputs.
VectorStorageType	SQLite-compatible storage kind for exact vector field reconstruction.
VectorValueType	Public Velr property value kind passed to a vector embedding callback.
Velr	Synchronous embedded Velr database connection.
VelrException	Base unchecked exception raised by the Velr Java/Kotlin driver.
VelrStorageType	SQLite-compatible storage kind used for exact Velr property reconstruction.
VelrTx	Explicit Velr transaction.
VelrValue	One typed Velr property value.
VelrValueType	Public Velr property value kind.