sqlite3 vs better-sqlite3
SQLiteデータベース操作
sqlite3better-sqlite3類似パッケージ:

SQLiteデータベース操作

SQLiteは、軽量で自己完結型のリレーショナルデータベース管理システム(RDBMS)で、アプリケーションに組み込みやすく、ファイルベースで動作します。Node.js環境でSQLiteデータベースを操作するためのライブラリとして、sqlite3better-sqlite3があります。sqlite3は、非同期I/Oを使用してSQLiteデータベースとやり取りするための公式なNode.jsバインディングで、コールバック、Promise、ストリームをサポートしています。一方、better-sqlite3は、シンプルで直感的な同期APIを提供し、パフォーマンスと使いやすさを重視したライブラリです。特に、トランザクションやバルク挿入の処理が効率的で、デフォルトでプリペアドステートメントを使用するため、セキュリティとパフォーマンスの両面で優れています。

npmのダウンロードトレンド

3 年

GitHub Starsランキング

統計詳細

パッケージ
ダウンロード数
Stars
サイズ
Issues
公開日時
ライセンス
sqlite32,037,7776,4243.4 MB16813日前BSD-3-Clause
better-sqlite307,04410.3 MB9012日前MIT

機能比較: sqlite3 vs better-sqlite3

APIスタイル

  • sqlite3:

    sqlite3は非同期APIを提供し、コールバック、Promise、ストリームをサポートしています。非同期処理が必要なアプリケーションに適していますが、コールバック地獄に陥る可能性があります。

  • better-sqlite3:

    better-sqlite3は同期APIを提供し、シンプルで直感的なインターフェースを持っています。非同期処理が不要な場合や、トランザクションを簡単に扱いたい場合に適しています。

パフォーマンス

  • sqlite3:

    sqlite3は非同期I/Oを使用しており、大規模なデータセットを処理する際にパフォーマンスが低下する可能性があります。特に、コールバックやPromiseを使用する場合、処理が分散するため、遅延が発生することがあります。

  • better-sqlite3:

    better-sqlite3は、デフォルトでプリペアドステートメントを使用し、トランザクションやバルク挿入のパフォーマンスが向上しています。特に、同期処理であるため、処理が直線的に行われ、遅延が少なくなります。

トランザクション処理

  • sqlite3:

    sqlite3はトランザクションをサポートしていますが、明示的に開始、コミット、ロールバックを行う必要があります。非同期処理のため、トランザクション管理が複雑になることがあります。

  • better-sqlite3:

    better-sqlite3はトランザクション処理が簡単で、同期的に行われるため、コードがシンプルになります。トランザクションブロック内でのエラー処理も容易です。

バルク挿入

  • sqlite3:

    sqlite3はバルク挿入をサポートしていますが、各挿入ごとにトランザクションを開始する必要があります。これにより、パフォーマンスが低下する可能性があります。

  • better-sqlite3:

    better-sqlite3はバルク挿入を効率的に行うことができ、トランザクションを自動的に管理します。これにより、パフォーマンスが大幅に向上します。

セキュリティ

  • sqlite3:

    sqlite3はプリペアドステートメントをサポートしており、SQLインジェクション攻撃に対する基本的な防御が提供されています。ただし、開発者が適切に使用する必要があります。

  • better-sqlite3:

    better-sqlite3もプリペアドステートメントをデフォルトで使用しており、セキュリティが強化されています。特に、同期APIであるため、状態管理が容易で、意図しない副作用が発生しにくくなっています。

Ease of Use: Code Examples

  • sqlite3:

    sqlite3を使用した簡単な例

    const sqlite3 = require('sqlite3').verbose();
    const db = new sqlite3.Database(':memory:');
    
    db.serialize(() => {
      db.run('CREATE TABLE user (id INT, name TEXT)');
      const stmt = db.prepare('INSERT INTO user VALUES (?, ?)');
      stmt.run(1, 'Alice');
      stmt.run(2, 'Bob');
      stmt.finalize();
    
      db.each('SELECT id, name FROM user', (err, row) => {
        console.log(row.id, row.name);
      });
    });
    
    db.close();
    
  • better-sqlite3:

    better-sqlite3を使用した簡単な例

    const Database = require('better-sqlite3');
    const db = new Database(':memory:');
    
    db.exec('CREATE TABLE user (id INTEGER, name TEXT)');
    const insert = db.prepare('INSERT INTO user (id, name) VALUES (?, ?)');
    insert.run(1, 'Alice');
    insert.run(2, 'Bob');
    
    const users = db.prepare('SELECT id, name FROM user').all();
    console.log(users);
    
    // トランザクションの例
    const insertMany = db.transaction((users) => {
      const insert = db.prepare('INSERT INTO user (id, name) VALUES (?, ?)');
      for (const user of users) {
        insert.run(user.id, user.name);
      }
    });
    
    insertMany([{ id: 3, name: 'Charlie' }, { id: 4, name: 'Dave' }]);
    
    const allUsers = db.prepare('SELECT * FROM user').all();
    console.log(allUsers);
    

選び方: sqlite3 vs better-sqlite3

  • sqlite3:

    sqlite3を選択する理由は、非同期処理が必要な場合や、既存のコードベースでコールバックやPromiseを使用している場合です。また、ストリーミングAPIを利用して大規模なデータセットを効率的に処理したい場合にも適しています。

  • better-sqlite3:

    better-sqlite3を選択する理由は、シンプルで直感的な同期APIを求めている場合や、トランザクション処理やバルク挿入を効率的に行いたい場合です。特に、パフォーマンスと使いやすさを重視するプロジェクトに適しています。

sqlite3 のREADME

:no_entry: [DEPRECATED] node-sqlite3

Note: This repository is currently unmaintained. We will not update any of its issues or pull requests.


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

Latest release Build Status FOSSA Status N-API v3 Badge N-API v6 Badge

Features

Installing

You can use npm or yarn to install sqlite3:

  • (recommended) Latest published package:
npm install sqlite3
# or
yarn add sqlite3
  • GitHub's master branch: npm install https://github.com/tryghost/node-sqlite3/tarball/master

Prebuilt binaries

sqlite3 v5+ was rewritten to use Node-API so prebuilt binaries do not need to be built for specific Node versions. sqlite3 currently builds for both Node-API v3 and v6. Check the Node-API version matrix to ensure your Node version supports one of these. The prebuilt binaries should be supported on Node v20.17.0+.

The module uses prebuild-install to download the prebuilt binary for your platform, if it exists. These binaries are hosted on GitHub Releases for sqlite3 versions above 5.0.2, and they are hosted on S3 otherwise. The following targets are currently provided:

  • darwin-arm64
  • darwin-x64
  • linux-arm64
  • linux-x64
  • linuxmusl-arm64
  • linuxmusl-x64
  • win32-x64

Unfortunately, prebuild cannot differentiate between armv6 and armv7, and instead uses arm as the {arch}. Until that is fixed, you will still need to install sqlite3 from source.

Support for other platforms and architectures may be added in the future if CI supports building on them.

If your environment isn't supported, it'll use node-gyp to build SQLite, but you will need to install a C++ compiler and linker.

Other ways to install

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

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.)

API

See the API documentation in the wiki.

Usage

Note: the module must be installed before use.

const sqlite3 = require('sqlite3').verbose();
const db = new sqlite3.Database(':memory:');

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

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

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

db.close();

Source install

To skip searching for pre-compiled binaries, and force a build from source, use

npm install --build-from-source

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 wrapper:

npm install --build-from-source --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:

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

Custom file header (magic)

The default sqlite file header is "SQLite format 3". You can specify a different magic, though this will make standard tools and libraries unable to work with your files.

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

Note that the magic must be exactly 15 characters long (16 bytes including null terminator).

Building for node-webkit

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

To build 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:

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)

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

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

For instructions on building SQLCipher, see Building SQLCipher for Node.js. Alternatively, you can install it with your local package manager.

To run against SQLCipher, you need to compile sqlite3 from source by passing build options like:

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

node -e 'require("sqlite3")'

If your SQLCipher is installed in a custom location (if you compiled and installed it yourself), you'll need to set some environment variables:

On OS X with Homebrew

Set the location where brew installed it:

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

node -e 'require("sqlite3")'

On most Linuxes (including Raspberry Pi)

Set the location where make installed it:

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

Running sqlite3 through electron-rebuild does not preserve the SQLCipher extension, so some additional flags are needed to make this build Electron compatible. Your npm install sqlite3 --build-from-source command needs these additional flags (be sure to replace the target version with the current Electron version you are working with):

--runtime=electron --target=18.2.1 --dist-url=https://electronjs.org/headers

In the case of MacOS with Homebrew, the command should look like the following:

npm install sqlite3 --build-from-source --sqlite_libname=sqlcipher --sqlite=`brew --prefix` --runtime=electron --target=18.2.1 --dist-url=https://electronjs.org/headers

Testing

npm test

Contributors

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.

This module was originally created by Mapbox & is now maintained by Ghost.

Changelog

We use GitHub releases for notes on the latest versions. See CHANGELOG.md in git history for details on older versions.

Copyright & license

Copyright (c) 2013-2026 Mapbox & Ghost Foundation

node-sqlite3 is BSD licensed.

FOSSA Status