🌜
🌞
better-sqlite3

better-sqlite3

v7.6.2

The fastest and simplest library for SQLite3 in Node.js.

npm install better-sqlite3

README

better-sqlite3 Build Status

The fastest and simplest library for SQLite3 in Node.js.

  • Full transaction support
  • High performance, efficiency, and safety
  • Easy-to-use synchronous API (better concurrency than an asynchronous API... yes, you read that correctly)
  • Support for user-defined functions, aggregates, virtual tables, and extensions
  • 64-bit integers (invisible until you need them)
  • Worker thread support (for large/slow queries)

Help this project stay strong! 💪

better-sqlite3 is used by thousands of developers and engineers on a daily basis. Long nights and weekends were spent keeping this project strong and dependable, with no ask for compensation or funding, until now. If your company uses better-sqlite3, ask your manager to consider supporting the project:

How other libraries compare

select 1 row  get()  select 100 rows   all()   select 100 rows iterate() 1-by-1 insert 1 row run() insert 100 rows in a transaction
better-sqlite3 1x 1x 1x 1x 1x
sqlite and sqlite3 11.7x slower 2.9x slower 24.4x slower 2.8x slower 15.6x slower

You can verify these results by running the benchmark yourself.

Installation

npm install better-sqlite3

You must be using Node.js v10.20.1 or above. Prebuilt binaries are available for LTS versions. If you have trouble installing, check the troubleshooting guide.

Usage

const db = require('better-sqlite3')('foobar.db', options);

const row = db.prepare('SELECT * FROM users WHERE id = ?').get(userId);
console.log(row.firstName, row.lastName, row.email);
In ES6 module notation:
import Database from 'better-sqlite3';
const db = new Database('foobar.db', options);

Why should I use this instead of node-sqlite3?

  • node-sqlite3 uses asynchronous APIs for tasks that are either CPU-bound or serialized. That's not only bad design, but it wastes tons of resources. It also causes mutex thrashing which has devastating effects on performance.
  • node-sqlite3 exposes low-level (C language) memory management functions. better-sqlite3 does it the JavaScript way, allowing the garbage collector to worry about memory management.
  • better-sqlite3 is simpler to use, and it provides nice utilities for some operations that are very difficult or impossible in node-sqlite3.
  • better-sqlite3 is much faster than node-sqlite3 in most cases, and just as fast in all other cases.

When is this library not appropriate?

In most cases, if you're attempting something that cannot be reasonably accomplished with better-sqlite3, it probably cannot be reasonably accomplished with SQLite3 in general. For example, if you're executing queries that take one second to complete, and you expect to have many concurrent users executing those queries, no amount of asynchronicity will save you from SQLite3's serialized nature. Fortunately, SQLite3 is very very fast. With proper indexing, we've been able to achieve upward of 2000 queries per second with 5-way-joins in a 60 GB database, where each query was handling 5–50 kilobytes of real data.

If you have a performance problem, the most likely causes are inefficient queries, improper indexing, or a lack of WAL mode—not better-sqlite3 itself. However, there are some cases where better-sqlite3 could be inappropriate:

  • If you expect a high volume of concurrent reads each returning many megabytes of data (i.e., videos)
  • If you expect a high volume of concurrent writes (i.e., a social media site)
  • If your database's size is near the terabyte range

For these situations, you should probably use a full-fledged RDBMS such as PostgreSQL.

Documentation

License

MIT

Release Notes

7.6.2
By Matthew McEachen • Published on July 15, 2022

What's Changed

Full Changelog: https://github.com/WiseLibs/better-sqlite3/compare/v7.6.1...v7.6.2

7.6.1
By Matthew McEachen • Published on July 14, 2022

What's Changed

Full Changelog: https://github.com/WiseLibs/better-sqlite3/compare/v7.6.0...v7.6.1

7.6.0
By Joshua Wise • Published on July 9, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/WiseLibs/better-sqlite3/compare/v7.5.3...v7.6.0

7.5.3
By Joshua Wise • Published on May 16, 2022
7.5.2
By Joshua Wise • Published on May 15, 2022

What's Changed

Full Changelog: https://github.com/JoshuaWise/better-sqlite3/compare/v7.5.1...v7.5.2

7.5.1
By Joshua Wise • Published on April 7, 2022

What's Changed

Full Changelog: https://github.com/JoshuaWise/better-sqlite3/compare/v7.5.0...v7.5.1

7.5.0
By Joshua Wise • Published on January 19, 2022
  • Upgraded SQLite to version 3.37.2
  • added the .busy property to prepared Statements
  • added the nativeBinding option to the Database constructor
  • changed the code property of SqliteError to be enumerable
  • added SqliteError to the API documentation
  • Removed tar dependency
  • Reduced the size of installing better-sqlite3 (by using a files list in package.json)
7.4.6
By Joshua Wise • Published on December 29, 2021

What's Changed

  • Upgraded to SQLite version 3.37.0

New Contributors

Full Changelog: https://github.com/JoshuaWise/better-sqlite3/compare/v7.4.5...v7.4.6

7.4.5
By Joshua Wise • Published on November 19, 2021

What's Changed

New Contributors

Full Changelog: https://github.com/JoshuaWise/better-sqlite3/compare/v7.4.4...v7.4.5

7.4.4
By Joshua Wise • Published on October 25, 2021
  • added prebuilds for Alpine containers (looks like this failed)
  • added prebuilds for Windows 32-bit
  • fixed various installation issues

General

License
MIT
Typescript Types
Tree-shakeable
No

Popularity

GitHub Stargazers
3,469
Community Interest
2,977
Number of Forks
311

Maintenance

Commits
10/219/22030
Last Commit
Jul 15, 2022
Open Issues
68
Closed Issues
698
Open Pull Requests
9
Closed Pull Requests
41

Versions

Versions Released
10/219/2203
Latest Version Released
Current Tags
latest7.6.2

Contributors

JoshuaWise
JoshuaWise
Commits: 1,024
mceachen
mceachen
Commits: 10
vazra
vazra
Commits: 6
ceymard
ceymard
Commits: 6
danielbarela
danielbarela
Commits: 5
kdabir
kdabir
Commits: 3
Prinzhorn
Prinzhorn
Commits: 3
bengotow
bengotow
Commits: 2
paulrosania
paulrosania
Commits: 2
nikeee
nikeee
Commits: 1
shatgupt
shatgupt
Commits: 1
CarterLi
CarterLi
Commits: 1
vicb
vicb
Commits: 1
m4heshd
m4heshd
Commits: 1
tobbez
tobbez
Commits: 1