@6river/sqlite3 中文文档教程

Question

Node.js 的异步、非阻塞 SQLite3 绑定。

Supported platforms

sqlite3< /code> 模块适用于 Node.js v4.x、v6.x、v8.x、v10.x、v11.x 和 v12.x。

大多数 Node 版本和平台的二进制文件默认通过 node-pre-gyp 提供。

sqlite3 模块也适用于 node-webkit 如果 node-webkit 包含支持的版本Node.js 引擎。 （参见 下文。）

SQLite 的 SQLCipher 扩展也支持。 （参见下文。）

Usage

注意：模块必须已安装 a> 使用前。

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
• Bundles Sqlite3 3.26.0 as a fallback if the installing system doesn't include SQLite

API

请参阅 wiki 中的 API 文档。

Installing

你可以使用npm来 下载 安装：

• 最新的sqlite3包：npm install sqlite3

• GitHub的master分支：npm install https://github.com/mapbox/node-sqlite3/tarball/master

的模块使用 node-pre-gyp 为您的平台下载预编译的二进制文件（如果存在）。 否则，它使用 node-gyp 构建扩展。

也可以从 它的 源代码而不是 它的 npm 包构建你自己的sqlite3（见 下面).

可以 使用node-webkit 中安装的包来代替 vanilla Node.js。 有关详细信息，请参阅为 node-webkit 构建。

Source install

要跳过搜索预编译二进制文件并强制从源代码构建，请使用

npm install --build-from-source

The sqlite3 module depends only on libsqlite3。 但是，默认情况下，将构建并静态链接 sqlite 的内部/捆绑副本，因此不需要外部安装的 sqlite3。

如果您希望针对外部 sqlite 安装，则需要将 --sqlite 参数传递给 npm 包装器：

npm install --build-from-source --sqlite=/usr/local

如果针对外部 sqlite3 进行构建，请确保具有开发标头可用的。 Mac OS X 默认附带这些。 如果您没有安装它们，请使用您的包管理器安装 -dev 包，例如 Debian/Ubuntu 的 apt-get install libsqlite3-dev。 确保您至少有 libsqlite3 >= 3.6。

请注意，如果在 OS X 上针对自制安装的 sqlite 进行构建，您可以执行以下操作：

npm install --build-from-source --sqlite=/usr/local/opt/sqlite/

默认情况下，node-gyp 安装将使用 python 作为安装的一部分。 A 可以在命令行上指定不同的 python 可执行文件。

npm install --build-from-source --python=/usr/bin/python2

这使用了 npmconfigpython 配置，因此 .npmrc 中的值将被接受：

python=/usr/bin/python2

Custom file header (magic)

默认的 sqlite 文件头是“SQLite format 3”。
您可以指定不同的魔法，但这会使标准工具和库无法处理您的文件。

npm install --build-from-source --sqlite_magic="MyCustomMagic15"

请注意，魔法必须 正好是 15 个字符长（16 个字节，包括空终止符）。

Building for node-webkit

由于 ABI 差异，sqlite3 必须在自定义中构建才能与 node-webkit。

为 node-webkit 构建 node-sqlite3：

1. 全局安装 nw-gyp：npm install nw-gyp -g （除非已经安装）

2. 使用 --runtime、--target_arch< 的自定义标志构建 模块/code> 和 --target：

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)

此命令在内部调用 node-pre -gyp 当--runtime=node-webkit 选项被传递。

您还可以从 node-sqlite3 checkout 中运行此命令：

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

请记住以下几点：

• 您必须提供正确的 --target_arch 标志。 ia32 需要针对 32 位 node-webkit 构建，而 x64 将针对 64 位 node-webkit 构建（如果适用于您的平台）。

• 在为 node-webkit 构建 sqlite3 包后，它不能在普通 Node.js 中运行（反之亦然）。

• 例如，node-webkit 包的 npm test 会失败。

访问 node-webkit wiki 中的“使用 Node 模块”一文了解更多  ;细节。

Building for sqlcipher

有关构建 sqlcipher 的说明，请参见 为 node.js 构建 SQLCipher

运行 node-sqlite3针对 sqlcipher，您需要通过传递构建选项从源代码进行编译，例如：

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

node -e 'require("sqlite3")'

如果您的 sqlcipher 安装在自定义位置（如果您自己编译和安装）， 您还需要设置一些环境变量：

On OS X with Homebrew

设置 brew 安装

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`

node -e 'require("sqlite3")'

On most Linuxes (including Raspberry Pi)

位置： 设置 make 安装位置：

export LDFLAGS="-L/usr/local/lib"
export CPPFLAGS="-I/usr/local/include -I/usr/local/include/sqlcipher"
export CXXFLAGS="$CPPFLAGS"
npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=/usr/local --verbose

node -e 'require("sqlite3")'

Custom builds and Electron

通过 electron-rebuild 不保留 sqlcipher 扩展，因此需要一些额外的标志来使此构建与 Electron 兼容。 您的 npm install sqlite3 --build-from-source 命令需要这些额外的标志（确保将目标版本替换为您正在使用的当前 Electron 版本）：

--runtime=electron --target=1.7.6 --dist-url=https://atom.io/download/electron

对于使用 Homebrew 的 MacOS，该命令应如下所示：

npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=`brew --prefix` --runtime=electron --target=1.7.6 --dist-url=https://atom.io/download/electron

Testing

mocha 是运行单元测试所必需的。

在 sqlite3 的目录（它的 package.json 所在的位置）运行以下内容：

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

感谢 Orlando Vazquez， Eric Fredricksen 和 Ryan Dahl 用于节点的 SQLite 绑定，以及 Freenode 的 #v8 上的 mraleph 用于回答问题。

此模块的开发由 MapBox 赞助。

License

node-sqlite3 是 BSD 许可。