You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The fastest and simplest library for SQLite3 in Node.js.
15
15
|better-sqlite3|1x|1x|1x|1x|1x|
16
16
|[sqlite](https://www.npmjs.com/package/sqlite) and [sqlite3](https://www.npmjs.com/package/sqlite3)|10.4x slower|2.2x slower|18.8x slower|2.8x slower|12.9x slower|
17
17
18
-
> You can verify these results by [running the benchmark yourself](./benchmark.md).
18
+
> You can verify these results by [running the benchmark yourself](./docs/benchmark.md).
19
19
> *Both [npm/sqlite](https://www.npmjs.com/package/sqlite) and [npm/sqlite3](https://www.npmjs.com/package/sqlite3) have nearly identical performance because they both use the [same engine](https://github.com/mapbox/node-sqlite3).*
20
20
21
21
## Installation
@@ -24,7 +24,7 @@ The fastest and simplest library for SQLite3 in Node.js.
24
24
npm install --save better-sqlite3
25
25
```
26
26
27
-
> If you have trouble installing, check the [troubleshooting guide](./troubleshooting.md).
27
+
> If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
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.
48
48
49
-
If you have a performance problem, the most likely causes are inefficient queries, improper indexing, or a lack of [WAL mode](./performance.md)—not `better-sqlite3` itself. However, there are some cases where `better-sqlite3` could be inappropriate:
49
+
If you have a performance problem, the most likely causes are inefficient queries, improper indexing, or a lack of [WAL mode](./docs/performance.md)—not `better-sqlite3` itself. However, there are some cases where `better-sqlite3` could be inappropriate:
50
50
51
51
- If you expect a high volume of concurrent reads each returning hundreds of megabytes of data (i.e., videos)
52
52
- If you expect a high volume of concurrent writes (i.e., a social media site)
@@ -56,11 +56,11 @@ For these situations, you should probably use a full-fledged RDBMS such as [Post
56
56
57
57
# Documentation
58
58
59
-
-[API documentation](./api.md)
60
-
-[Performance](./performance.md) (also see [benchmark results](./benchmark.md))
61
-
-[64-bit integer support](./integer.md)
62
-
-[SQLite3 compilation](./compilation.md)
59
+
-[API documentation](./docs/api.md)
60
+
-[Performance](./docs/performance.md) (also see [benchmark results](./docs/benchmark.md))
0 commit comments