Skip to content

Binaries

Hannah Wolfe edited this page Dec 6, 2015 · 21 revisions

As of v2.1.16 (and pull request #192) node-sqlite3 now defaults to installing a pre-built binary of node_sqlite3.node (with a statically linked libsqlite3) when available. As of v2.2.0 (and pull request #245) the binary deployment system moved to using node-pre-gyp.

Help

If you've landed here due to a failed install of node-sqlite3 then feel free to create a new issue to ask for help. The most likely problem is that we do not yet provide pre-built binaries for your particular platform and so the node-sqlite3 install attempted a source compile but failed because you are missing the dependencies for node-gyp. But please provide as much detail on your problem as possible and we'll try to help. Please include:

  • terminal logs of failed install (best from running npm install sqlite3 --loglevel=info)
  • node-sqlite3 version you tried to install
  • node version you are running
  • operating system and architecture you are running, e.g. Windows 7 64 bit.

Background

The Node.js project is discussing the design of a system for binary deployments and a build farm for C++ modules like node-sqlite3. But since this does not exist yet we are leveraging node-pre-gyp and S3 hosting.

Forcing a source compile

To force building from source do:

npm install sqlite3 --build-from-source=sqlite3

or, if you are installing an app that depends on `sqlite3:

npm install --build-from-source=sqlite3

Installing an alternative arch

To request an (additional) arch be installed that is different from the value of process.arch for your running node version you can pass --target_arch. For example, to install a 32bit binary on the 64 bit system do:

npm install sqlite3 --target_arch=ia32

Missing binaries

We have not yet built binaries for all possible variants.

Users that find a binary is not available for their platform are encouraged to trigger a custom source compile that will package a binary for later distribution. To do this run:

npm install node-pre-gyp
node-pre-gyp package

This will drop a tarball (.tar.gz) in the build/stage/ folder within the installed module folder.

To submit your build tar.gz you can create a new github issue and provide a link to the tarball.

Available binaries

Currently available binaries are listed here.

Binary versioning

Binaries are versioned based on the node-sqlite3 version, node version, platform, and architecture. Given this amounts to many versions we have not yet created binaries for all possible combinations.

For more info about the versioning see https://github.com/springmeyer/node-pre-gyp/wiki/Versioning.

For info about how node versions crosswalk with their ABI version see: https://github.com/springmeyer/node-pre-gyp/wiki/Node-ABI

Code implementation

See https://github.com/springmeyer/node-pre-gyp

Clone this wiki locally