zxb - Zig SQL Query Builder

A lightweight, type-safe SQL query builder for Zig, inspired by xb (Go).

Why zxb?

✅ Simple: Only 4 fields (Bb struct) to express all queries
✅ Type-Safe: Compile-time type checking with anytype
✅ Auto-Filtering: Automatically filters nil/0/empty values
✅ Zero Dependencies: Pure Zig implementation
✅ AI-Friendly: Clean API that AI can easily understand and generate

Core Concept

The `Bb` (Building Block)

pub const Bb = struct {
    op: []const u8,        // Operator: "=", ">", "LIKE"...
    key: []const u8,       // Field name
    value: Value,          // Value (string/int/float/bool/null)
    subs: []Bb,           // Sub-conditions (for AND/OR)
};

Just 4 fields - expressing all SQL queries!

Inspired by xb (Go)'s elegant design, refined over 7 years of experience from sqli (Java).

Quick Start

Installation

Add zxb to your build.zig.zon:

.{
    .name = "my-app",
    .version = "0.1.0",
    .dependencies = .{
        .zxb = .{
            .url = "https://github.com/fndome/zxb/archive/refs/tags/v0.1.0.tar.gz",
        },
    },
}

Basic Usage

const std = @import("std");
const zxb = @import("zxb");

pub fn main() !void {
    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
    defer _ = gpa.deinit();
    const allocator = gpa.allocator();

    // Create a query builder
    var builder = zxb.of(allocator, "users");
    defer builder.deinit();

    // Build query with chaining
    _ = try builder.eq("status", 1);      // ✅ 直接用整数
    _ = try builder.eq("role", "admin");
    _ = try builder.gte("age", 18);       // ✅ 简洁！
    _ = try builder.sort("created_at", zxb.DESC);
    _ = builder.limit(10);

    // Generate SQL
    const sql = try builder.sqlOfSelect();
    defer allocator.free(sql);

    std.debug.print("SQL: {s}\n", .{sql});
    // Output: SELECT * FROM users WHERE status = ? AND role = ? AND age >= ? ORDER BY created_at DESC LIMIT 10
}

Features

1. Auto-Filtering

zxb automatically filters out nil, zero, and empty values:

var builder = zxb.of(allocator, "users");
defer builder.deinit();

_ = try builder.eq("status", 0);   // ✅ Filtered (zero)
_ = try builder.eq("name", "");    // ✅ Filtered (empty)
_ = try builder.eq("age", 18);     // ✅ Included

const sql = try builder.sqlOfSelect();
defer allocator.free(sql);

// SQL: SELECT * FROM users WHERE age = ?
// Only non-zero/non-empty conditions are included!

2. Rich Condition Methods

_ = try builder.eq("status", 1);          // Equal
_ = try builder.ne("role", "guest");      // Not equal
_ = try builder.gt("age", 18);            // Greater than
_ = try builder.gte("price", 100.0);      // Greater than or equal
_ = try builder.lt("stock", 1000);        // Less than
_ = try builder.lte("discount", 0.5);     // Less than or equal

// LIKE patterns
_ = try builder.like("name", "Alice");    // 包含: %Alice%
_ = try builder.likeLeft("sku", "PROD");  // 前缀: PROD%

// ✅ 支持所有整数/浮点数类型
_ = try builder.eq("id", 123);            // comptime_int
_ = try builder.eq("count", @as(i32, 10)); // i32
_ = try builder.eq("big", @as(i64, 999)); // i64
_ = try builder.eq("uint", @as(u32, 50)); // u32

注意:

✅ like() - 包含匹配（最常用）
✅ likeLeft() - 前缀匹配（用于索引优化）
❌ 不提供 likeRight() - 后缀匹配无法使用索引，性能差，极少使用

3. Sorting

_ = try builder.sort("created_at", zxb.DESC);  // Descending
_ = try builder.sort("id", zxb.ASC);           // Ascending

4. Pagination

_ = builder.limit(20);   // LIMIT 20
_ = builder.offset(40);  // OFFSET 40

5. Build Query (SQL + Args)

var builder = zxb.of(allocator, "users");
defer builder.deinit();

_ = try builder.eq("name", "Alice");
_ = try builder.gte("age", 18);  // ✅ 直接用整数

// ✅ 推荐：一次性获取 SQL 和参数
var result = try builder.build();
defer result.deinit(allocator);

// result.sql:  "SELECT * FROM users WHERE name = ? AND age >= ?"
// result.args: ["Alice", 18]

// 或者分别获取（兼容旧代码）
const sql = try builder.sqlOfSelect();
defer allocator.free(sql);

var args = try builder.args();
defer args.deinit();

Comparison with Other Languages

zxb (Zig)

var builder = zxb.of(allocator, "users");
defer builder.deinit();

_ = try builder.eq("status", @as(i64, 1));
_ = try builder.sort("id", zxb.DESC);

const sql = try builder.sqlOfSelect();
defer allocator.free(sql);

xb (Go)

builder := xb.Of(&User{}).
    Eq("status", 1).
    Sort("id", xb.DESC)

sql, _, _ := builder.Build().SqlOfSelect()

Diesel (Rust)

users::table
    .filter(users::status.eq(1))
    .order(users::id.desc())
    .load::<User>(&mut conn)

Design Philosophy

Inspired by xb (Go)

zxb inherits xb's core principles:

Simplicity - 4 fields express all queries
Explicitness - No magic, what you see is what you get
Auto-Filtering - Reduces boilerplate code
AI-Friendly - Clean API for AI assistants

Why Zig?

"In the AI era, programming languages must trust AI."

Zig's advantages for AI-assisted development:

✅ No lifetimes - Simpler than Rust for AI to generate
✅ comptime - Elegant metaprogramming AI can understand
✅ Manual memory - AI can optimize allocator strategies
✅ ! error handling - Simpler than Rust's Result<T, E>

Building & Testing

# Build library
zig build

# Run tests
zig build test

# Run example
zig build example

# Or run example directly
zig build run-example

Project Structure

zxb/
├── build.zig           # Build configuration
├── src/
│   ├── main.zig       # Library entry point
│   ├── value.zig      # Value type (union)
│   ├── bb.zig         # Core Bb struct
│   └── builder.zig    # Query builder
├── examples/
│   └── basic.zig      # Usage examples
├── doc/                # Documentation
│   ├── QUICK_REFERENCE.md
│   ├── HOW_IT_WORKS.md
│   ├── DESIGN.md
│   └── ...
├── LICENSE
└── README.md

Roadmap

Comparison: sqli → xb → zxb

Project	Language	Year	Status
sqli	Java	2015-2022	7 years of lessons learned
xb	Go	2023-2025	v1.0.0 - Production ready
zxb	Zig	2025+	Experimental - AI-optimized

Evolution:

sqli: Heavy (Spring Boot), but proven in production
xb: Lightweight (zero dependencies), perfect for humans
zxb: Performance-focused, designed for AI-assisted development

Documentation

Quick Reference - API 速查手册
How It Works - SQL 占位符和参数绑定详解
Build Method - build() 方法详解
LIKE Patterns - LIKE 模式详解
Design Philosophy - 设计哲学：sqli → xb → zxb
Getting Started - 快速开始指南
Install Zig - Zig 安装说明
Project Summary - 项目总结

License

Apache License 2.0

Contributing

我们欢迎所有形式的贡献！ 🎉

🐛 报告 Bug
💡 提出新功能
📝 改进文档
💻 提交代码

请阅读 CONTRIBUTING.md 了解如何参与。

Acknowledgments

xb (Go): The design inspiration - https://github.com/fndome/xb
sqli (Java): 7 years of experience - https://github.com/x-ream/sqli
fndome: "fn do me" - AI does the work

"Ugly things are not eternal. In the AI era, simple and beautiful code will prevail."

zxb = Zig eXtensible Builder 🚀

License

fndome/zxb

About

Topics

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages