ChaiSQL is a modern embedded SQL database, focusing on flexibility and ease of use for developers.
ChaiSQL is work in progress and is not ready yet for production.
Here is a high level list of features that we want to implement in the near future, in no particular order:
Install the ChaiSQL database
go install github.com/chaisql/chai
package main
import (
"context"
"fmt"
"log"
"github.com/chaisql/chai"
)
func main() {
// Create a database instance, here we'll store everything on-disk
db, err := chai.Open("mydb")
if err != nil {
log.Fatal(err)
}
defer db.Close()
err = db.Exec(`
CREATE TABLE user (
id INT PRIMARY KEY,
name TEXT NOT NULL UNIQUE,
age INT NOT NULL,
created_at TIMESTAMP
)
`)
err = db.Exec(`INSERT INTO user (id, name, age) VALUES (1, "Jo Bloggs", 33)`)
rows, err := db.Query("SELECT id, name, age, address FROM user WHERE age >= 18")
defer rows.Close()
err = rows.Iterate(func(r *chai.Row) error {
// scan each column
var id, age int
var name string
err = r.Scan(&id, &name, &age)
// or into a struct
type User struct {
ID int
Name string
Age int
}
var u User
err = r.StructScan(&u)
// or even a map
m := make(map[string]any)
err = r.MapScan(&m)
return nil
})
}
Checkout the Go doc and the usage example in the README to get started quickly.
For in-memory operations, simply use :memory:
:
db, err := chai.Open(":memory:")
// import chai as a blank import
import _ "github.com/chaisql/chai/driver"
// Create a sql/database DB instance
db, err := sql.Open("chai", "mydb")
if err != nil {
log.Fatal(err)
}
defer db.Close()
// Then use db as usual
res, err := db.ExecContext(...)
res, err := db.Query(...)
res, err := db.QueryRow(...)
// use the driver.Scanner to scan into a struct
var u User
err = res.Scan(driver.Scanner(&u))
The chai command line provides an SQL shell for database management:
go install github.com/chaisql/chai/cmd/chai@latest
Usage example:
# For in-memory database:
chai
# For disk-based database:
chai dirName
Contributions are welcome!
A big thanks to our contributors!
Made with contrib.rocks.
For any questions or discussions, open an issue.