gdDocumentation0.8.0

API reference

GD.database.sqlite

Entry for opening low-level synchronous connections to embedded SQLite databases.

Methods

open

open(path: String, opts: Dictionary = {  }) -> GDSQLiteDB, Err

Open a mounted embedded database.

Parameters

NameTypeDefaultDescription
pathStringRequiredFilesystem path; relative paths use the execution directory and access follows configured permissions.
optsDictionary{ }Named options for this operation. Omitted entries use their documented defaults.

Return value

GDSQLiteDB, Err

Errors

The result carries a value and an Err. Check the error before using the value; a failure may retain partial progress. In a function returning value, Err, use ? to propagate failure to the caller. The ! operator terminates the program on failure; in serve it fails the current handler.

busy_ms, max_ms, max_rows, and max_bytes accept 0..2147483647. The number of bound values follows the engine's variable limit.