rusty-sqlite3 v0.5.1

rusty-sqlite3

A SQLite3 Client built with Rust Library SQLx and Neon.

Install

Installing rusty-sqlite3 requires Rust Programming Language installed in your device.

Then you can install the project with npm. In the project directory, run:

$ npm install rusty-sqlite3

This fully installs rust-sqlite3, including installing any dependencies and running the build.

APIs

Database operations in SQLx are asynchronous, so all API provided by this package will return a Promise.

connect(url)

Create a new connection with a database file, or open an in memory SQLite3 database. Return true if connected successfully.

Both reconnect and disconnect are currently impossible.

Example

1. Open a database file.

   > await rustySqlite3.connect("sqlite://database.sqlite")
   true

2. Open an in memory SQLite3 database.

   > await rustySqlite3.connect("sqlite://:memory:")
   true

execute(sql, [args])

Execute the provided SQL. Returns the query result with an array of object.

Arguments are optional. For more information of binding a value with query, see SQLx API Documentation for details.

Example

> await rustySqlite3.execute("select sqlite_version()")
[ { 'sqlite_version()': '3.38.2' } ]
> await rustSqlite3.execute("create table test (id int, value varchar)")
[]
> await rustySqlite3.execute("insert into test (id, value) values (?, ?) returning *", [1, "value"])
[ { id: 1, value: 'value' } ]
> await rustySqlite3.execute("insert into test (id, value) values (?, ?) returning *", [2, null])
[ { id: 2, value: null } ]
> await rustySqlite3.execute("select * from test")
[ { id: 1, value: 'value' }, { id: 2, value: null } ]