Skip to content

Commit 38d4254

Browse files
authored
Update README.md
1 parent c0aa734 commit 38d4254

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@
77
Go module `github.com/ncruces/go-sqlite3` wraps a [WASM](https://webassembly.org/) build of [SQLite](https://sqlite.org/),
88
and uses [wazero](https://wazero.io/) to provide `cgo`-free SQLite bindings.
99

10-
- Package [`github.com/ncruces/go-sqlite3`](https://pkg.go.dev/github.com/ncruces/go-sqlite3)
10+
- [`github.com/ncruces/go-sqlite3`](https://pkg.go.dev/github.com/ncruces/go-sqlite3)
1111
wraps the [C SQLite API](https://www.sqlite.org/cintro.html)
1212
([example usage](https://pkg.go.dev/github.com/ncruces/go-sqlite3#example-package)).
13-
- Package [`github.com/ncruces/go-sqlite3/driver`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/driver)
13+
- [`github.com/ncruces/go-sqlite3/driver`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/driver)
1414
provides a [`database/sql`](https://pkg.go.dev/database/sql) driver
1515
([example usage](https://pkg.go.dev/github.com/ncruces/go-sqlite3/driver#example-package)).
16-
- Package [`github.com/ncruces/go-sqlite3/embed`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/embed)
16+
- [`github.com/ncruces/go-sqlite3/embed`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/embed)
1717
embeds a build of SQLite into your application.
18-
- Package [`github.com/ncruces/go-sqlite3/vfs`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/vfs)
18+
- [`github.com/ncruces/go-sqlite3/vfs`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/vfs)
1919
wraps the [C SQLite VFS API](https://www.sqlite.org/vfs.html) and provides a pure Go implementation.
20-
- Package [`github.com/ncruces/go-sqlite3/vfs/memdb`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/vfs/memdb)
20+
- [`github.com/ncruces/go-sqlite3/vfs/memdb`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/vfs/memdb)
2121
implements an in-memory VFS.
22-
- Package [`github.com/ncruces/go-sqlite3/vfs/readervfs`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/vfs/readervfs)
22+
- [`github.com/ncruces/go-sqlite3/vfs/readervfs`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/vfs/readervfs)
2323
implements a VFS for immutable databases.
24-
- Package [`github.com/ncruces/go-sqlite3/ext/unicode`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/ext/unicode)
24+
- [`github.com/ncruces/go-sqlite3/ext/unicode`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/ext/unicode)
2525
registers Unicode aware functions.
26-
- Package [`github.com/ncruces/go-sqlite3/ext/stats`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/ext/stats)
26+
- [`github.com/ncruces/go-sqlite3/ext/stats`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/ext/stats)
2727
registers [statistics functions](https://www.oreilly.com/library/view/sql-in-a/9780596155322/ch04s02.html).
28-
- Package [`github.com/ncruces/go-sqlite3/gormlite`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/gormlite)
28+
- [`github.com/ncruces/go-sqlite3/gormlite`](https://pkg.go.dev/github.com/ncruces/go-sqlite3/gormlite)
2929
provides a [GORM](https://gorm.io) driver.
3030

3131
### Caveats
@@ -44,13 +44,13 @@ to always use `EXCLUSIVE` locking mode for WAL databases.
4444

4545
Because connection pooling is incompatible with `EXCLUSIVE` locking mode,
4646
to use the [`database/sql`](https://pkg.go.dev/database/sql)
47-
driver with WAL databases you should disable connection pooling by calling
47+
driver with WAL mode databases you should disable connection pooling by calling
4848
[`db.SetMaxOpenConns(1)`](https://pkg.go.dev/database/sql#DB.SetMaxOpenConns).
4949

5050
#### POSIX Advisory Locks
5151

5252
POSIX advisory locks, which SQLite uses, are
53-
[broken by design](https://www.sqlite.org/src/artifact/90c4fa?ln=1073-1161).
53+
[broken by design](https://www.sqlite.org/src/artifact/2e8b12?ln=1073-1161).
5454

5555
On Linux, macOS and illumos, this module uses
5656
[OFD locks](https://www.gnu.org/software/libc/manual/html_node/Open-File-Description-Locks.html)
@@ -72,7 +72,7 @@ it is _also_ safe to use it to access databases concurrently
7272
with _other_ implementations of SQLite.
7373

7474
On other BSDs, where this might be unsafe,
75-
[this test](https://github.com/ncruces/go-sqlite3/blob/main/vfs/lock_test.go) should fail.
75+
[this test](vfs/lock_test.go) should fail.
7676

7777
#### Testing
7878

@@ -96,7 +96,6 @@ Performance is tested by running
9696
- [x] in-memory VFS
9797
- [x] read-only VFS, wrapping an [`io.ReaderAt`](https://pkg.go.dev/io#ReaderAt)
9898
- [ ] cloud-based VFS, based on [Cloud Backed SQLite](https://sqlite.org/cloudsqlite/doc/trunk/www/index.wiki)
99-
- [ ] [MVCC](https://en.wikipedia.org/wiki/Multiversion_concurrency_control) VFS, using [BadgerDB](https://github.com/dgraph-io/badger)
10099

101100
### Alternatives
102101

0 commit comments

Comments
 (0)