lume 0.12.1

A simple and intuitive Query Builder inspired by Drizzle
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# Lume

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

[![Crates.io](https://img.shields.io/crates/v/lume)](https://crates.io/crates/lume)
[![Documentation](https://img.shields.io/docsrs/lume)](https://docs.rs/lume)
[![License](https://img.shields.io/crates/l/lume)](LICENSE)

## 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`:

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

### Basic Example

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

// Define your database schema
define_schema! {
    Users {
        id: i32 [primary_key().not_null()],
        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: 0,
        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](docs/getting-started.md) - Installation and basic usage
- [Schema Definition](docs/schema.md) - Defining database schemas
- [Queries](docs/queries.md) - Building and executing queries
- [Filters](docs/filters.md) - Filtering and conditions
- [Inserts & Updates](docs/inserts-updates.md) - Inserting and updating data
- [Joins](docs/joins.md) - Joining tables
- [Advanced Topics](docs/advanced.md) - 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:

| Rust Type              | SQL Type            |
| ---------------------- | ------------------- |
| `String`               | `VARCHAR(255)`      |
| `i8`                   | `TINYINT`           |
| `i16`                  | `SMALLINT`          |
| `i32`                  | `INT`               |
| `i64`                  | `BIGINT`            |
| `u8`                   | `TINYINT UNSIGNED`  |
| `u16`                  | `SMALLINT UNSIGNED` |
| `u32`                  | `INT UNSIGNED`      |
| `u64`                  | `BIGINT UNSIGNED`   |
| `f32`                  | `FLOAT`             |
| `f64`                  | `DOUBLE`            |
| `bool`                 | `BOOLEAN`           |
| `time::OffsetDateTime` | `DATETIME`          |

## 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](LICENSE) file for details.

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for a detailed list of changes and improvements.