Lume

A type-safe, ergonomic query builder and ORM for SQL databases, inspired by Drizzle ORM.

Features

• 🚀 Type-safe: Compile-time type checking for all database operations
• 🎯 Ergonomic: Clean, intuitive API inspired by modern ORMs
• ⚡ Performance: Zero-cost abstractions with minimal runtime overhead
• 🔧 Flexible: Support for MySQL, PostgreSQL, and SQLite
• 🛡️ Safe: Parameterized queries by default to prevent SQL injection
• 📦 Lightweight: Minimal dependencies, maximum functionality

Quick Start

Add Lume to your Cargo.toml:

[dependencies]
lume = { version = "0.12", features = ["mysql"] }
tokio = { version = "1.0", features = ["macros", "rt-multi-thread"] }

Basic Example

use lume::{database::Database, define_schema, filter::eq_value};

// Define your database schema
define_schema! {
    Users {
        id: Uuid [primary_key().not_null().default_random()],
        username: String [not_null()],
        email: String,
        age: i32,
        created_at: i64 [not_null()],
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Connect to your database
    let db = Database::connect("mysql://user:password@localhost/database").await?;

    // Create tables (if they don't exist)
    db.register_table::<Users>().await?;

    // Insert a new user
    db.insert(Users {
        id: None,
        username: "john_doe".to_string(),
        email: "john.doe@example.com".to_string(),
        age: 25,
        created_at: 1677721600,
    })
    .execute()
    .await?;

    // Query users
    let users = db
        .query::<Users, SelectUsers>()
        .filter(eq_value(Users::username(), "john_doe"))
        .execute()
        .await?;

    for user in users {
        let username: Option<String> = user.get(Users::username());
        println!("User: {}", username.unwrap_or_default());
    }

    Ok(())
}

Documentation

• Getting Started - Installation and basic usage
• Schema Definition - Defining database schemas
• Queries - Building and executing queries
• Filters - Filtering and conditions
• Inserts & Updates - Inserting and updating data
• Joins - Joining tables
• Advanced Topics - Advanced features and patterns

Supported Databases

Lume supports multiple database backends through feature flags:

• MySQL: lume = { version = "0.12", features = ["mysql"] }
• PostgreSQL: lume = { version = "0.12", features = ["postgres"] }
• SQLite: lume = { version = "0.12", features = ["sqlite"] }

Type Mapping

Lume automatically maps Rust types to SQL types:

Contributing

We are not accepting contributions at this time. We will be accepting pull requests in the future, for now you can open an issue to discuss your ideas.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG.md for a detailed list of changes and improvements.