5.2 KiB
Go bindings to SQLite using wazero
Go module github.com/ncruces/go-sqlite3 is a cgo-free SQLite wrapper.
It provides a database/sql compatible driver,
as well as direct access to most of the C SQLite API.
It wraps a Wasm build of SQLite,
and uses wazero as the runtime.
Go, wazero and x/sys are the only runtime dependencies.
Getting started
Using the database/sql driver:
import "database/sql"
import _ "github.com/ncruces/go-sqlite3/driver"
import _ "github.com/ncruces/go-sqlite3/embed"
var version string
db, _ := sql.Open("sqlite3", "file:demo.db")
db.QueryRow(`SELECT sqlite_version()`).Scan(&version)
Packages
github.com/ncruces/go-sqlite3wraps the C SQLite API (example usage).github.com/ncruces/go-sqlite3/driverprovides adatabase/sqldriver (example usage).github.com/ncruces/go-sqlite3/embedembeds a build of SQLite into your application.github.com/ncruces/go-sqlite3/vfswraps the C SQLite VFS API and provides a pure Go implementation.github.com/ncruces/go-sqlite3/gormliteprovides a GORM driver.
Advanced features
- incremental BLOB I/O
- nested transactions
- custom functions
- virtual tables
- custom VFSes
- online backup
- JSON support
- math functions
- full-text search
- geospatial search
- Unicode support
- statistics functions
- encryption at rest
- many extensions
- custom VFSes
- and more…
Caveats
This module replaces the SQLite OS Interface (aka VFS) with a pure Go implementation, which has advantages and disadvantages.
Read more about the Go VFS design here.
Testing
This project aims for high test coverage. It also benefits greatly from SQLite's and wazero's thorough testing.
Every commit is tested on Linux (amd64/arm64/386/riscv64/ppc64le/s390x), macOS (amd64/arm64), Windows (amd64), FreeBSD (amd64), OpenBSD (amd64), NetBSD (amd64), DragonFly BSD (amd64), illumos (amd64), and Solaris (amd64).
The Go VFS is tested by running SQLite's mptest.
Performance
Perfomance of the database/sql driver is
competitive with alternatives.
The Wasm and VFS layers are also tested by running SQLite's speedtest1.
FAQ, issues, new features
For questions, please see Discussions.
Also, post there if you used this driver for something interesting ("Show and tell"), have an idea…
The Issue tracker is for bugs we want fixed, and features we're working on, planning to work on, or asking for help with.