Asynchronous, non-blocking SQLite3 bindings for Node.js.




Supported platforms

The sqlite3 module works with Node.js v0.10.x or v0.11.x (though only v0.11.13 and above).

Binaries for most Node versions and platforms are provided by default via node-pre-gyp.

The sqlite3 module also works with node-webkit if node-webkit contains a supported version of Node.js engine. (See below.)

SQLite's SQLCipher extension is also supported. (See below.)

Usage

Note: the module must be installed before use.

`` js
var sqlite3 = require('sqlite3').verbose();
var db = new sqlite3.Database(':memory:');

db.serialize(function() {
db.run("CREATE TABLE lorem (info TEXT)");

var stmt = db.prepare("INSERT INTO lorem VALUES (?)");
for (var i = 0; i < 10; i++) {
stmt.run("Ipsum " + i);
}
stmt.finalize();

db.each("SELECT rowid AS id, info FROM lorem", function(err, row) {
console.log(row.id + ": " + row.info);
});
});

db.close();
`

Features

- Straightforward query and parameter binding interface
- Full Buffer/Blob support
- Extensive debugging support
- Query serialization API
- Extension support
- Big test suite
- Written in modern C++ and tested for memory leaks

API

See the API documentation in the wiki.

Installing

You can use npm to download and install:

* The latest sqlite3 package: npm install sqlite3

* GitHub's master branch: npm install https://github.com/mapbox/node-sqlite3/tarball/master

In both cases the module is automatically built with npm's internal version of node-gyp,
and thus your system must meet node-gyp's requirements.

It is also possible to make your own build of sqlite3 from its source instead of its npm package (see below).

It is possible to use the installed package in node-webkit instead of the vanilla Node.js. See Building for node-webkit for details.

Source install

Unless building via npm install (which uses its own node-gyp) you will need node-gyp installed globally:

npm install node-gyp -g

The sqlite3 module depends only on libsqlite3. However, by default, an internal/bundled copy of sqlite will be built and statically linked, so an externally installed sqlite3 is not required.

If you wish to install against an external sqlite then you need to pass the --sqlite argument to node-gyp, npm install or the configure wrapper.

./configure --sqlite=/usr/local
make

Or, using the node-gyp directly:

node-gyp --sqlite=/usr/local
make

Or, using npm:

npm install --sqlite=/usr/local

If building against an external sqlite3 make sure to have the development headers available. Mac OS X ships with these by default. If you don't have them installed, install the -dev package with your package manager, e.g. apt-get install libsqlite3-dev for Debian/Ubuntu. Make sure that you have at least libsqlite3 >= 3.6.

Note, if building against homebrew-installed sqlite on OS X you can do:

./configure --sqlite=/usr/local/opt/sqlite/
make

Building for node-webkit

Because of ABI differences, sqlite3 must be built in a custom to be used with node-webkit.

To build node-sqlite3 for node-webkit:

1. Install nw-gyp globally: npm install nw-gyp -g (unless already installed)

2. Build the module with the custom flags of --runtime, --target_arch, and --target:

`sh
NODE_WEBKIT_VERSION="0.8.6" # see latest version at https://github.com/rogerwang/node-webkit#downloads
npm install sqlite3 --build-from-source --runtime=node-webkit --target_arch=ia32 --target=$(NODE_WEBKIT_VERSION)
`

This command internally calls out to node-pre-gyp which itself calls out to nw-gyp when the --runtime=node-webkit option is passed.

You can also run this command from within a node-sqlite3 checkout:

`sh
npm install --build-from-source --runtime=node-webkit --target_arch=ia32 --target=$(NODE_WEBKIT_VERSION)
`

Remember the following:

* You must provide the right --target_arch flag. ia32 is needed to target 32bit node-webkit builds, while x64 will target 64bit node-webkit builds (if available for your platform).

* After the sqlite3 package is built for node-webkit it cannot run in the vanilla Node.js (and vice versa).
* For example, npm test of the node-webkit's package would fail.

Visit the “Using Node modules” article in the node-webkit's wiki for more details.

Building for sqlcipher

To run node-sqlite3 against sqlcipher you need to compile from source by passing build options like:

npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=/usr/

If your sqlcipher is installed in a custom location, say if you installed it with homebrew on OS X you also need to do:

export LDFLAGS="-Lbrew --prefix/opt/sqlcipher/lib"
export CPPFLAGS="-Ibrew --prefix/opt/sqlcipher/include"
npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=brew --prefix

Testing

mocha is required to run unit tests.

In sqlite3's directory (where its package.json resides) run the following:

npm install mocha
npm test

Contributors

* Konstantin Käfer
* Dane Springmeyer
* Will White
* Orlando Vazquez
* Artem Kustikov
* Eric Fredricksen
* John Wright
* Ryan Dahl
* Tom MacWright
* Carter Thaxton
* Audrius Kažukauskas
* Johannes Schauer
* Mithgol

Acknowledgments

Thanks to Orlando Vazquez,
Eric Fredricksen and
Ryan Dahl for their SQLite bindings for node, and to mraleph on Freenode's #v8 for answering questions.

Development of this module is sponsored by MapBox.

License

node-sqlite3` is BSD licensed.