Asynchronous, non-blocking SQLite3 bindings
sqlite3 module works with Node.js v0.10.x or v0.12.x and also in io.js v1.1.0.
Binaries for most Node versions and platforms are provided by default via node-pre-gyp.
Note: the module must be installed before use.
var sqlite3 = require'sqlite3'verbose;var db = ':memory:';dbserializedbrun"CREATE TABLE lorem (info TEXT)";var stmt = dbprepare"INSERT INTO lorem VALUES (?)";for var i = 0; i < 10; i++stmtrun"Ipsum " + i;stmtfinalize;dbeach"SELECT rowid AS id, info FROM lorem"console.logrowid + ": " + row.info;;;dbclose;
See the API documentation in the wiki.
You can use
npm to download and install:
npm install sqlite3
npm install https://github.com/mapbox/node-sqlite3/tarball/master
In both cases the module is automatically built with npm's internal version of
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).
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
npm install or the
./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
Because of ABI differences,
sqlite3 must be built in a custom to be used with node-webkit.
To build node-sqlite3 for node-webkit:
npm install nw-gyp -g (unless already installed)
Build the module with the custom flags of
NODE_WEBKIT_VERSION="0.8.6" # see latest version atnpm install sqlite3 --build-from-source --runtime=node-webkit --target_arch=ia32 --target=$(NODE_WEBKIT_VERSION)
You can also run this command from within a
npm install --build-from-source --runtime=node-webkit --target_arch=ia32 --target=$(NODE_WEBKIT_VERSION)
Remember the following:
You must provide the right
ia32 is needed to target 32bit node-webkit builds, while
x64 will target 64bit node-webkit builds (if available for your platform).
sqlite3 package is built for node-webkit it cannot run in the vanilla Node.js (and vice versa).
npm testof the node-webkit's package would fail.
Visit the “Using Node modules” article in the node-webkit's wiki for more details.
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="-L`brew --prefix`/opt/sqlcipher/lib" export CPPFLAGS="-I`brew --prefix`/opt/sqlcipher/include" npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=`brew --prefix`
mocha is required to run unit tests.
In sqlite3's directory (where its
package.json resides) run the following:
npm install mocha npm test
Development of this module is sponsored by MapBox.
node-sqlite3 is BSD licensed.