goSqlite

[!NOTE] This README was generated by Claude Code, get the ZH version from here.

go-sqlite

Lightweight SQLite ORM built on sqlite3 driver and database/sql, featuring a consistent API with go-mysql.

Table of Contents

• Features
• Installation
• Usage
• API Reference
• License
• Author
• Stars

Features

• Connection Pool Management: Support multiple database connection pools, managed by key
• Builder Pattern: Chainable SQL query construction with Select/Where/Join/OrderBy/Limit/Offset
• Complete CRUD Operations:
  • Insert series: Support conflict handling strategies (Ignore/Replace/Abort/Fail/Rollback)
  • Update series: Support Increase/Decrease/Toggle atomic operations
  • Select series: Support First/Count/Total extended queries
• Where Conditions: Eq/NotEq/Gt/Lt/Ge/Le/In/NotIn/Null/NotNull/Between methods
• Context Support: All major operations provide Context versions for timeout and cancellation
• Auto State Clearing: Builder state automatically resets after each query execution
• SQL Injection Protection: Built-in column name validation and parameterized queries

Installation

go get github.com/pardnchiu/go-sqlite

Usage

Initialize Connection

package main

import (
    goSqlite "github.com/pardnchiu/go-sqlite"
)

func main() {
    // Create database connection
    db, err := goSqlite.New(goSqlite.Config{
        Key:      "main",           // Connection pool key (optional, defaults to filename)
        Path:     "./data.db",      // Database path
        Lifetime: 3600,             // Connection lifetime in seconds
    })
    if err != nil {
        panic(err)
    }
    defer db.Close()
}

Create Table

builder, _ := db.DB("main")

err := builder.Table("users").Create(
    goSqlite.Column{Name: "id", Type: "INTEGER", IsPrimary: true, AutoIncrease: true},
    goSqlite.Column{Name: "name", Type: "TEXT", IsNullable: false},
    goSqlite.Column{Name: "email", Type: "TEXT", IsUnique: true},
    goSqlite.Column{Name: "age", Type: "INTEGER", Default: 0},
    goSqlite.Column{Name: "is_active", Type: "INTEGER", Default: 1},
)

Insert Data

// Basic insert
err := builder.Table("users").Insert(map[string]any{
    "name":  "John",
    "email": "john@example.com",
    "age":   25,
})

// Insert and get ID
id, err := builder.Table("users").InsertReturningID(map[string]any{
    "name":  "Jane",
    "email": "jane@example.com",
})

// Conflict handling
err = builder.Table("users").InsertConflict(goSqlite.Ignore, map[string]any{
    "name":  "John",
    "email": "john@example.com",
})

Query Data

// Query multiple rows
rows, err := builder.Table("users").
    Select("id", "name", "email").
    WhereGt("age", 18).
    OrderBy("name", goSqlite.Asc).
    Limit(10).
    Get()

// Query single row
row, err := builder.Table("users").
    WhereEq("id", 1).
    First()

// Count rows
count, err := builder.Table("users").
    WhereEq("is_active", 1).
    Count()

// Paginated query with total count (using Window Function)
rows, err := builder.Table("users").
    Total().
    Limit(10).
    Offset(20).
    Get()

Update Data

// Basic update
result, err := builder.Table("users").
    WhereEq("id", 1).
    Update(map[string]any{"name": "John Doe"})

// Increment field
result, err = builder.Table("users").
    WhereEq("id", 1).
    Increase("login_count", 1).
    Update()

// Toggle boolean
result, err = builder.Table("users").
    WhereEq("id", 1).
    Toggle("is_active").
    Update()

JOIN Queries

rows, err := builder.Table("orders").
    Select("orders.id", "users.name", "orders.total").
    Join("users", "users.id = orders.user_id").
    WhereGt("orders.total", 100).
    Get()

// LEFT JOIN
rows, err = builder.Table("users").
    LeftJoin("orders", "orders.user_id = users.id").
    Get()

Context Support

ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()

// Query
rows, err := builder.Table("users").GetContext(ctx)

// Insert
err = builder.Table("users").InsertContext(ctx, data)

// Update
result, err := builder.Table("users").
    WhereEq("id", 1).
    UpdateContext(ctx, data)

API Reference

Config

Column

Conflict Strategies

Builder Methods

License

MIT License

Author

邱敬幃 Pardn Chiu

Stars

©️ 2026 邱敬幃 Pardn Chiu