Pure-Go SQLite driver for GORM

Pure-go (without cgo) implementation of SQLite driver for GORM

This driver has SQLite embedded, you don't need to install one separately.

Usage

import (
  "github.com/glebarez/sqlite"
  "gorm.io/gorm"
)

db, err := gorm.Open(sqlite.Open("sqlite.db"), &gorm.Config{})

In-memory DB example

db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})

Foreign-key constraint activation

Foreign-key constraint is disabled by default in SQLite. To activate it, use connection URL parameter:

db, err := gorm.Open(sqlite.Open(":memory:?_pragma=foreign_keys(1)"), &gorm.Config{})

More info: https://www.sqlite.org/foreignkeys.html

Upstream parity

This driver tracks go-gorm/sqlite. The last upstream commit merged here is 525c431. Upstream behaviour fixes get ported, so migration and DDL parsing behave the same on both drivers.

Three differences are deliberate and stay:

• the SQLite backend is pure-Go, so the driver imports github.com/glebarez/go-sqlite and modernc.org/sqlite rather than github.com/mattn/go-sqlite3
• DriverName defaults to sqlite, not upstream's sqlite3
• Translate reads the SQLite extended result code off the driver error, rather than marshalling the error to JSON and matching on field names

Anything that does not depend on the backend goes upstream first and comes back here as a port. First one: go-gorm/sqlite#247.

FAQ

How is this better than standard GORM SQLite driver?

The standard GORM driver for SQLite has one major drawback: it is based on a Go-bindings of SQLite C-source (this is called cgo). This fact imposes following restrictions on Go developers:

• to build and run your code, you will need a C compiler installed on a machine
• SQLite has many features that need to be enabled at compile time (e.g. json support). If you plan to use those, you will have to include proper build tags for every go command to work properly (go run, go test, etc.).
• Because of C-compiler requirement, you can't build your Go code inside tiny stripped containers like (golang-alpine)
• Building on GCP is not possible because Google Cloud Platform does not allow gcc to be executed.

Instead, this driver is based on pure-Go implementation of SQLite (https://gitlab.com/cznic/sqlite), which is basically an original SQLite C-source AST, translated into Go! So, you may be sure you're using the original SQLite implementation under the hood.

Is this tested good ?

Yes, The CI pipeline of this driver employs whole test base of GORM, which includes more than 12k tests (see badge on the page-top). Testing is run against latest major releases of Go:

• 1.18
• 1.19

In following environments:

• Linux
• Windows
• MacOS

Is it fast?

Well, it's slower than CGo implementation, but not terribly. See the bechmark of underlying pure-Go driver vs CGo implementation.

Included features

• JSON1 (https://www.sqlite.org/json1.html)
• Math functions (https://www.sqlite.org/lang_mathfunc.html)