Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/glebarez/sqlite
The pure-Go SQLite driver for GORM
https://github.com/glebarez/sqlite
driver golang gorm gorm-driver gorm-orm sqlite sqlite3
Last synced: 3 months ago
JSON representation
The pure-Go SQLite driver for GORM
- Host: GitHub
- URL: https://github.com/glebarez/sqlite
- Owner: glebarez
- License: mit
- Fork: true (go-gorm/sqlite)
- Created: 2021-11-28T20:07:15.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T23:44:04.000Z (8 months ago)
- Last Synced: 2024-08-01T19:32:47.609Z (6 months ago)
- Topics: driver, golang, gorm, gorm-driver, gorm-orm, sqlite, sqlite3
- Language: Go
- Homepage:
- Size: 353 KB
- Stars: 568
- Watchers: 3
- Forks: 37
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
- my-awesome - glebarez/sqlite - driver,gorm-orm,sqlite,sqlite3 pushed_at:2024-06 star:0.7k fork:0.0k The pure-Go SQLite driver for GORM (Go)
README
[](https://hits.seeyoufarm.com)
# Pure-Go SQLite driver for GORM
Pure-go (without cgo) implementation of SQLite driver for [GORM](https://gorm.io/)
This driver has SQLite embedded, you don't need to install one separately.
# Usage
```go
import (
"github.com/glebarez/sqlite"
"gorm.io/gorm"
)
db, err := gorm.Open(sqlite.Open("sqlite.db"), &gorm.Config{})
```
### In-memory DB example
```go
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:
```go
db, err := gorm.Open(sqlite.Open(":memory:?_pragma=foreign_keys(1)"), &gorm.Config{})
```
More info: [https://www.sqlite.org/foreignkeys.html](https://www.sqlite.org/foreignkeys.html)
# FAQ
## How is this better than standard GORM SQLite driver?
The [standard GORM driver for SQLite](https://github.com/go-gorm/sqlite) has one major drawback: it is based on a [Go-bindings of SQLite C-source](https://github.com/mattn/go-sqlite3) (this is called [cgo](https://go.dev/blog/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](https://www.sqlite.org/json1.html)). 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](https://github.com/go-gorm/gorm/tree/master/tests) 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](https://github.com/glebarez/go-sqlite/tree/master/benchmark).
## Included features
- JSON1 (https://www.sqlite.org/json1.html)
- Math functions (https://www.sqlite.org/lang_mathfunc.html)