Node.js SDK reference

Last updated 29 October 2026

View .md

Every export of @tonbo/sqlite-ursula 0.11.2, with its options, return values, status fields and errors.

To get started, follow the SQLite quickstart and Connect from Node.js. This reference marks what 0.11.0 lacks with the release that added it, such as “since 0.11.1”, and what a later release changed with that release.

Entry points

ImportOpensUse it for
@tonbo/sqlite-ursula/tonboA Tonbo database by name or URL, with a Tonbo API key (since 0.11.1)An application on Tonbo. open() and resolveDatabase().
@tonbo/sqlite-ursulaA stream by URL, with a bearer token you supplyA token you mint yourself, a self-hosted Ursula, importSqlite() and loadUrsulaVfs().
@tonbo/sqlite-ursula/tonbo/piPi Durable’s SqliteStorage on a Tonbo database, by name (since 0.11.1)A Pi Durable Harness on Tonbo. See Pi Durable storage.
@tonbo/sqlite-ursula/piPi Durable’s SqliteStorage on a database, by URLA Pi Durable Harness. See Pi Durable storage.

/tonbo also exports the database class, gate, the errors and the token types, so an application on Tonbo imports from it alone. It does not export OpenOptions, importSqlite or loadUrsulaVfs; import those from the root entry.

Install

npm install --save-exact @tonbo/sqlite-ursula@0.11.2

Pin this exact version, as --save-exact records it: a later release can change the package’s entry points, its cache format and the server releases it works with. It needs Node.js 22.19 or later on one of the prebuilt platforms (see Requirements). For Pi Durable, install its optional peer dependency too, from 1.0.0 up to but not including 1.4.0 (see Quickstart: Pi Durable):

npm install --save-exact @tonbo/sqlite-ursula@0.11.2 @earendil-works/pi-durable

Exports

NameKindEntry points
openfunction/tonbo, since 0.11.1
TonboOpenOptionstype/tonbo, since 0.11.1
openfunctionroot
OpenOptionstyperoot
resolveDatabasefunction/tonbo, since 0.11.1
TonboResolveOptionstype/tonbo, since 0.11.1
ResolvedDatabasetype/tonbo, since 0.11.1
UrsulaDatabaseclassroot, /tonbo
ResetListenertyperoot, /tonbo
UrsulaStatustyperoot, /tonbo
UrsulaSalvagetyperoot, /tonbo
UrsulaErrorclassroot, /tonbo, /tonbo/pi
UrsulaErrorActiontyperoot, /tonbo
UrsulaErrorKindtyperoot, /tonbo
UrsulaWriteRefusedErrorclassroot, /tonbo, /tonbo/pi
WriteRefusedKindtyperoot, /tonbo
UrsulaResetErrorclassroot, /tonbo, /tonbo/pi
ResetKindtyperoot, /tonbo
UrsulaUnavailableErrorclassroot, /tonbo, /tonbo/pi
UnavailableKindtyperoot, /tonbo
UrsulaSetupErrorclassroot, /tonbo, /tonbo/pi
SetupKindtyperoot, /tonbo
TonboErrorclass/tonbo, /tonbo/pi, since 0.11.1
TonboKindtype/tonbo, /tonbo/pi, since 0.11.1
TokenProvidertyperoot, /tonbo, since 0.11.1
BearerTokentyperoot, /tonbo, since 0.11.1
gatefunctionroot, /tonbo
GateOptionstyperoot, /tonbo
importSqlitefunctionroot
ImportOptionstyperoot
Importedtyperoot
openUrsulaPiStoragefunction/pi
UrsulaPiStorageOptionstype/pi
openUrsulaPiStoragefunction/tonbo/pi, since 0.11.1
TonboPiStorageOptionstype/tonbo/pi, since 0.11.1
loadUrsulaVfsfunctionroot