Node.js SDK reference
Last updated 29 October 2026
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
| Import | Opens | Use it for |
|---|---|---|
@tonbo/sqlite-ursula/tonbo | A Tonbo database by name or URL, with a Tonbo API key (since 0.11.1) | An application on Tonbo. open() and resolveDatabase(). |
@tonbo/sqlite-ursula | A stream by URL, with a bearer token you supply | A token you mint yourself, a self-hosted Ursula, importSqlite() and loadUrsulaVfs(). |
@tonbo/sqlite-ursula/tonbo/pi | Pi 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/pi | Pi Durable’s SqliteStorage on a database, by URL | A 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.2Pin 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-durableExports
| Name | Kind | Entry points |
|---|---|---|
open | function | /tonbo, since 0.11.1 |
TonboOpenOptions | type | /tonbo, since 0.11.1 |
open | function | root |
OpenOptions | type | root |
resolveDatabase | function | /tonbo, since 0.11.1 |
TonboResolveOptions | type | /tonbo, since 0.11.1 |
ResolvedDatabase | type | /tonbo, since 0.11.1 |
UrsulaDatabase | class | root, /tonbo |
ResetListener | type | root, /tonbo |
UrsulaStatus | type | root, /tonbo |
UrsulaSalvage | type | root, /tonbo |
UrsulaError | class | root, /tonbo, /tonbo/pi |
UrsulaErrorAction | type | root, /tonbo |
UrsulaErrorKind | type | root, /tonbo |
UrsulaWriteRefusedError | class | root, /tonbo, /tonbo/pi |
WriteRefusedKind | type | root, /tonbo |
UrsulaResetError | class | root, /tonbo, /tonbo/pi |
ResetKind | type | root, /tonbo |
UrsulaUnavailableError | class | root, /tonbo, /tonbo/pi |
UnavailableKind | type | root, /tonbo |
UrsulaSetupError | class | root, /tonbo, /tonbo/pi |
SetupKind | type | root, /tonbo |
TonboError | class | /tonbo, /tonbo/pi, since 0.11.1 |
TonboKind | type | /tonbo, /tonbo/pi, since 0.11.1 |
TokenProvider | type | root, /tonbo, since 0.11.1 |
BearerToken | type | root, /tonbo, since 0.11.1 |
gate | function | root, /tonbo |
GateOptions | type | root, /tonbo |
importSqlite | function | root |
ImportOptions | type | root |
Imported | type | root |
openUrsulaPiStorage | function | /pi |
UrsulaPiStorageOptions | type | /pi |
openUrsulaPiStorage | function | /tonbo/pi, since 0.11.1 |
TonboPiStorageOptions | type | /tonbo/pi, since 0.11.1 |
loadUrsulaVfs | function | root |