sqlite3 vs better-sqlite3
SQLite Database Libraries for Node.js
sqlite3better-sqlite3Similar Packages:

SQLite Database Libraries for Node.js

SQLite Database Libraries for Node.js are tools that allow Node.js applications to interact with SQLite databases. These libraries provide an interface for executing SQL queries, managing transactions, and handling database connections directly from JavaScript code. They are essential for applications that require lightweight, file-based databases for data storage, retrieval, and manipulation. better-sqlite3 is a fast and efficient SQLite library for Node.js that offers a simple API, synchronous and asynchronous query execution, and built-in support for prepared statements. It is designed for performance and ease of use, making it ideal for applications that need to interact with SQLite databases quickly and reliably. On the other hand, sqlite3 is a widely-used SQLite library for Node.js that provides a comprehensive set of features for working with SQLite databases. It supports asynchronous and streaming APIs, transactions, and prepared statements, making it versatile for various use cases. While sqlite3 is well-established and feature-rich, it may have a steeper learning curve compared to better-sqlite3, especially for developers new to SQLite or Node.js.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
sqlite32,044,5276,4193.4 MB1672 months agoBSD-3-Clause
better-sqlite307,16410.4 MB9022 days agoMIT

Feature Comparison: sqlite3 vs better-sqlite3

Performance

  • sqlite3:

    sqlite3 is performant for asynchronous operations, but its performance can vary depending on how queries are structured and executed. It is generally reliable, but may not match the speed of better-sqlite3 for simple, synchronous queries.

  • better-sqlite3:

    better-sqlite3 is optimized for performance, especially for synchronous operations. It provides faster query execution and lower latency for most use cases, making it a great choice for applications that require quick database interactions.

API Design

  • sqlite3:

    sqlite3 provides a comprehensive API that supports both callback and promise-based patterns. However, its API can be more complex and may require additional effort to understand and use effectively, particularly for beginners.

  • better-sqlite3:

    better-sqlite3 offers a clean and intuitive API that is easy to use, especially for developers familiar with synchronous programming. Its design minimizes boilerplate code and simplifies common tasks like executing queries and handling results.

Synchronous vs Asynchronous

  • sqlite3:

    sqlite3 is fully asynchronous, using callbacks, promises, or streams to handle database operations. This non-blocking approach is more suitable for high-concurrency applications, but it can introduce complexity in error handling and flow control.

  • better-sqlite3:

    better-sqlite3 is primarily synchronous, which means it executes queries in a blocking manner. This can lead to simpler code and easier error handling, but developers must be mindful of potential blocking in the event loop.

Streaming Support

  • sqlite3:

    sqlite3 supports streaming results through its API, allowing developers to process large datasets in chunks. This feature is beneficial for memory management and performance when working with large tables.

  • better-sqlite3:

    better-sqlite3 does not natively support streaming large result sets, as it retrieves all results at once. This can be a limitation for applications that need to process large datasets efficiently.

Transactions

  • sqlite3:

    sqlite3 also supports transactions, but its implementation is more complex. Developers need to manage transactions explicitly, which can lead to more intricate code, especially in error-prone scenarios.

  • better-sqlite3:

    better-sqlite3 supports transactions with a simple and straightforward API. It allows developers to easily manage transactions, including commits and rollbacks, with minimal boilerplate code.

Ease of Use: Code Examples

  • sqlite3:

    Simple Query Execution with sqlite3

    const sqlite3 = require('sqlite3').verbose();
    const db = new sqlite3.Database('my-database.db');
    db.get('SELECT * FROM users WHERE id = ?', [1], (err, row) => {
      if (err) throw err;
      console.log(row);
    });
    db.close();
    
  • better-sqlite3:

    Simple Query Execution with better-sqlite3

    const Database = require('better-sqlite3');
    const db = new Database('my-database.db');
    const row = db.prepare('SELECT * FROM users WHERE id = ?').get(1);
    console.log(row);
    

How to Choose: sqlite3 vs better-sqlite3

  • sqlite3:

    Choose sqlite3 if you need a mature, feature-rich library with robust support for asynchronous operations, streaming, and transactions. It is suitable for applications that require fine-grained control over database interactions and can handle the complexity of its API.

  • better-sqlite3:

    Choose better-sqlite3 if you prioritize performance, simplicity, and a synchronous API with optional asynchronous support. It is ideal for applications where ease of use and speed are critical, and where the synchronous nature of the API will not block the event loop excessively.

README for sqlite3

: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