Skip to content

Commit a153589

Browse files
charlieviethcharlievieth
committed
README: explain fork and add benchmarks
1 parent 2384c5b commit a153589

File tree

1 file changed

+112
-2
lines changed

1 file changed

+112
-2
lines changed

‎README.md

+112-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,119 @@ go-sqlite3
77
[![codecov](https://codecov.io/gh/mattn/go-sqlite3/branch/master/graph/badge.svg)](https://codecov.io/gh/mattn/go-sqlite3)
88
[![Go Report Card](https://goreportcard.com/badge/github.com/charlievieth/go-sqlite3)](https://goreportcard.com/report/github.com/charlievieth/go-sqlite3)
99

10-
Latest stable version is v1.14 or later, not v2.
10+
# Note
1111

12-
~~**NOTE:** The increase to v2 was an accident. There were no major changes or features.~~
12+
This a fork of [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3/)
13+
that aims to be faster and more accurate. Performance wise, this library is
14+
about ~30% faster across the board, but significantly faster
15+
at calls to Exec (especially without args), and uses significantly less memory
16+
for all calls. Regarding accuracy, this library will return an error if a Query
17+
contains multiple SQL statements whereas the mattn/go-sqlite3 library will
18+
execute all of them, but only give you the results of the last SQL statement.
19+
20+
Ideally, this fork would not exist, but given the challenge of getting PRs
21+
reviewed in the mainline repo I had no other alternative. Below are some of
22+
the PRs that I'd like to get merged into the mainline repo:
23+
24+
* https://github.com/mattn/go-sqlite3/pull/1308
25+
* https://github.com/mattn/go-sqlite3/pull/1303
26+
* https://github.com/mattn/go-sqlite3/pull/1302
27+
* https://github.com/mattn/go-sqlite3/pull/1296
28+
* https://github.com/mattn/go-sqlite3/pull/1295
29+
* https://github.com/mattn/go-sqlite3/pull/1293
30+
* https://github.com/mattn/go-sqlite3/pull/1291
31+
32+
<details>
33+
<summary>Benchmarks</summary>
34+
35+
36+
Benchmarks are between [github.com/mattn/[email protected]](https://github.com/mattn/go-sqlite3/releases/tag/v1.14.24)
37+
and [github.com/charlievieth/go-sqlite3@2384c5b4ce](https://github.com/charlievieth/go-sqlite3/commit/2384c5b4cea23296d757a644315df113893db995).
38+
39+
```
40+
41+
goos: darwin
42+
goarch: arm64
43+
pkg: github.com/charlievieth/sqlite3-bench
44+
cpu: Apple M4 Pro
45+
│ base.10.txt │ new.10.txt │
46+
│ sec/op │ sec/op vs base │
47+
Suite/BenchmarkExec/Params-14 939.9n ± 0% 747.5n ± 1% -20.47% (p=0.000 n=10)
48+
Suite/BenchmarkExec/NoParams-14 845.8n ± 1% 533.3n ± 1% -36.94% (p=0.000 n=10)
49+
Suite/BenchmarkExecContext/Params-14 1.919µ ± 0% 1.582µ ± 2% -17.58% (p=0.000 n=10)
50+
Suite/BenchmarkExecContext/NoParams-14 1.754µ ± 1% 1.550µ ± 1% -11.63% (p=0.000 n=10)
51+
Suite/BenchmarkExecStep-14 1257.1µ ± 0% 465.0µ ± 2% -63.01% (p=0.000 n=10)
52+
Suite/BenchmarkExecContextStep-14 2231.2µ ± 1% 463.3µ ± 1% -79.24% (p=0.000 n=10)
53+
Suite/BenchmarkExecTx-14 2.864µ ± 1% 1.649µ ± 2% -42.44% (p=0.000 n=10)
54+
Suite/BenchmarkQuery-14 2.401µ ± 0% 1.850µ ± 1% -22.95% (p=0.000 n=10)
55+
Suite/BenchmarkQuerySimple-14 1.419µ ± 0% 1.049µ ± 1% -26.05% (p=0.000 n=10)
56+
Suite/BenchmarkQueryContext/Background-14 2.518µ ± 0% 2.409µ ± 2% -4.35% (p=0.001 n=10)
57+
Suite/BenchmarkQueryContext/WithCancel-14 9.099µ ± 2% 8.502µ ± 2% -6.56% (p=0.000 n=10)
58+
Suite/BenchmarkParams-14 2.662µ ± 1% 2.059µ ± 1% -22.64% (p=0.000 n=10)
59+
Suite/BenchmarkStmt-14 1.692µ ± 0% 1.441µ ± 1% -14.86% (p=0.000 n=10)
60+
Suite/BenchmarkRows-14 78.24µ ± 2% 53.30µ ± 3% -31.88% (p=0.000 n=10)
61+
Suite/BenchmarkStmtRows-14 76.93µ ± 1% 51.68µ ± 1% -32.82% (p=0.000 n=10)
62+
Suite/BenchmarkStmt10Cols-14 6.108µ ± 1% 4.491µ ± 1% -26.47% (p=0.000 n=10)
63+
Suite/BenchmarkScanRawBytes-14 3.633µ ± 1% 2.517µ ± 1% -30.73% (p=0.000 n=10)
64+
Suite/BenchmarkQueryParallel-14 1770.0n ± 2% 488.4n ± 2% -72.41% (p=0.000 n=10)
65+
Suite/BenchmarkOpen-14 15.84µ ± 1% 13.05µ ± 1% -17.65% (p=0.000 n=10)
66+
Suite/BenchmarkNamedParams-14 2.636µ ± 1% 1.229µ ± 1% -53.40% (p=0.000 n=10)
67+
Suite/BenchmarkParseTime-14 15.005µ ± 1% 8.269µ ± 1% -44.90% (p=0.000 n=10)
68+
geomean 7.235µ 4.599µ -36.44%
69+
70+
│ base.10.txt │ new.10.txt │
71+
│ B/op │ B/op vs base │
72+
Suite/BenchmarkExec/Params-14 248.0 ± 0% 216.0 ± 0% -12.90% (p=0.000 n=10)
73+
Suite/BenchmarkExec/NoParams-14 128.00 ± 0% 64.00 ± 0% -50.00% (p=0.000 n=10)
74+
Suite/BenchmarkExecContext/Params-14 408.0 ± 0% 375.5 ± 0% -7.97% (p=0.000 n=10)
75+
Suite/BenchmarkExecContext/NoParams-14 288.0 ± 0% 208.0 ± 0% -27.78% (p=0.000 n=10)
76+
Suite/BenchmarkExecStep-14 5406668.00 ± 0% 64.00 ± 0% -100.00% (p=0.000 n=10)
77+
Suite/BenchmarkExecContextStep-14 5566784.0 ± 0% 208.0 ± 0% -100.00% (p=0.000 n=10)
78+
Suite/BenchmarkExecTx-14 712.0 ± 0% 520.0 ± 0% -26.97% (p=0.000 n=10)
79+
Suite/BenchmarkQuery-14 688.0 ± 0% 656.0 ± 0% -4.65% (p=0.000 n=10)
80+
Suite/BenchmarkQuerySimple-14 456.0 ± 0% 456.0 ± 0% ~ (p=1.000 n=10) ¹
81+
Suite/BenchmarkQueryContext/Background-14 400.0 ± 0% 396.0 ± 0% -1.00% (p=0.000 n=10)
82+
Suite/BenchmarkQueryContext/WithCancel-14 2.374Ki ± 0% 1.016Ki ± 0% -57.22% (p=0.000 n=10)
83+
Suite/BenchmarkParams-14 1104.0 ± 0% 800.0 ± 0% -27.54% (p=0.000 n=10)
84+
Suite/BenchmarkStmt-14 920.0 ± 0% 784.0 ± 0% -14.78% (p=0.000 n=10)
85+
Suite/BenchmarkRows-14 9.305Ki ± 0% 6.062Ki ± 0% -34.84% (p=0.000 n=10)
86+
Suite/BenchmarkStmtRows-14 9.289Ki ± 0% 6.055Ki ± 0% -34.82% (p=0.000 n=10)
87+
Suite/BenchmarkStmt10Cols-14 992.0 ± 0% 712.0 ± 0% -28.23% (p=0.000 n=10)
88+
Suite/BenchmarkScanRawBytes-14 8776.0 ± 0% 592.0 ± 0% -93.25% (p=0.000 n=10)
89+
Suite/BenchmarkQueryParallel-14 592.0 ± 0% 548.0 ± 0% -7.43% (p=0.000 n=10)
90+
Suite/BenchmarkOpen-14 968.0 ± 0% 111.0 ± 1% -88.53% (p=0.000 n=10)
91+
Suite/BenchmarkNamedParams-14 664.0 ± 0% 600.0 ± 0% -9.64% (p=0.000 n=10)
92+
Suite/BenchmarkParseTime-14 4.117Ki ± 0% 1.713Ki ± 0% -58.40% (p=0.000 n=10)
93+
geomean 2.222Ki 505.5 -77.78%
94+
¹ all samples are equal
95+
96+
│ base.10.txt │ new.10.txt │
97+
│ allocs/op │ allocs/op vs base │
98+
Suite/BenchmarkExec/Params-14 10.000 ± 0% 8.000 ± 0% -20.00% (p=0.000 n=10)
99+
Suite/BenchmarkExec/NoParams-14 7.000 ± 0% 4.000 ± 0% -42.86% (p=0.000 n=10)
100+
Suite/BenchmarkExecContext/Params-14 12.00 ± 0% 10.00 ± 0% -16.67% (p=0.000 n=10)
101+
Suite/BenchmarkExecContext/NoParams-14 9.000 ± 0% 6.000 ± 0% -33.33% (p=0.000 n=10)
102+
Suite/BenchmarkExecStep-14 7000.000 ± 0% 4.000 ± 0% -99.94% (p=0.000 n=10)
103+
Suite/BenchmarkExecContextStep-14 9001.000 ± 0% 6.000 ± 0% -99.93% (p=0.000 n=10)
104+
Suite/BenchmarkExecTx-14 27.00 ± 0% 18.00 ± 0% -33.33% (p=0.000 n=10)
105+
Suite/BenchmarkQuery-14 23.00 ± 0% 22.00 ± 0% -4.35% (p=0.000 n=10)
106+
Suite/BenchmarkQuerySimple-14 14.00 ± 0% 13.00 ± 0% -7.14% (p=0.000 n=10)
107+
Suite/BenchmarkQueryContext/Background-14 12.00 ± 0% 10.00 ± 0% -16.67% (p=0.000 n=10)
108+
Suite/BenchmarkQueryContext/WithCancel-14 38.00 ± 0% 26.00 ± 0% -31.58% (p=0.000 n=10)
109+
Suite/BenchmarkParams-14 27.00 ± 0% 23.00 ± 0% -14.81% (p=0.000 n=10)
110+
Suite/BenchmarkStmt-14 25.00 ± 0% 23.00 ± 0% -8.00% (p=0.000 n=10)
111+
Suite/BenchmarkRows-14 525.0 ± 0% 418.0 ± 0% -20.38% (p=0.000 n=10)
112+
Suite/BenchmarkStmtRows-14 524.0 ± 0% 418.0 ± 0% -20.23% (p=0.000 n=10)
113+
Suite/BenchmarkStmt10Cols-14 39.00 ± 0% 19.00 ± 0% -51.28% (p=0.000 n=10)
114+
Suite/BenchmarkScanRawBytes-14 28.00 ± 0% 18.00 ± 0% -35.71% (p=0.000 n=10)
115+
Suite/BenchmarkQueryParallel-14 16.00 ± 0% 15.00 ± 0% -6.25% (p=0.000 n=10)
116+
Suite/BenchmarkOpen-14 33.000 ± 0% 3.000 ± 0% -90.91% (p=0.000 n=10)
117+
Suite/BenchmarkNamedParams-14 15.00 ± 0% 13.00 ± 0% -13.33% (p=0.000 n=10)
118+
Suite/BenchmarkParseTime-14 124.00 ± 0% 64.00 ± 0% -48.39% (p=0.000 n=10)
119+
geomean 49.44 17.04 -65.52%
120+
121+
```
122+
</details>
13123

14124
# Description
15125

0 commit comments

Comments
 (0)