Skip to content

Commit 3b2d6ce

Browse files
committed
fix(docs): sqlite is deprecated
1 parent 30f50bb commit 3b2d6ce

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

benchmark/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The performance of @photostructure/sqlite is quite similar to node:sqlite and be
1010

1111
- **@photostructure/sqlite** - This package
1212
- **better-sqlite3** - Popular synchronous SQLite3 binding
13-
- **sqlite3** - Classic asynchronous SQLite3 binding
13+
- **sqlite3** - Classic asynchronous SQLite3 binding ([deprecated](https://github.com/TryGhost/node-sqlite3/pull/1844))
1414
- **node:sqlite** - Node.js built-in SQLite (when available)
1515

1616
## Installation
@@ -119,7 +119,7 @@ tsx --expose-gc memory-benchmark.ts --scenarios blob-handling
119119
120120
The benchmark outputs clean markdown tables that can be directly copied into documentation:
121121
122-
### 📈 Summary
122+
### Summary
123123
124124
| Scenario | @photostructure/sqlite | better-sqlite3 | node:sqlite | sqlite3 |
125125
| --------------------- | ---------------------: | -------------: | ------------: | -----------: |
@@ -133,14 +133,14 @@ The benchmark outputs clean markdown tables that can be directly copied into doc
133133
| UPDATE with Index | 750 ops/s | 720 ops/s | 740 ops/s | 720 ops/s |
134134
| DELETE Bulk | 89 ops/s | 90 ops/s | 83 ops/s | 25 ops/s |
135135
136-
### 🏆 Overall Performance Ranking
136+
### Overall performance ranking
137137
138138
| Rank | Driver | Score |
139139
| ---: | ---------------------- | ----: |
140-
| 1 🥇 | better-sqlite3 | 99% |
141-
| 2 🥈 | @photostructure/sqlite | 94% |
142-
| 3 🥉 | node:sqlite | 94% |
143-
| 4 🐌 | sqlite3 | 58% |
140+
| 1 | better-sqlite3 | 99% |
141+
| 2 | @photostructure/sqlite | 94% |
142+
| 3 | node:sqlite | 94% |
143+
| 4 | sqlite3 | 58% |
144144
145145
Key features:
146146
@@ -154,26 +154,26 @@ Key features:
154154
Memory benchmarks also output markdown-ready tables:
155155
156156
```
157-
💾 SQLite Driver Memory Benchmark
157+
SQLite Driver Memory Benchmark
158158

159-
📊 Testing @photostructure/sqlite
159+
Testing @photostructure/sqlite
160160

161161
Statement Prepare/Finalize: Tests for memory leaks in statement lifecycle
162-
No memory leak detected
162+
OK - No memory leak detected
163163
Heap growth: 0.12 KB/iteration (R²=0.045)
164164
External growth: 0.00 KB/iteration (R²=0.001)
165165

166-
📈 Summary
166+
Summary
167167

168-
| Scenario | @photostructure/sqlite | better-sqlite3 | node:sqlite | sqlite3 |
169-
|---|---|---|---|---|
170-
| Statement Prepare/Finalize | ✓ OK | ✓ OK | ✓ OK | ✓ OK |
171-
| Large Result Sets | ✓ OK | ✓ OK | ✓ OK | ✓ OK |
172-
| BLOB Memory Management | ✓ OK | ✓ OK | ✓ OK | ✓ OK |
173-
174-
📋 Memory table generated above - copy/paste ready for documentation!
168+
| Scenario | @photostructure/sqlite | better-sqlite3 | node:sqlite | sqlite3 |
169+
| -------------------------- | ---------------------- | -------------- | ----------- | ------- |
170+
| Statement Prepare/Finalize | OK | OK | OK | OK |
171+
| Large Result Sets | OK | OK | OK | OK |
172+
| BLOB Memory Management | OK | OK | OK | OK |
175173
```
176174
175+
Memory table generated above - copy/paste ready for documentation!
176+
177177
Features:
178178
179179
- **Leak detection**: Automatically identifies potential memory leaks (>1KB/iteration growth)
@@ -203,7 +203,7 @@ The benchmark system automatically calibrates iteration counts and scales result
203203
204204
## Notes
205205
206-
- **sqlite3 Performance**: The sqlite3 driver shows lower performance in synchronous-style benchmarks because it's inherently asynchronous.
206+
- **sqlite3 Performance**: The sqlite3 driver shows lower performance in synchronous-style benchmarks because it's inherently asynchronous. Note: sqlite3 is [deprecated and unmaintained](https://github.com/TryGhost/node-sqlite3/pull/1844) since December 2025.
207207
- **Memory Testing**: Always run memory benchmarks with `--expose-gc` for accurate garbage collection control.
208208
- **Real-world Performance**: These benchmarks test specific patterns. Real application performance depends on your specific use case.
209209

0 commit comments

Comments
 (0)