chai

package module
v0.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 5, 2025 License: MIT Imports: 5 Imported by: 4

README

ChaiSQL

ChaiSQL is a modern embedded SQL database, written in pure Go, with a PostgreSQL-inspired API. It’s designed for developers who want the familiarity of Postgres with the simplicity of an embedded database.

Build Status go.dev reference Status

✨ Highlights

  • Postgres-like SQL – the syntax you already know, embedded in your Go app.
  • Pure Go – no CGO or external dependencies.
  • Flexible Storage – keep data on disk or run fully in-memory.
  • Built on Pebble – powered by CockroachDB’s Pebble engine.

🔎 Current Capabilities

ChaiSQL already supports a useful core of SQL features, including:

  • Creating and dropping tables & indexes (with composite indexes)
  • Inserting, updating, deleting rows
  • Basic SELECT queries with filtering, ordering, grouping
  • DISTINCT, UNION / UNION ALL

👉 Joins and many advanced features are not implemented yet. The goal is steady growth toward broader PostgreSQL compatibility, but today ChaiSQL is best suited for simpler schemas and embedded use cases.

🗺 Roadmap

ChaiSQL is still in active development and not production-ready. Planned milestones include:

  • Finalize stable on-disk storage format (90% complete)
  • Broader SQL-92 coverage
  • Drivers for other languages (JS/TS, Python, …)
  • RocksDB backend support
  • Compatibility with PostgreSQL drivers/ORMs

Installation

Install the ChaiSQL driver and CLI:

go install github.com/chaisql/chai@latest
go install github.com/chaisql/chai/cmd/chai@latest

Quickstart

Here’s a simple Go example that creates a table, inserts rows, and queries them:

package main

import (
    "database/sql"
    "fmt"
    "log"

    _ "github.com/chaisql/chai"
)

func main() {
    // Open an on-disk database called "mydb"
    db, err := sql.Open("chai", "mydb")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()

    // Create schema
    _, err = db.Exec(`
        CREATE TABLE users (
            id          INTEGER PRIMARY KEY,
            name        TEXT NOT NULL UNIQUE,
            email       TEXT NOT NULL,
            age         INT  NOT NULL,
            created_at  TIMESTAMP DEFAULT CURRENT_TIMESTAMP
        );
    `)
    if err != nil {
        log.Fatal(err)
    }

    // Insert some data
    _, err = db.Exec(`
        INSERT INTO users (id, name, email, age)
        VALUES
            (1, 'Alice', 'alice@example.com', 30),
            (2, 'Bob',   'bob@example.com',   25),
            (3, 'Carol', 'carol@example.com', 40);
    `)
    if err != nil {
        log.Fatal(err)
    }

    // Query active adults
    rows, err := db.Query(`
        SELECT id, name, email, age
        FROM users
        WHERE age >= 18
        ORDER BY age DESC
    `)
    if err != nil {
        log.Fatal(err)
    }
    defer rows.Close()

    for rows.Next() {
        var id, age int
        var name, email string
        if err := rows.Scan(&id, &name, &email, &age); err != nil {
            log.Fatal(err)
        }
        fmt.Printf("User %d: %s (%s), %d years old\n", id, name, email, age)
    }
}
In-memory Database

For ephemeral databases, just use :memory::

db, err := sql.Open("chai", ":memory:")

Chai shell

The chai command-line tool provides an interactive SQL shell:

# In-memory database:
chai

# Disk-based database:
chai dirName

Contributing

Contributions are welcome!

A big thanks to our contributors!

Made with contrib.rocks.

For any questions or discussions, open an issue.

❓ FAQ

Why not just use SQLite?

SQLite is fantastic, but it has its own SQL dialect. ChaiSQL is designed for PostgreSQL compatibility, so it feels familiar if you already use Postgres.

Is it production-ready?

Not yet. We’re actively building out SQL support and stability.

Can I use existing Postgres tools?

Not yet. ChaiSQL is PostgreSQL-API inspired, but it does not speak the Postgres wire protocol and is not compatible with psql, pg_dump, or drivers that expect a Postgres server.

Documentation

Overview

Example
package main

import (
	"database/sql"
	"fmt"

	_ "github.com/chaisql/chai"
)

type User struct {
	ID   int64
	Name string
	Age  uint32
}

func main() {
	// Create a database instance, here we'll store everything in memory
	db, err := sql.Open("chai", ":memory:")
	if err != nil {
		panic(err)
	}
	defer db.Close()

	// Create a table.
	_, err = db.Exec("CREATE TABLE user (id int primary key, name text, age int)")
	if err != nil {
		panic(err)
	}

	// Create an index.
	_, err = db.Exec("CREATE INDEX idx_user_name ON user (name)")
	if err != nil {
		panic(err)
	}

	// Insert some data
	_, err = db.Exec("INSERT INTO user (id, name, age) VALUES ($1, $2, $3)", 10, "foo", 15)
	if err != nil {
		panic(err)
	}

	// Query some rows
	rows, err := db.Query("SELECT * FROM user WHERE id > $1", 1)
	if err != nil {
		panic(err)
	}
	// always close the result when you're done with it
	defer rows.Close()

	for rows.Next() {
		var u User

		err := rows.Scan(&u.ID, &u.Name, &u.Age)
		if err != nil {
			panic(err)
		}

		fmt.Println(u)
	}
	if err := rows.Err(); err != nil {
		panic(err)
	}

}
Output:

{10 foo 15}

Index

Examples

Constants

This section is empty.

Variables

View Source
var IsNotFoundError = errs.IsNotFoundError

IsNotFoundError determines if the given error is a NotFoundError. NotFoundError is returned when the requested table, index, object or sequence doesn't exist.

Functions

func IsAlreadyExistsError

func IsAlreadyExistsError(err error) bool

IsAlreadyExistsError determines if the error is returned as a result of a conflict when attempting to create a table, an index, an row or a sequence with a name that is already used by another resource.

Types

This section is empty.

Directories

Path Synopsis
cmd
chai module
internal
database
Package database provides database primitives such as tables, transactions and indexes.
Package database provides database primitives such as tables, transactions and indexes.
expr/glob
Package glob implements wildcard pattern matching algorithms for strings.
Package glob implements wildcard pattern matching algorithms for strings.
kv
row

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL