Skip to content

Commit 853da35

Browse files
m4heshdJoshuaWise
andcommitted
Update verbiage of various documentation
Co-authored-by: Joshua Wise <[email protected]>
1 parent f99b832 commit 853da35

13 files changed

+53
-53
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Downloads](https://img.shields.io/npm/dt/better-sqlite3-multiple-ciphers?logo=DocuSign&logoColor=FFF&color=2757c4&style=for-the-badge)](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers)
55
[![Build status](https://img.shields.io/github/actions/workflow/status/m4heshd/better-sqlite3-multiple-ciphers/test.yml?branch=master&label=Build%2FTest&logo=github&style=for-the-badge)](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/actions/workflows/test.yml)
66

7-
The fastest and simplest library for SQLite3 in Node.js. This particular fork supports multiple-cipher encryption using [SQLite3MultipleCiphers](https://github.com/utelle/SQLite3MultipleCiphers). Check [usage](#usage) to learn more.
7+
The fastest and simplest library for SQLite in Node.js. This particular fork supports multiple-cipher encryption using [SQLite3MultipleCiphers](https://github.com/utelle/SQLite3MultipleCiphers). Check [usage](#usage) to learn more.
88

99
- Full transaction support
1010
- High performance, efficiency, and safety
@@ -158,7 +158,7 @@ uses [SQLite3MultipleCiphers](https://github.com/utelle/SQLite3MultipleCiphers)
158158

159159
#### When is this library not appropriate?
160160

161-
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.
161+
In most cases, if you're attempting something that cannot be reasonably accomplished with `better-sqlite3`, it probably cannot be reasonably accomplished with SQLite 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 SQLite's serialized nature. Fortunately, SQLite 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.
162162

163163
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:
164164

@@ -170,10 +170,10 @@ For these situations, you should probably use a full-fledged RDBMS such as [Post
170170

171171
## Upgrading
172172

173-
Upgrading your `better-sqlite3-multiple-ciphers` dependency can potentially introduce breaking changes, either in the `better-sqlite3-multiple-ciphers` API, or between your existing database(s) and the underlying version of SQLite. Before upgrading, review:
173+
Upgrading your `better-sqlite3-multiple-ciphers` dependency can potentially introduce breaking changes, either in the `better-sqlite3-multiple-ciphers` API (if you upgrade to a new [major version](https://semver.org/)), or between your existing database(s) and the underlying version of SQLite. Before upgrading, review:
174174

175-
* `better-sqlite3-multiple-ciphers` release notes: https://github.com/WiseLibs/better-sqlite3-multiple-ciphers/releases
176-
* SQLite changelog: https://www.sqlite.org/changes.html
175+
* [`better-sqlite3-multiple-ciphers` release notes](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/releases)
176+
* [SQLite release history](https://www.sqlite.org/changes.html)
177177

178178
# Documentation
179179

@@ -182,7 +182,7 @@ Upgrading your `better-sqlite3-multiple-ciphers` dependency can potentially intr
182182
- [64-bit integer support](./docs/integer.md)
183183
- [Worker thread support](./docs/threads.md)
184184
- [Unsafe mode (advanced)](./docs/unsafe.md)
185-
- [SQLite3 compilation](./docs/compilation.md)
185+
- [SQLite compilation (advanced)](./docs/compilation.md)
186186

187187
# License
188188

benchmark/drivers.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
'use strict';
22

33
/*
4-
Every benchmark trial will be executed once for each SQLite3 driver listed
4+
Every benchmark trial will be executed once for each SQLite driver listed
55
below. Each driver has a function to open a new database connection on a
66
given filename and a list of PRAGMA statements.
77
*/

binding.gyp

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ===
2-
# This is the main GYP file, which builds better-sqlite3 with SQLite3 itself.
2+
# This is the main GYP file, which builds better-sqlite3 with SQLite itself.
33
# ===
44

55
{

deps/sqlite3.gyp

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ===
2-
# This configuration defines options specific to compiling SQLite3 itself.
2+
# This configuration defines options specific to compiling SQLite itself.
33
# Compile-time options are loaded by the auto-generated file "defines.gypi".
44
# The --sqlite3 option can be provided to use a custom amalgamation instead.
55
# ===

deps/test_extension.c

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
SQLITE_EXTENSION_INIT1
33

44
/*
5-
This SQLite3 extension is used only for testing purposes (npm test).
5+
This SQLite extension is used only for testing purposes (npm test).
66
*/
77

88
static void TestExtensionFunction(sqlite3_context* pCtx, int nVal, sqlite3_value** _) {

deps/update-sqlite3mc.sh

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
#!/usr/bin/env bash
22

33
# ===
4-
# This script defines and generates the bundled SQLite3 unit (sqlite3.c).
4+
# This script defines and generates the bundled SQLite unit (sqlite3.c).
55
#
66
# The following steps are taken:
77
# 1. populate the shell environment with the defined compile-time options.
8-
# 2. download and extract the SQLite3 source code into a temporary directory.
8+
# 2. download and extract the SQLite source code into a temporary directory.
99
# 3. run "sh configure" and "make sqlite3.c" within the source directory.
10-
# 4. clone the SQLite3MultipleCiphers repo, replace SQLite3 amalgamation and patch it.
10+
# 4. clone the SQLite3MultipleCiphers repo, replace SQLite amalgamation and patch it.
1111
# 5. build the SQLite3MultipleCiphers amalgamation
1212
# 6. copy the generated amalgamation into the output directory (./sqlite3).
1313
# 7. export the defined compile-time options to a gyp file (./defines.gypi).
@@ -76,17 +76,17 @@ mkdir -p "$TEMP"
7676
mkdir -p "$OUTPUT"
7777
export CFLAGS=`echo $(echo "$DEFINES" | sed -e "/^\s*$/d" -e "s/^/-D/")`
7878

79-
echo -e "\nDownloading SQLite3 source..."
79+
echo -e "\nDownloading SQLite source..."
8080
curl -#f "https://www.sqlite.org/$YEAR/sqlite-src-$VERSION.zip" > "$TEMP/source.zip" || exit 1
8181

82-
echo -e "\nExtracting SQLite3 source..."
82+
echo -e "\nExtracting SQLite source..."
8383
unzip "$TEMP/source.zip" -d "$TEMP" > /dev/null || exit 1
8484
cd "$TEMP/sqlite-src-$VERSION" || exit 1
8585

86-
echo -e "\nConfiguring SQLite3 amalgamation..."
86+
echo -e "\nConfiguring SQLite amalgamation..."
8787
sh configure > /dev/null || exit 1
8888

89-
echo -e "\nBuilding SQLite3 amalgamation..."
89+
echo -e "\nBuilding SQLite amalgamation..."
9090
make OPTIONS="$CFLAGS" sqlite3.c > /dev/null || exit 1
9191

9292
echo -e "\nCloning SQLite3MultipleCiphers repo..."
@@ -95,11 +95,11 @@ git clone --quiet https://github.com/utelle/SQLite3MultipleCiphers.git > /dev/nu
9595
cd "$TEMP/SQLite3MultipleCiphers" || exit 1
9696
git checkout --quiet "tags/$SQLITE3MC_VERSION" > /dev/null || exit 1
9797

98-
echo -e "\nReplacing SQLite3 amalgamation in SQLite3MultipleCiphers..."
98+
echo -e "\nReplacing SQLite amalgamation in SQLite3MultipleCiphers..."
9999
cd "$TEMP/sqlite-src-$VERSION" || exit 1
100100
(yes | cp -rf sqlite3.c sqlite3.h sqlite3ext.h "$TEMP/SQLite3MultipleCiphers/src") || exit 1
101101

102-
echo -e "\nPatching SQLite3 amalgamation in SQLite3MultipleCiphers..."
102+
echo -e "\nPatching SQLite amalgamation in SQLite3MultipleCiphers..."
103103
cd "$TEMP/SQLite3MultipleCiphers" || exit 1
104104
chmod +x ./scripts/patchsqlite3.sh || exit 1
105105
chmod +x ./scripts/rekeyvacuum.sh || exit 1
@@ -137,4 +137,4 @@ echo -e "\nCleaning up..."
137137
cd - > /dev/null || exit 1
138138
rm -rf "$TEMP"
139139

140-
echo -e "\nSQLite3MC update process completed!"
140+
echo -e "\nSQLite3MultipleCiphers update process completed!"

0 commit comments

Comments
 (0)