JoshuaWise/ better-sqlite3
Need help with better-sqlite3?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
About the developer
2.2K Stars 
191 Forks 
MIT License 
1.2K Commits 
53 Opened issues 
Description
The fastest and simplest library for SQLite3 in Node.js.
Services available
Contributors list
Readme
better-sqlite3 
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, and extensions
- 64-bit integers (invisible until you need them)
- Worker thread support (for large/slow queries)
Help this project stay strong! 💪
better-sqlite3is 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);
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 innode-sqlite3
. -
better-sqlite3
is much faster thannode-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-sqlite3itself. However, there are some cases where
better-sqlite3could 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
- API documentation
- Performance (also see benchmark results)
- 64-bit integer support
- Worker thread support
- Unsafe mode (advanced)
- SQLite3 compilation