Compare commits

..

8 Commits
v0.3.1 ... main

Author SHA1 Message Date
Michael Netshipise 2ea8a63ae4 consolidated skills 2026-02-06 06:09:44 +02:00
Michael Netshipise 6ed2401be1 fix: use Value-based binding in UpdateForm for proper Option<T> handling
When UpdateForm wraps fields that are already Option<T>, it creates
nested Options (Option<Option<T>>). The old bind_form_values method
bound these directly as &Option<T>, which caused MySQL "malform packet"
errors for Uuid -> BINARY(16) conversions.

Now both bind_form_values and bind_all_values use update_stmt_with_values()
which properly converts values through the Value enum:
- Some(None) -> Value::Null
- Some(Some(v)) -> Value::T(v)

This preserves the three-state semantics:
- None: don't include field in UPDATE
- Some(None): SET column = NULL
- Some(Some(v)): SET column = value

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-30 18:13:07 +02:00
Michael Netshipise a1464d3f7c Add update_by_filter for bulk updates by filter conditions
Usage:
  User::update_by_filter(&pool, filters![("status", "pending")], form).await?;

- Requires at least one filter to prevent accidental table-wide updates
- Returns number of affected rows
- Binds form values first, then filter values

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-29 20:55:10 +02:00
Michael Netshipise 3815913821 Fix remaining issues from bug report
- Rename static-validation to static-check
- Fix upsert_stmt undefined when no database feature enabled
- Fix bind_all_values lifetime to use explicit 'q instead of '_

Decimal support requires enabling the 'decimal' feature flag.
Manual UpdateForm implementations need to add _exprs field.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 21:18:13 +02:00
Michael Netshipise 0913091b67 Fix static-validation to use correct database placeholders
- Add static_placeholder() function that uses $1 for postgres, ? for mysql/sqlite
- Restore static-validation feature with proper database-specific SQL
- cfg!(feature = "static-validation") now works correctly with query_as! macro

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 21:07:49 +02:00
Michael Netshipise 3c0ae1983f Fix MySQL placeholder issue and add missing Value types
- Remove broken static-validation feature (hardcoded $1 placeholders)
- Add Value::Null variant for Option<T> support
- Add From<Option<T>> impl for all Value types
- Add f32, f64, NaiveTime, serde_json::Value support
- Add optional decimal feature for rust_decimal::Decimal
- All database backends now use runtime placeholder() function

Fixes issues:
- MySQL getting PostgreSQL $1 placeholders
- Missing From<Option<T>> implementations
- Missing base types (Decimal, JsonValue, NaiveTime, floats)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 21:01:31 +02:00
Michael Netshipise ceeecf2e5c Bump version to 0.3.2
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 17:23:39 +02:00
Michael Netshipise 6c56231003 Use workspace version, add clap CLI to MCP server
- Define version in workspace.package, inherit in all crates
- Rename MCP binary from sqlx-record-expert to sqlx-record-mcp
- Add clap for --version and --help support

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 17:19:14 +02:00
23 changed files with 758 additions and 332 deletions

View File

@ -6,12 +6,14 @@ Guide to flexible connection management.
- "connection provider", "conn provider"
- "borrow connection", "pool connection"
- "lazy connection", "connection management"
- "transaction provider", "use transaction"
## Overview
`ConnProvider` enables flexible connection handling:
- **Borrowed**: Use an existing connection reference
- **Owned**: Lazily acquire from pool on first use
- **Transaction**: Use a transaction reference (all operations participate in the transaction)
## Enum Variants
@ -26,6 +28,10 @@ pub enum ConnProvider<'a> {
pool: Pool,
conn: Option<PoolConnection<DB>>,
},
/// Reference to a transaction
Transaction {
tx: &'a mut Transaction<'static, DB>,
},
}
```
@ -45,15 +51,29 @@ let mut provider = ConnProvider::from_pool(pool.clone());
// Connection acquired on first get_conn() call
```
### from_tx
Use a transaction (all operations participate in the transaction):
```rust
let mut tx = pool.begin().await?;
let mut provider = ConnProvider::from_tx(&mut tx);
// All operations through provider use the transaction
do_work(&mut provider).await?;
// You must commit/rollback the transaction yourself
tx.commit().await?;
```
## Getting the Connection
```rust
let conn = provider.get_conn().await?;
// Returns &mut PoolConnection<DB>
// Returns &mut <DB>Connection (e.g., &mut MySqlConnection)
```
- **Borrowed**: Returns reference immediately
- **Borrowed**: Returns underlying connection immediately
- **Owned**: Acquires on first call, returns same connection on subsequent calls
- **Transaction**: Returns transaction's underlying connection
## Use Cases
@ -105,15 +125,37 @@ let mut conn = pool.acquire().await?;
do_database_work(&mut ConnProvider::from_ref(&mut conn)).await?;
// Call with pool
do_database_work(&mut ConnProvider::from_pool(pool)).await?;
do_database_work(&mut ConnProvider::from_pool(pool.clone())).await?;
// Call with transaction
let mut tx = pool.begin().await?;
do_database_work(&mut ConnProvider::from_tx(&mut tx)).await?;
tx.commit().await?;
```
### Transaction-like Patterns
### Using Transactions
```rust
async fn transactional_operation(pool: MySqlPool) -> Result<()> {
let mut tx = pool.begin().await?;
let mut provider = ConnProvider::from_tx(&mut tx);
// All operations participate in the transaction
step_1(&mut provider).await?;
step_2(&mut provider).await?;
step_3(&mut provider).await?;
// Commit (or rollback on error)
tx.commit().await?;
Ok(())
}
```
### Same Connection Pattern
```rust
async fn multi_step_operation(pool: MySqlPool) -> Result<()> {
let mut provider = ConnProvider::from_pool(pool);
// All operations use same connection
// All operations use same connection (but no transaction)
step_1(&mut provider).await?;
step_2(&mut provider).await?;
step_3(&mut provider).await?;
@ -127,11 +169,13 @@ async fn multi_step_operation(pool: MySqlPool) -> Result<()> {
The concrete types depend on the enabled feature:
| Feature | Pool Type | Connection Type |
|---------|-----------|-----------------|
| `mysql` | `MySqlPool` | `PoolConnection<MySql>` |
| `postgres` | `PgPool` | `PoolConnection<Postgres>` |
| `sqlite` | `SqlitePool` | `PoolConnection<Sqlite>` |
| Feature | Pool Type | Connection Type | Transaction Type |
|---------|-----------|-----------------|------------------|
| `mysql` | `MySqlPool` | `MySqlConnection` | `Transaction<'static, MySql>` |
| `postgres` | `PgPool` | `PgConnection` | `Transaction<'static, Postgres>` |
| `sqlite` | `SqlitePool` | `SqliteConnection` | `Transaction<'static, Sqlite>` |
Note: `get_conn()` returns `&mut <DB>Connection` (the underlying connection type).
## Example: Service Layer
@ -175,28 +219,28 @@ let user_id = UserService::create_with_profile(&mut provider, "Alice", "Hello!")
## Connection Lifecycle
```
from_pool(pool) from_ref(&mut conn)
│ │
▼ ▼
Owned { Borrowed {
pool, conn: &mut PoolConnection
conn: None }
}
│ │
│ get_conn() │ get_conn()
▼ ▼
pool.acquire() return conn
│ │
Owned {
pool,
conn: Some(acquired) │
} │
│ │
│ get_conn() (subsequent) │
return &mut acquired │
Drop: conn returned Drop: nothing (borrowed)
from_pool(pool) from_ref(&mut conn) from_tx(&mut tx)
│ │
▼ ▼
Owned { Borrowed { Transaction {
pool, conn: &mut tx: &mut
conn: None PoolConnection Transaction
} } }
│ │
│ get_conn() │ get_conn() │ get_conn()
▼ ▼
pool.acquire() deref conn deref tx
│ │
▼ ▼
Owned { return &mut return &mut
pool, Connection Connection
conn: Some(acquired) │
} │
│ │
│ get_conn() (subsequent) │
▼ ▼
return &mut conn Drop: nothing Drop: nothing
(borrowed) (tx managed
externally)
Drop: conn returned
```

View File

@ -59,11 +59,13 @@ large_count: i64,
### #[soft_delete]
```rust
#[soft_delete]
is_deleted: bool,
is_active: bool,
```
- Enables soft delete functionality
- Generates `delete()`, `restore()`, `hard_delete()` methods
- Generates `soft_delete()`, `soft_delete_by_{pk}()`, `restore()`, `restore_by_{pk}()` methods
- Field must be `bool` type
- Convention: `is_active` fields are auto-detected (FALSE = deleted)
- `#[soft_delete]` attribute means field is FALSE when entity is deleted
### #[created_at]
```rust
@ -194,17 +196,20 @@ pub async fn get_version(executor, pk: &PkType) -> Result<Option<VersionType>, E
pub async fn get_versions(executor, pks: &[PkType]) -> Result<HashMap<PkType, VersionType>, Error>
```
### Soft Delete Methods (if #[soft_delete] exists)
### Hard Delete (always generated)
```rust
// Soft delete - sets field to true
pub async fn delete(&self, executor) -> Result<(), Error>
pub async fn delete_by_id(executor, id: &Uuid) -> Result<(), Error>
// Hard delete - permanently removes row
// Permanently removes row from database
pub async fn hard_delete(&self, executor) -> Result<(), Error>
pub async fn hard_delete_by_id(executor, id: &Uuid) -> Result<(), Error>
```
// Restore - sets field to false
### Soft Delete Methods (if `is_active` field or `#[soft_delete]` exists)
```rust
// Soft delete - marks as deleted (is_active = FALSE)
pub async fn soft_delete(&self, executor) -> Result<(), Error>
pub async fn soft_delete_by_id(executor, id: &Uuid) -> Result<(), Error>
// Restore - marks as active (is_active = TRUE)
pub async fn restore(&self, executor) -> Result<(), Error>
pub async fn restore_by_id(executor, id: &Uuid) -> Result<(), Error>

View File

@ -122,28 +122,30 @@ sqlx-record = { version = "0.3", features = ["mysql", "derive"] }
# Optional: "derive", "static-validation"
```
## Soft Delete, Timestamps, Batch Operations
## Delete, Soft Delete, Timestamps, Batch Operations
```rust
#[derive(Entity, FromRow)]
struct User {
#[primary_key] id: Uuid,
name: String,
is_active: bool, // Auto-detected for soft delete (is_active = FALSE when deleted)
#[soft_delete] // Enables delete/restore/hard_delete
is_deleted: bool,
#[created_at] // Auto-set on insert
#[created_at] // Auto-set on insert
created_at: i64,
#[updated_at] // Auto-set on update
#[updated_at] // Auto-set on update
updated_at: i64,
}
// Soft delete
user.delete(&pool).await?; // is_deleted = true
user.restore(&pool).await?; // is_deleted = false
user.hard_delete(&pool).await?; // DELETE FROM
// Hard delete (always available on all entities)
user.hard_delete(&pool).await?; // DELETE FROM
User::hard_delete_by_id(&pool, &id).await?;
// Soft delete (when is_active or #[soft_delete] field exists)
user.soft_delete(&pool).await?; // is_active = false
User::soft_delete_by_id(&pool, &id).await?;
user.restore(&pool).await?; // is_active = true
// Batch insert
User::insert_many(&pool, &users).await?;
@ -206,11 +208,23 @@ User::update_by_id(&pool, &id,
## ConnProvider (Flexible Connections)
```rust
use sqlx_record::ConnProvider;
use sqlx_record::prelude::ConnProvider;
// Borrowed or owned pool connections
let conn = ConnProvider::Borrowed(&pool);
let users = User::find(&*conn, filters![], None).await?;
// From borrowed connection
let mut conn = pool.acquire().await?;
let mut provider = ConnProvider::from_ref(&mut conn);
// From pool (lazy acquisition)
let mut provider = ConnProvider::from_pool(pool.clone());
// From transaction (operations participate in the transaction)
let mut tx = pool.begin().await?;
let mut provider = ConnProvider::from_tx(&mut tx);
// ... use provider ...
tx.commit().await?;
// Get underlying connection
let conn = provider.get_conn().await?;
```
## Database Differences

View File

@ -1,61 +1,17 @@
# sqlx-record Soft Delete Skill
# sqlx-record Delete & Soft Delete Skill
Guide to soft delete functionality with #[soft_delete] attribute.
Guide to hard delete and soft delete functionality.
## Triggers
- "soft delete", "soft-delete"
- "is_deleted", "deleted"
- "restore", "undelete"
- "hard delete", "permanent delete"
- "is_active", "is_deleted", "deleted"
- "restore", "undelete"
- "delete_by_id", "hard_delete_by_id"
## Overview
## Hard Delete (Always Generated)
Soft delete allows marking records as deleted without removing them from the database. This enables:
- Recovery of accidentally deleted data
- Audit trails of deletions
- Referential integrity preservation
## Enabling Soft Delete
Add `#[soft_delete]` to a boolean field:
```rust
use sqlx_record::prelude::*;
#[derive(Entity, FromRow)]
#[table_name = "users"]
struct User {
#[primary_key]
id: Uuid,
name: String,
#[soft_delete]
is_deleted: bool, // Must be bool type
}
```
Auto-detection: Fields named `is_deleted` or `deleted` with `bool` type are automatically treated as soft delete fields even without the attribute.
## Generated Methods
### delete() / delete_by_{pk}()
Sets the soft delete field to `true`:
```rust
// Instance method
user.delete(&pool).await?;
// Static method by primary key
User::delete_by_id(&pool, &user_id).await?;
```
**SQL generated:**
```sql
UPDATE users SET is_deleted = TRUE WHERE id = ?
```
### hard_delete() / hard_delete_by_{pk}()
Permanently removes the row:
Every Entity gets `hard_delete()` and `hard_delete_by_{pk}()` methods. No configuration needed.
```rust
// Instance method
@ -70,8 +26,73 @@ User::hard_delete_by_id(&pool, &user_id).await?;
DELETE FROM users WHERE id = ?
```
## Soft Delete
Marks records as deleted without removing them from the database. This enables:
- Recovery of accidentally deleted data
- Audit trails of deletions
- Referential integrity preservation
### Enabling Soft Delete
**Preferred: `is_active` convention** (auto-detected, no attribute needed):
```rust
use sqlx_record::prelude::*;
#[derive(Entity, FromRow)]
#[table_name = "users"]
struct User {
#[primary_key]
id: Uuid,
name: String,
is_active: bool, // Auto-detected: FALSE = deleted, TRUE = active
}
```
**Alternative: `#[soft_delete]` attribute** on any bool field:
```rust
#[derive(Entity, FromRow)]
#[table_name = "users"]
struct User {
#[primary_key]
id: Uuid,
name: String,
#[soft_delete] // Field will be FALSE when deleted
is_active: bool,
}
```
**Legacy: `is_deleted`/`deleted` fields** are also auto-detected (TRUE = deleted).
### Detection Priority
1. Field with `#[soft_delete]` attribute (FALSE = deleted)
2. Field named `is_active` with bool type (FALSE = deleted)
3. Field named `is_deleted` or `deleted` with bool type (TRUE = deleted)
## Generated Methods
### soft_delete() / soft_delete_by_{pk}()
Marks the record as deleted:
```rust
// Instance method
user.soft_delete(&pool).await?;
// Static method by primary key
User::soft_delete_by_id(&pool, &user_id).await?;
```
**SQL generated (is_active convention):**
```sql
UPDATE users SET is_active = FALSE WHERE id = ?
```
### restore() / restore_by_{pk}()
Sets the soft delete field to `false`:
Restores a soft-deleted record:
```rust
// Instance method
@ -81,16 +102,16 @@ user.restore(&pool).await?;
User::restore_by_id(&pool, &user_id).await?;
```
**SQL generated:**
**SQL generated (is_active convention):**
```sql
UPDATE users SET is_deleted = FALSE WHERE id = ?
UPDATE users SET is_active = TRUE WHERE id = ?
```
### soft_delete_field()
Returns the field name:
```rust
let field = User::soft_delete_field(); // "is_deleted"
let field = User::soft_delete_field(); // "is_active"
```
## Filtering Deleted Records
@ -98,11 +119,11 @@ let field = User::soft_delete_field(); // "is_deleted"
Soft delete does **NOT** automatically filter `find()` queries. You must add the filter manually:
```rust
// Include only non-deleted
let users = User::find(&pool, filters![("is_deleted", false)], None).await?;
// Include only active (non-deleted)
let users = User::find(&pool, filters![("is_active", true)], None).await?;
// Include only deleted (trash view)
let deleted = User::find(&pool, filters![("is_deleted", true)], None).await?;
let deleted = User::find(&pool, filters![("is_active", false)], None).await?;
// Include all records
let all = User::find(&pool, filters![], None).await?;
@ -119,7 +140,7 @@ impl User {
mut filters: Vec<Filter<'_>>,
index: Option<&str>
) -> Result<Vec<Self>, sqlx::Error> {
filters.push(Filter::Equal("is_deleted", false.into()));
filters.push(Filter::Equal("is_active", true.into()));
Self::find(pool, filters, index).await
}
}
@ -130,28 +151,28 @@ let users = User::find_active(&pool, filters![("role", "admin")], None).await?;
## Usage Examples
### Basic Soft Delete Flow
### Basic Flow
```rust
// Create user
let user = User {
id: new_uuid(),
name: "Alice".into(),
is_deleted: false,
is_active: true,
};
user.insert(&pool).await?;
// Soft delete
user.delete(&pool).await?;
// user still exists in DB with is_deleted = true
user.soft_delete(&pool).await?;
// user still exists in DB with is_active = false
// Find won't return deleted users (with proper filter)
let users = User::find(&pool, filters![("is_deleted", false)], None).await?;
let users = User::find(&pool, filters![("is_active", true)], None).await?;
// Alice not in results
// Restore
User::restore_by_id(&pool, &user.id).await?;
// user.is_deleted = false again
// user.is_active = true again
// Hard delete (permanent)
User::hard_delete_by_id(&pool, &user.id).await?;
@ -170,13 +191,13 @@ async fn soft_delete_with_audit(
) -> Result<(), sqlx::Error> {
transaction!(&pool, |tx| {
// Soft delete the user
User::delete_by_id(&mut *tx, user_id).await?;
User::soft_delete_by_id(&mut *tx, user_id).await?;
// Record the deletion
let change = EntityChange {
id: new_uuid(),
entity_id: *user_id,
action: "delete".into(),
action: "soft_delete".into(),
changed_at: chrono::Utc::now().timestamp_millis(),
actor_id: *actor_id,
session_id: Uuid::nil(),
@ -198,11 +219,11 @@ async fn delete_user_cascade(pool: &Pool, user_id: &Uuid) -> Result<(), sqlx::Er
// Soft delete user's orders
let orders = Order::find(&mut *tx, filters![("user_id", user_id)], None).await?;
for order in orders {
order.delete(&mut *tx).await?;
order.soft_delete(&mut *tx).await?;
}
// Soft delete user
User::delete_by_id(&mut *tx, user_id).await?;
User::soft_delete_by_id(&mut *tx, user_id).await?;
Ok::<_, sqlx::Error>(())
}).await
@ -215,27 +236,28 @@ Recommended column definition:
```sql
-- MySQL
is_deleted BOOLEAN NOT NULL DEFAULT FALSE
is_active BOOLEAN NOT NULL DEFAULT TRUE
-- PostgreSQL
is_deleted BOOLEAN NOT NULL DEFAULT FALSE
is_active BOOLEAN NOT NULL DEFAULT TRUE
-- SQLite
is_deleted INTEGER NOT NULL DEFAULT 0 -- 0=false, 1=true
is_active INTEGER NOT NULL DEFAULT 1 -- 1=true, 0=false
```
Add an index for efficient filtering:
```sql
CREATE INDEX idx_users_is_deleted ON users (is_deleted);
CREATE INDEX idx_users_is_active ON users (is_active);
-- Or composite index for common queries
CREATE INDEX idx_users_active_name ON users (is_deleted, name);
CREATE INDEX idx_users_active_name ON users (is_active, name);
```
## Notes
- Soft delete field must be `bool` type
- The field is included in UpdateForm (can be manually toggled)
- `hard_delete()` / `hard_delete_by_{pk}()` are always available, even on entities with soft delete
- Consider adding `deleted_at: Option<i64>` for deletion timestamps
- For complex filtering, consider database views

View File

@ -31,13 +31,14 @@ sqlx-record/
│ └── src/main.rs
├── mcp/ # MCP server for documentation/code generation
│ └── src/main.rs # sqlx-record-expert executable
├── .claude/skills/ # Claude Code skills documentation
│ ├── sqlx-record.md # Overview and quick reference
│ ├── sqlx-entity.md # #[derive(Entity)] detailed guide
│ ├── sqlx-filters.md # Filter system guide
│ ├── sqlx-audit.md # Audit trail guide
│ ├── sqlx-lookup.md # Lookup tables guide
│ └── sqlx-values.md # Value types guide
├── .claude/skills/sqlx-record/ # Claude Code skills documentation
│ ├── sqlx-record.md # Overview and quick reference
│ ├── sqlx-entity.md # #[derive(Entity)] detailed guide
│ ├── sqlx-filters.md # Filter system guide
│ ├── sqlx-audit.md # Audit trail guide
│ ├── sqlx-lookup.md # Lookup tables guide
│ ├── sqlx-values.md # Value types guide
│ └── sqlx-conn-provider.md # Connection provider guide
└── Cargo.toml # Workspace root
```
@ -122,7 +123,7 @@ let id = new_uuid(); // Timestamp prefix (8 bytes) + random (8 bytes)
## Connection Provider
Flexible connection management - borrow existing or lazily acquire from pool:
Flexible connection management - borrow existing connection, lazily acquire from pool, or use a transaction:
```rust
use sqlx_record::prelude::ConnProvider;
@ -133,6 +134,12 @@ let mut provider = ConnProvider::from_ref(&mut conn);
// From pool (lazy acquisition)
let mut provider = ConnProvider::from_pool(pool.clone());
// From transaction (operations participate in the transaction)
let mut tx = pool.begin().await?;
let mut provider = ConnProvider::from_tx(&mut tx);
// ... use provider ...
tx.commit().await?;
// Get connection (acquires on first call for Owned variant)
let conn = provider.get_conn().await?;
```

View File

@ -1,9 +1,13 @@
[package]
name = "sqlx-record"
version = "0.3.0"
edition = "2021"
version.workspace = true
edition.workspace = true
description = "Entity CRUD and change tracking for SQL databases with SQLx"
[workspace.package]
version = "0.3.7"
edition = "2021"
[dependencies]
sqlx-record-derive = { path = "sqlx-record-derive", optional = true }
sqlx = { version = "0.8", features = ["runtime-tokio", "uuid", "chrono", "json"] }
@ -12,6 +16,7 @@ uuid = { version = "1", features = ["v4"] }
chrono = "0.4"
rand = "0.8"
paste = "1.0"
rust_decimal = { version = "1", optional = true }
[workspace]
members = [
@ -23,7 +28,8 @@ members = [
[features]
default = []
derive = ["dep:sqlx-record-derive"]
static-validation = ["sqlx-record-derive?/static-validation"]
static-check = ["sqlx-record-derive?/static-check"]
decimal = ["dep:rust_decimal", "sqlx/rust_decimal"]
# Database backends - user must enable at least one
mysql = ["sqlx/mysql", "sqlx-record-derive?/mysql"]

View File

@ -1,14 +1,15 @@
[package]
name = "sqlx-record-mcp"
version = "0.3.0"
edition = "2021"
version.workspace = true
edition.workspace = true
description = "MCP server providing sqlx-record documentation and code generation"
[[bin]]
name = "sqlx-record-expert"
name = "sqlx-record-mcp"
path = "src/main.rs"
[dependencies]
clap = { version = "4", features = ["derive"] }
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
tokio = { version = "1", features = ["full"] }

View File

@ -1,7 +1,13 @@
use clap::Parser;
use serde::{Deserialize, Serialize};
use serde_json::{json, Value};
use std::io::{self, BufRead, Write};
#[derive(Parser)]
#[command(name = "sqlx-record-mcp")]
#[command(version, about = "MCP server for sqlx-record documentation and code generation")]
struct Args {}
// ============================================================================
// MCP Protocol Types
// ============================================================================
@ -45,7 +51,8 @@ A Rust library providing derive macros for automatic CRUD operations and compreh
- **Audit Trails**: Track who changed what, when, and why
- **Type-Safe Filters**: Composable query building with `Filter` enum
- **UpdateExpr**: Advanced updates with arithmetic, CASE/WHEN, conditionals
- **Soft Deletes**: `#[soft_delete]` with delete/restore/hard_delete methods
- **Hard Delete**: `hard_delete_by_{pk}()` always generated for all entities
- **Soft Deletes**: `#[soft_delete]` or `is_active` convention with soft_delete/restore methods
- **Auto Timestamps**: `#[created_at]`, `#[updated_at]` auto-populated
- **Batch Operations**: `insert_many()`, `upsert()` for efficient bulk operations
- **Pagination**: `Page<T>` with `paginate()` method
@ -160,6 +167,21 @@ pub async fn update_by_ids(executor, ids: &[Uuid], form: UpdateForm) -> Result<(
pub fn update_form() -> UpdateForm
```
### Delete (always generated)
```rust
pub async fn hard_delete(&self, executor) -> Result<(), Error>
pub async fn hard_delete_by_id(executor, id: &Uuid) -> Result<(), Error>
```
### Soft Delete (if `is_active` field or `#[soft_delete]` exists)
```rust
pub async fn soft_delete(&self, executor) -> Result<(), Error>
pub async fn soft_delete_by_id(executor, id: &Uuid) -> Result<(), Error>
pub async fn restore(&self, executor) -> Result<(), Error>
pub async fn restore_by_id(executor, id: &Uuid) -> Result<(), Error>
pub const fn soft_delete_field() -> &'static str
```
### Diff (Change Detection)
```rust
pub fn model_diff(form: &UpdateForm, model: &Self) -> serde_json::Value
@ -1094,11 +1116,43 @@ if page.has_next() {
```
"#;
const SOFT_DELETE: &str = r#"# Soft Delete
const SOFT_DELETE: &str = r#"# Delete Methods
## Hard Delete (always generated)
Every Entity gets `hard_delete` and `hard_delete_by_{pk}` methods:
```rust
// Instance method
user.hard_delete(&pool).await?;
// Static method by primary key
User::hard_delete_by_id(&pool, &user_id).await?;
```
**SQL generated:**
```sql
DELETE FROM users WHERE id = ?
```
## Soft Delete
Mark records as deleted without removing from database.
## Enable
### Enable
Convention: an `is_active` bool field is auto-detected (preferred):
```rust
#[derive(Entity, FromRow)]
struct User {
#[primary_key]
id: Uuid,
is_active: bool, // Auto-detected: FALSE = deleted
}
```
Or use `#[soft_delete]` on any bool field:
```rust
#[derive(Entity, FromRow)]
@ -1106,42 +1160,38 @@ struct User {
#[primary_key]
id: Uuid,
#[soft_delete] // Must be bool
is_deleted: bool,
#[soft_delete] // Field will be FALSE when deleted
is_active: bool,
}
```
Auto-detection: Fields named `is_deleted` or `deleted` with `bool` type work without attribute.
Auto-detection also works for `is_deleted` or `deleted` bool fields (TRUE = deleted).
## Generated Methods
### Generated Methods
```rust
// Soft delete (set to true)
user.delete(&pool).await?;
User::delete_by_id(&pool, &id).await?;
// Soft delete (set is_active = FALSE)
user.soft_delete(&pool).await?;
User::soft_delete_by_id(&pool, &id).await?;
// Hard delete (permanent)
user.hard_delete(&pool).await?;
User::hard_delete_by_id(&pool, &id).await?;
// Restore (set to false)
// Restore (set is_active = TRUE)
user.restore(&pool).await?;
User::restore_by_id(&pool, &id).await?;
// Field name
User::soft_delete_field() // "is_deleted"
User::soft_delete_field() // "is_active"
```
## Filtering
### Filtering
Soft delete does NOT auto-filter. Add filter manually:
```rust
// Only non-deleted
let users = User::find(&pool, filters![("is_deleted", false)], None).await?;
// Only active (non-deleted)
let users = User::find(&pool, filters![("is_active", true)], None).await?;
// Only deleted (trash)
let deleted = User::find(&pool, filters![("is_deleted", true)], None).await?;
// Only deleted
let deleted = User::find(&pool, filters![("is_active", false)], None).await?;
// All records
let all = User::find(&pool, filters![], None).await?;
@ -1950,6 +2000,8 @@ fn handle_read_resource(params: &Value) -> Value {
// ============================================================================
fn main() {
let _args = Args::parse();
let stdin = io::stdin();
let mut stdout = io::stdout();

View File

@ -1,7 +1,7 @@
[package]
name = "sqlx-record-ctl"
version = "0.3.0"
edition = "2021"
version.workspace = true
edition.workspace = true
description = "CLI tool for managing sqlx-record audit tables"
[dependencies]

View File

@ -1,7 +1,7 @@
[package]
name = "sqlx-record-derive"
version = "0.3.0"
edition = "2021"
version.workspace = true
edition.workspace = true
description = "Derive macros for sqlx-record"
[dependencies]
@ -13,7 +13,7 @@ futures = "0.3"
[features]
default = []
static-validation = []
static-check = []
mysql = []
postgres = []
sqlite = []

View File

@ -62,7 +62,7 @@ fn db_type() -> TokenStream2 {
}
#[cfg(feature = "sqlite")]
{
quote! { sqlx::Sqlite }
return quote! { sqlx::Sqlite };
}
#[cfg(feature = "mysql")]
{
@ -82,7 +82,7 @@ fn db_arguments() -> TokenStream2 {
}
#[cfg(feature = "sqlite")]
{
quote! { sqlx::sqlite::SqliteArguments<'static> }
return quote! { sqlx::sqlite::SqliteArguments<'q> };
}
#[cfg(feature = "mysql")]
{
@ -99,13 +99,21 @@ fn table_quote() -> &'static str {
#[cfg(feature = "postgres")]
{ "\"" }
#[cfg(feature = "sqlite")]
{ "\"" }
{ return "\""; }
#[cfg(feature = "mysql")]
{ "`" }
#[cfg(not(any(feature = "mysql", feature = "postgres", feature = "sqlite")))]
{ "`" }
}
/// Get compile-time placeholder for static-check SQL
fn static_placeholder(index: usize) -> String {
#[cfg(feature = "postgres")]
{ format!("${}", index) }
#[cfg(not(feature = "postgres"))]
{ let _ = index; "?".to_string() }
}
fn derive_entity_internal(input: TokenStream) -> TokenStream {
let input = parse_macro_input!(input as DeriveInput);
let name = &input.ident;
@ -131,10 +139,11 @@ fn derive_entity_internal(input: TokenStream) -> TokenStream {
.or_else(|| fields.iter().find(|&f| is_version_field(f)));
// Find soft delete field (by attribute or by name convention)
// Convention: `is_active` (FALSE = deleted), `is_deleted`/`deleted` (TRUE = deleted)
let soft_delete_field = fields.iter()
.find(|f| f.is_soft_delete)
.or_else(|| fields.iter().find(|f| {
(f.ident == "is_deleted" || f.ident == "deleted") &&
(f.ident == "is_active" || f.ident == "is_deleted" || f.ident == "deleted") &&
matches!(&f.ty, Type::Path(p) if p.path.is_ident("bool"))
}));
@ -143,6 +152,7 @@ fn derive_entity_internal(input: TokenStream) -> TokenStream {
let get_impl = generate_get_impl(&name, &table_name, primary_key, version_field, soft_delete_field, &fields, &impl_generics, &ty_generics, &where_clause);
let update_impl = generate_update_impl(&name, &update_form_name, &table_name, &fields, primary_key, version_field, has_updated_at, &impl_generics, &ty_generics, &where_clause);
let diff_impl = generate_diff_impl(&name, &update_form_name, &fields, primary_key, version_field, &impl_generics, &ty_generics, &where_clause);
let delete_impl = generate_delete_impl(&name, &table_name, primary_key, &impl_generics, &ty_generics, &where_clause);
let soft_delete_impl = generate_soft_delete_impl(&name, &table_name, primary_key, soft_delete_field, &impl_generics, &ty_generics, &where_clause);
let pk_type = &primary_key.ty;
@ -153,6 +163,7 @@ fn derive_entity_internal(input: TokenStream) -> TokenStream {
#get_impl
#update_impl
#diff_impl
#delete_impl
#soft_delete_impl
impl #impl_generics #name #ty_generics #where_clause {
@ -359,52 +370,13 @@ fn generate_insert_impl(
.filter(|f| *f != #pk_db_name)
.collect();
#[cfg(feature = "mysql")]
let upsert_stmt = {
let update_clause = non_pk_fields.iter()
.map(|f| format!("{} = VALUES({})", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON DUPLICATE KEY UPDATE {}",
#tq, #table_name, #tq,
vec![#(#db_names),*].join(", "),
placeholders,
update_clause
)
};
#[cfg(feature = "postgres")]
let upsert_stmt = {
let update_clause = non_pk_fields.iter()
.map(|f| format!("{} = EXCLUDED.{}", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON CONFLICT ({}) DO UPDATE SET {}",
#tq, #table_name, #tq,
vec![#(#db_names),*].join(", "),
placeholders,
#pk_db_name,
update_clause
)
};
#[cfg(feature = "sqlite")]
let upsert_stmt = {
let update_clause = non_pk_fields.iter()
.map(|f| format!("{} = excluded.{}", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON CONFLICT({}) DO UPDATE SET {}",
#tq, #table_name, #tq,
vec![#(#db_names),*].join(", "),
placeholders,
#pk_db_name,
update_clause
)
};
let upsert_stmt = ::sqlx_record::prelude::build_upsert_stmt(
#table_name,
&[#(#db_names),*],
#pk_db_name,
&non_pk_fields,
&placeholders,
);
sqlx::query(&upsert_stmt)
#(.bind(#bindings))*
@ -563,14 +535,18 @@ fn generate_get_impl(
quote! {}
};
// Check if static-validation feature is enabled at macro expansion time
let use_static_validation = cfg!(feature = "static-validation");
let field_list = fields.iter().map(|f| f.db_name.clone()).collect::<Vec<_>>();
// Check if static-check feature is enabled at macro expansion time
let use_static_validation = cfg!(feature = "static-check");
let get_by_impl = if use_static_validation {
// Static validation: use sqlx::query_as! with compile-time checked SQL
let select_stmt = format!(
r#"SELECT DISTINCT {} FROM {}{}{} WHERE {} = $1"#,
r#"SELECT DISTINCT {} FROM {}{}{} WHERE {} = {}"#,
select_fields.clone().collect::<Vec<_>>().join(", "),
tq, table_name, tq, pk_db_field_name
tq, table_name, tq, pk_db_field_name,
static_placeholder(1)
);
quote! {
pub async fn #get_by_func<'a, E>(executor: E, #pk_field: &#pk_type) -> Result<Option<Self>, sqlx::Error>
@ -604,8 +580,7 @@ fn generate_get_impl(
}
}
} else {
let field_list = fields.iter().map(|f| f.db_name.clone()).collect::<Vec<_>>();
// Runtime: use sqlx::query_as with dynamic SQL
quote! {
pub async fn #get_by_func<'a, E>(executor: E, #pk_field: &#pk_type) -> Result<Option<Self>, sqlx::Error>
where
@ -751,13 +726,7 @@ fn generate_get_impl(
String::new()
};
// Index hints are MySQL-specific
#[cfg(feature = "mysql")]
let index_clause = index
.map(|idx| format!("USE INDEX ({})", idx))
.unwrap_or_default();
#[cfg(not(feature = "mysql"))]
let index_clause = { let _ = index; String::new() };
let index_clause = ::sqlx_record::prelude::build_index_clause(index);
//Filter order_by fields to only those managed
let fields = Self::select_fields().into_iter().collect::<::std::collections::HashSet<_>>();
@ -821,23 +790,8 @@ fn generate_get_impl(
String::new()
};
// Index hints are MySQL-specific
#[cfg(feature = "mysql")]
let index_clause = index
.map(|idx| format!("USE INDEX ({})", idx))
.unwrap_or_default();
#[cfg(not(feature = "mysql"))]
let index_clause = { let _ = index; String::new() };
// Use database-appropriate COUNT syntax
#[cfg(feature = "postgres")]
let count_expr = format!("COUNT({})::BIGINT", #pk_db_field_name);
#[cfg(feature = "sqlite")]
let count_expr = format!("COUNT({})", #pk_db_field_name);
#[cfg(feature = "mysql")]
let count_expr = format!("CAST(COUNT({}) AS SIGNED)", #pk_db_field_name);
#[cfg(not(any(feature = "mysql", feature = "postgres", feature = "sqlite")))]
let count_expr = format!("COUNT({})", #pk_db_field_name);
let index_clause = ::sqlx_record::prelude::build_index_clause(index);
let count_expr = ::sqlx_record::prelude::build_count_expr(#pk_db_field_name);
let query = format!(
r#"SELECT {} FROM {}{}{} {} {}"#,
@ -928,13 +882,7 @@ fn generate_get_impl(
String::new()
};
// Index hints are MySQL-specific
#[cfg(feature = "mysql")]
let index_clause = index
.map(|idx| format!("USE INDEX ({})", idx))
.unwrap_or_default();
#[cfg(not(feature = "mysql"))]
let index_clause = { let _ = index; String::new() };
let index_clause = ::sqlx_record::prelude::build_index_clause(index);
let query = format!(
"SELECT DISTINCT {} FROM {}{}{} {} {}",
@ -1058,12 +1006,15 @@ fn generate_update_impl(
quote! {}
};
// Auto-update updated_at timestamp
// Auto-update updated_at timestamp (only if not manually set)
let updated_at_increment = if has_updated_at {
quote! {
parts.push(format!("updated_at = {}", ::sqlx_record::prelude::placeholder(idx)));
values.push(::sqlx_record::prelude::Value::Int64(chrono::Utc::now().timestamp_millis()));
idx += 1;
// Only auto-set updated_at if not already set in form or via expression
if self.updated_at.is_none() && !self._exprs.contains_key("updated_at") {
parts.push(format!("updated_at = {}", ::sqlx_record::prelude::placeholder(idx)));
values.push(::sqlx_record::prelude::Value::Int64(chrono::Utc::now().timestamp_millis()));
idx += 1;
}
}
} else {
quote! {}
@ -1158,40 +1109,31 @@ fn generate_update_impl(
/// Bind all form values to query in correct order.
/// Handles both simple values and expression values, respecting expression precedence.
pub fn bind_all_values(&self, mut query: sqlx::query::Query<'_, #db, #db_args>)
-> sqlx::query::Query<'_, #db, #db_args>
/// Uses Value enum for proper type handling of Option<T> fields.
pub fn bind_all_values<'q>(&'q self, mut query: sqlx::query::Query<'q, #db, #db_args>)
-> sqlx::query::Query<'q, #db, #db_args>
{
#(
// Expression takes precedence over simple value
if let Some(expr) = self._exprs.get(#db_names) {
let (_, expr_values) = expr.build_sql(#db_names, 1);
for value in expr_values {
query = ::sqlx_record::prelude::bind_value_owned(query, value);
}
} else if let Some(ref value) = self.#field_idents {
query = query.bind(value);
}
)*
// Use update_stmt_with_values to get properly converted values
// This handles nested Options (Option<Option<T>>) correctly
let (_, values) = self.update_stmt_with_values();
for value in values {
query = ::sqlx_record::prelude::bind_value_owned(query, value);
}
query
}
/// Legacy binding method - only binds simple Option values (ignores expressions).
/// Legacy binding method - binds values through the Value enum for proper type handling.
/// For backward compatibility. New code should use bind_all_values().
pub fn bind_form_values<'q>(&'q self, mut query: sqlx::query::Query<'q, #db, #db_args>)
-> sqlx::query::Query<'q, #db, #db_args>
{
if self._exprs.is_empty() {
// No expressions, use simple binding
#(
if let Some(ref value) = self.#field_idents {
query = query.bind(value);
}
)*
query
} else {
// Has expressions, use full binding
self.bind_all_values(query)
// Always use Value-based binding to properly handle Option<T> fields
// This ensures nested Options (Option<Option<T>>) are unwrapped correctly
let (_, values) = self.update_stmt_with_values();
for value in values {
query = ::sqlx_record::prelude::bind_value_owned(query, value);
}
query
}
/// Check if this form uses any expressions
@ -1322,6 +1264,7 @@ fn generate_diff_impl(
pub fn to_update_form(&self) -> #update_form_name #ty_generics {
#update_form_name {
#(#field_idents: Some(self.#field_idents.clone()),)*
_exprs: std::collections::HashMap::new(),
}
}
@ -1456,6 +1399,97 @@ fn generate_diff_impl(
Ok(())
}
/// Update all records matching the filter conditions
/// Returns the number of affected rows
pub async fn update_by_filter<'a, E>(
executor: E,
filters: Vec<::sqlx_record::prelude::Filter<'a>>,
form: #update_form_name,
) -> Result<u64, sqlx::Error>
where
E: sqlx::Executor<'a, Database=#db>,
{
use ::sqlx_record::prelude::{Filter, bind_values};
if filters.is_empty() {
// Require at least one filter to prevent accidental table-wide updates
return Err(sqlx::Error::Protocol(
"update_by_filter requires at least one filter to prevent accidental table-wide updates".to_string()
));
}
let (update_stmt, form_values) = form.update_stmt_with_values();
if update_stmt.is_empty() {
return Ok(0);
}
let form_param_count = form_values.len();
let (where_conditions, filter_values) = Filter::build_where_clause_with_offset(&filters, form_param_count + 1);
let query_str = format!(
r#"UPDATE {}{}{} SET {} WHERE {}"#,
#tq, Self::table_name(), #tq,
update_stmt,
where_conditions,
);
// Combine form values and filter values
let mut all_values = form_values;
all_values.extend(filter_values);
let query = sqlx::query(&query_str);
let result = bind_values(query, &all_values)
.execute(executor)
.await?;
Ok(result.rows_affected())
}
}
}
}
// Generate delete implementation - always generated for ALL entities
fn generate_delete_impl(
name: &Ident,
table_name: &str,
primary_key: &EntityField,
impl_generics: &ImplGenerics,
ty_generics: &TypeGenerics,
where_clause: &Option<&WhereClause>,
) -> TokenStream2 {
let pk_field = &primary_key.ident;
let pk_type = &primary_key.ty;
let pk_db_name = &primary_key.db_name;
let db = db_type();
let tq = table_quote();
let pk_field_name = primary_key.ident.to_string();
let hard_delete_by_func = format_ident!("hard_delete_by_{}", pk_field_name);
quote! {
impl #impl_generics #name #ty_generics #where_clause {
/// Hard delete - permanently removes the row from database
pub async fn hard_delete<'a, E>(&self, executor: E) -> Result<(), sqlx::Error>
where
E: sqlx::Executor<'a, Database = #db>,
{
Self::#hard_delete_by_func(executor, &self.#pk_field).await
}
/// Hard delete by primary key - permanently removes the row from database
pub async fn #hard_delete_by_func<'a, E>(executor: E, #pk_field: &#pk_type) -> Result<(), sqlx::Error>
where
E: sqlx::Executor<'a, Database = #db>,
{
let query = format!(
"DELETE FROM {}{}{} WHERE {} = {}",
#tq, #table_name, #tq,
#pk_db_name, ::sqlx_record::prelude::placeholder(1)
);
sqlx::query(&query).bind(#pk_field).execute(executor).await?;
Ok(())
}
}
}
}
@ -1482,51 +1516,41 @@ fn generate_soft_delete_impl(
let tq = table_quote();
let pk_field_name = primary_key.ident.to_string();
let delete_by_func = format_ident!("delete_by_{}", pk_field_name);
let hard_delete_by_func = format_ident!("hard_delete_by_{}", pk_field_name);
let soft_delete_by_func = format_ident!("soft_delete_by_{}", pk_field_name);
let restore_by_func = format_ident!("restore_by_{}", pk_field_name);
// Determine semantics based on field name and attribute:
// - #[soft_delete] attribute: field should be FALSE when deleted (user convention)
// - `is_active` by name: FALSE when deleted, TRUE when active
// - `is_deleted`/`deleted` by name: TRUE when deleted, FALSE when active
let sd_field_name = sd_field.ident.to_string();
let is_inverted = sd_field.is_soft_delete || sd_field_name == "is_active";
let (delete_value, restore_value) = if is_inverted {
("FALSE", "TRUE")
} else {
("TRUE", "FALSE")
};
quote! {
impl #impl_generics #name #ty_generics #where_clause {
/// Soft delete - sets the soft_delete field to true
pub async fn delete<'a, E>(&self, executor: E) -> Result<(), sqlx::Error>
/// Soft delete - marks record as deleted without removing from database
pub async fn soft_delete<'a, E>(&self, executor: E) -> Result<(), sqlx::Error>
where
E: sqlx::Executor<'a, Database = #db>,
{
Self::#delete_by_func(executor, &self.#pk_field).await
Self::#soft_delete_by_func(executor, &self.#pk_field).await
}
/// Soft delete by primary key
pub async fn #delete_by_func<'a, E>(executor: E, #pk_field: &#pk_type) -> Result<(), sqlx::Error>
pub async fn #soft_delete_by_func<'a, E>(executor: E, #pk_field: &#pk_type) -> Result<(), sqlx::Error>
where
E: sqlx::Executor<'a, Database = #db>,
{
let query = format!(
"UPDATE {}{}{} SET {} = TRUE WHERE {} = {}",
#tq, #table_name, #tq,
#sd_db_name,
#pk_db_name, ::sqlx_record::prelude::placeholder(1)
);
sqlx::query(&query).bind(#pk_field).execute(executor).await?;
Ok(())
}
/// Hard delete - permanently removes the row from database
pub async fn hard_delete<'a, E>(&self, executor: E) -> Result<(), sqlx::Error>
where
E: sqlx::Executor<'a, Database = #db>,
{
Self::#hard_delete_by_func(executor, &self.#pk_field).await
}
/// Hard delete by primary key
pub async fn #hard_delete_by_func<'a, E>(executor: E, #pk_field: &#pk_type) -> Result<(), sqlx::Error>
where
E: sqlx::Executor<'a, Database = #db>,
{
let query = format!(
"DELETE FROM {}{}{} WHERE {} = {}",
"UPDATE {}{}{} SET {} = {} WHERE {} = {}",
#tq, #table_name, #tq,
#sd_db_name, #delete_value,
#pk_db_name, ::sqlx_record::prelude::placeholder(1)
);
sqlx::query(&query).bind(#pk_field).execute(executor).await?;
@ -1547,9 +1571,9 @@ fn generate_soft_delete_impl(
E: sqlx::Executor<'a, Database = #db>,
{
let query = format!(
"UPDATE {}{}{} SET {} = FALSE WHERE {} = {}",
"UPDATE {}{}{} SET {} = {} WHERE {} = {}",
#tq, #table_name, #tq,
#sd_db_name,
#sd_db_name, #restore_value,
#pk_db_name, ::sqlx_record::prelude::placeholder(1)
);
sqlx::query(&query).bind(#pk_field).execute(executor).await?;

View File

@ -1,13 +1,13 @@
use sqlx::pool::PoolConnection;
#[cfg(feature = "mysql")]
use sqlx::{MySql, MySqlPool};
use sqlx::{MySql, MySqlConnection, MySqlPool, Transaction};
#[cfg(feature = "postgres")]
use sqlx::{Postgres, PgPool};
use sqlx::{Postgres, PgConnection, PgPool, Transaction};
#[cfg(feature = "sqlite")]
use sqlx::{Sqlite, SqlitePool};
use sqlx::{Sqlite, SqliteConnection, SqlitePool, Transaction};
// ============================================================================
// MySQL Implementation
@ -24,6 +24,10 @@ pub enum ConnProvider<'a> {
pool: MySqlPool,
conn: Option<PoolConnection<MySql>>,
},
/// Stores a reference to a transaction
Transaction {
tx: &'a mut Transaction<'static, MySql>,
},
}
#[cfg(feature = "mysql")]
@ -38,18 +42,25 @@ impl<'a> ConnProvider<'a> {
ConnProvider::Owned { pool, conn: None }
}
/// Create a ConnProvider from a borrowed transaction reference
pub fn from_tx(tx: &'a mut Transaction<'static, MySql>) -> Self {
ConnProvider::Transaction { tx }
}
/// Get a mutable reference to the underlying connection.
/// For borrowed connections, returns the reference directly.
/// For owned connections, lazily acquires from pool on first call.
pub async fn get_conn(&mut self) -> Result<&mut PoolConnection<MySql>, sqlx::Error> {
/// For transactions, returns the transaction's underlying connection.
pub async fn get_conn(&mut self) -> Result<&mut MySqlConnection, sqlx::Error> {
match self {
ConnProvider::Borrowed { conn } => Ok(conn),
ConnProvider::Borrowed { conn } => Ok(&mut **conn),
ConnProvider::Owned { pool, conn } => {
if conn.is_none() {
*conn = Some(pool.acquire().await?);
}
Ok(conn.as_mut().unwrap())
Ok(&mut **conn.as_mut().unwrap())
}
ConnProvider::Transaction { tx } => Ok(&mut **tx),
}
}
}
@ -69,6 +80,10 @@ pub enum ConnProvider<'a> {
pool: PgPool,
conn: Option<PoolConnection<Postgres>>,
},
/// Stores a reference to a transaction
Transaction {
tx: &'a mut Transaction<'static, Postgres>,
},
}
#[cfg(feature = "postgres")]
@ -83,18 +98,25 @@ impl<'a> ConnProvider<'a> {
ConnProvider::Owned { pool, conn: None }
}
/// Create a ConnProvider from a borrowed transaction reference
pub fn from_tx(tx: &'a mut Transaction<'static, Postgres>) -> Self {
ConnProvider::Transaction { tx }
}
/// Get a mutable reference to the underlying connection.
/// For borrowed connections, returns the reference directly.
/// For owned connections, lazily acquires from pool on first call.
pub async fn get_conn(&mut self) -> Result<&mut PoolConnection<Postgres>, sqlx::Error> {
/// For transactions, returns the transaction's underlying connection.
pub async fn get_conn(&mut self) -> Result<&mut PgConnection, sqlx::Error> {
match self {
ConnProvider::Borrowed { conn } => Ok(conn),
ConnProvider::Borrowed { conn } => Ok(&mut **conn),
ConnProvider::Owned { pool, conn } => {
if conn.is_none() {
*conn = Some(pool.acquire().await?);
}
Ok(conn.as_mut().unwrap())
Ok(&mut **conn.as_mut().unwrap())
}
ConnProvider::Transaction { tx } => Ok(&mut **tx),
}
}
}
@ -114,6 +136,10 @@ pub enum ConnProvider<'a> {
pool: SqlitePool,
conn: Option<PoolConnection<Sqlite>>,
},
/// Stores a reference to a transaction
Transaction {
tx: &'a mut Transaction<'static, Sqlite>,
},
}
#[cfg(feature = "sqlite")]
@ -128,18 +154,25 @@ impl<'a> ConnProvider<'a> {
ConnProvider::Owned { pool, conn: None }
}
/// Create a ConnProvider from a borrowed transaction reference
pub fn from_tx(tx: &'a mut Transaction<'static, Sqlite>) -> Self {
ConnProvider::Transaction { tx }
}
/// Get a mutable reference to the underlying connection.
/// For borrowed connections, returns the reference directly.
/// For owned connections, lazily acquires from pool on first call.
pub async fn get_conn(&mut self) -> Result<&mut PoolConnection<Sqlite>, sqlx::Error> {
/// For transactions, returns the transaction's underlying connection.
pub async fn get_conn(&mut self) -> Result<&mut SqliteConnection, sqlx::Error> {
match self {
ConnProvider::Borrowed { conn } => Ok(conn),
ConnProvider::Borrowed { conn } => Ok(&mut **conn),
ConnProvider::Owned { pool, conn } => {
if conn.is_none() {
*conn = Some(pool.acquire().await?);
}
Ok(conn.as_mut().unwrap())
Ok(&mut **conn.as_mut().unwrap())
}
ConnProvider::Transaction { tx } => Ok(&mut **tx),
}
}
}

View File

@ -111,6 +111,121 @@ pub fn placeholder(index: usize) -> String {
}
}
/// Returns the table quote character for the current database
#[inline]
pub fn table_quote() -> &'static str {
#[cfg(feature = "mysql")]
{ "`" }
#[cfg(feature = "postgres")]
{ "\"" }
#[cfg(feature = "sqlite")]
{ "\"" }
#[cfg(not(any(feature = "mysql", feature = "postgres", feature = "sqlite")))]
{ "`" }
}
/// Builds an index hint clause (MySQL-specific, empty for other databases)
#[inline]
pub fn build_index_clause(index: Option<&str>) -> String {
#[cfg(feature = "mysql")]
{
index.map(|idx| format!("USE INDEX ({})", idx)).unwrap_or_default()
}
#[cfg(not(feature = "mysql"))]
{
let _ = index;
String::new()
}
}
/// Builds a COUNT expression appropriate for the database backend
#[inline]
pub fn build_count_expr(field: &str) -> String {
#[cfg(feature = "postgres")]
{
format!("COUNT({})::BIGINT", field)
}
#[cfg(feature = "sqlite")]
{
format!("COUNT({})", field)
}
#[cfg(feature = "mysql")]
{
format!("CAST(COUNT({}) AS SIGNED)", field)
}
#[cfg(not(any(feature = "mysql", feature = "postgres", feature = "sqlite")))]
{
format!("COUNT({})", field)
}
}
/// Builds an upsert statement for the current database backend
pub fn build_upsert_stmt(
table_name: &str,
all_fields: &[&str],
pk_field: &str,
non_pk_fields: &[&str],
placeholders: &str,
) -> String {
let tq = table_quote();
let fields_str = all_fields.join(", ");
#[cfg(feature = "mysql")]
{
let _ = pk_field; // Not used in MySQL ON DUPLICATE KEY syntax
let update_clause = non_pk_fields
.iter()
.map(|f| format!("{} = VALUES({})", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON DUPLICATE KEY UPDATE {}",
tq, table_name, tq, fields_str, placeholders, update_clause
)
}
#[cfg(feature = "postgres")]
{
let update_clause = non_pk_fields
.iter()
.map(|f| format!("{} = EXCLUDED.{}", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON CONFLICT ({}) DO UPDATE SET {}",
tq, table_name, tq, fields_str, placeholders, pk_field, update_clause
)
}
#[cfg(feature = "sqlite")]
{
let update_clause = non_pk_fields
.iter()
.map(|f| format!("{} = excluded.{}", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON CONFLICT({}) DO UPDATE SET {}",
tq, table_name, tq, fields_str, placeholders, pk_field, update_clause
)
}
#[cfg(not(any(feature = "mysql", feature = "postgres", feature = "sqlite")))]
{
let _ = pk_field; // Not used in MySQL ON DUPLICATE KEY syntax
// Fallback to MySQL syntax
let update_clause = non_pk_fields
.iter()
.map(|f| format!("{} = VALUES({})", f, f))
.collect::<Vec<_>>()
.join(", ");
format!(
"INSERT INTO {}{}{} ({}) VALUES ({}) ON DUPLICATE KEY UPDATE {}",
tq, table_name, tq, fields_str, placeholders, update_clause
)
}
}
impl Filter<'_> {
/// Returns the number of bind parameters this filter will use
pub fn param_count(&self) -> usize {

View File

@ -181,6 +181,7 @@ pub mod prelude {
pub use crate::values;
pub use crate::{new_uuid, lookup_table, lookup_options, transaction};
pub use crate::pagination::{Page, PageRequest};
pub use crate::conn_provider::*;
#[cfg(any(feature = "mysql", feature = "postgres", feature = "sqlite"))]
pub use crate::conn_provider::ConnProvider;

View File

@ -1,5 +1,5 @@
use sqlx::query::{Query, QueryAs, QueryScalar};
use sqlx::types::chrono::{NaiveDate, NaiveDateTime};
use sqlx::types::chrono::{NaiveDate, NaiveDateTime, NaiveTime};
use crate::filter::placeholder;
// Database type alias based on enabled feature
@ -34,6 +34,7 @@ pub type Arguments_<'q> = sqlx::postgres::PgArguments;
#[derive(Clone, Debug)]
pub enum Value {
Null,
Int8(i8),
Uint8(u8),
Int16(i16),
@ -42,12 +43,18 @@ pub enum Value {
Uint32(u32),
Int64(i64),
Uint64(u64),
Float32(f32),
Float64(f64),
VecU8(Vec<u8>),
String(String),
Bool(bool),
Uuid(uuid::Uuid),
NaiveDate(NaiveDate),
NaiveDateTime(NaiveDateTime),
NaiveTime(NaiveTime),
Json(serde_json::Value),
#[cfg(feature = "decimal")]
Decimal(rust_decimal::Decimal),
}
/// Expression for column updates beyond simple value assignment.
@ -249,10 +256,12 @@ impl UpdateExpr {
pub type SqlValue = Value;
// MySQL supports unsigned integers natively
// Note: UUID is bound as bytes for BINARY(16) column compatibility
#[cfg(feature = "mysql")]
macro_rules! bind_value {
($query:expr, $value: expr) => {{
let query = match $value {
Value::Null => $query.bind(None::<String>),
Value::Int8(v) => $query.bind(v),
Value::Uint8(v) => $query.bind(v),
Value::Int16(v) => $query.bind(v),
@ -261,12 +270,18 @@ macro_rules! bind_value {
Value::Uint32(v) => $query.bind(v),
Value::Int64(v) => $query.bind(v),
Value::Uint64(v) => $query.bind(v),
Value::Float32(v) => $query.bind(v),
Value::Float64(v) => $query.bind(v),
Value::VecU8(v) => $query.bind(v),
Value::String(v) => $query.bind(v),
Value::Bool(v) => $query.bind(v),
Value::Uuid(v) => $query.bind(v),
Value::NaiveDate(v) => $query.bind(v),
Value::NaiveDateTime(v) => $query.bind(v),
Value::NaiveTime(v) => $query.bind(v),
Value::Json(v) => $query.bind(v),
#[cfg(feature = "decimal")]
Value::Decimal(v) => $query.bind(v),
};
query
}};
@ -277,6 +292,7 @@ macro_rules! bind_value {
macro_rules! bind_value {
($query:expr, $value: expr) => {{
let query = match $value {
Value::Null => $query.bind(None::<String>),
Value::Int8(v) => $query.bind(v),
Value::Uint8(v) => $query.bind(*v as i16),
Value::Int16(v) => $query.bind(v),
@ -285,12 +301,18 @@ macro_rules! bind_value {
Value::Uint32(v) => $query.bind(*v as i64),
Value::Int64(v) => $query.bind(v),
Value::Uint64(v) => $query.bind(*v as i64),
Value::Float32(v) => $query.bind(v),
Value::Float64(v) => $query.bind(v),
Value::VecU8(v) => $query.bind(v),
Value::String(v) => $query.bind(v),
Value::Bool(v) => $query.bind(v),
Value::Uuid(v) => $query.bind(v),
Value::NaiveDate(v) => $query.bind(v),
Value::NaiveDateTime(v) => $query.bind(v),
Value::NaiveTime(v) => $query.bind(v),
Value::Json(v) => $query.bind(v),
#[cfg(feature = "decimal")]
Value::Decimal(v) => $query.bind(v),
};
query
}};
@ -309,10 +331,13 @@ pub fn bind_values<'q>(query: Query<'q, DB, Arguments_<'q>>, values: &'q [Value]
#[cfg(any(feature = "mysql", feature = "postgres", feature = "sqlite"))]
pub fn bind_value_owned<'q>(query: Query<'q, DB, Arguments_<'q>>, value: Value) -> Query<'q, DB, Arguments_<'q>> {
match value {
Value::Null => query.bind(None::<String>),
Value::Int8(v) => query.bind(v),
Value::Int16(v) => query.bind(v),
Value::Int32(v) => query.bind(v),
Value::Int64(v) => query.bind(v),
Value::Float32(v) => query.bind(v),
Value::Float64(v) => query.bind(v),
#[cfg(feature = "mysql")]
Value::Uint8(v) => query.bind(v),
#[cfg(feature = "mysql")]
@ -335,6 +360,10 @@ pub fn bind_value_owned<'q>(query: Query<'q, DB, Arguments_<'q>>, value: Value)
Value::Uuid(v) => query.bind(v),
Value::NaiveDate(v) => query.bind(v),
Value::NaiveDateTime(v) => query.bind(v),
Value::NaiveTime(v) => query.bind(v),
Value::Json(v) => query.bind(v),
#[cfg(feature = "decimal")]
Value::Decimal(v) => query.bind(v),
}
}
@ -530,6 +559,79 @@ impl From<&NaiveDateTime> for Value {
}
}
// New type implementations
impl From<f32> for Value {
fn from(value: f32) -> Self {
Value::Float32(value)
}
}
impl From<&f32> for Value {
fn from(value: &f32) -> Self {
Value::Float32(*value)
}
}
impl From<f64> for Value {
fn from(value: f64) -> Self {
Value::Float64(value)
}
}
impl From<&f64> for Value {
fn from(value: &f64) -> Self {
Value::Float64(*value)
}
}
impl From<NaiveTime> for Value {
fn from(value: NaiveTime) -> Self {
Value::NaiveTime(value)
}
}
impl From<&NaiveTime> for Value {
fn from(value: &NaiveTime) -> Self {
Value::NaiveTime(*value)
}
}
impl From<serde_json::Value> for Value {
fn from(value: serde_json::Value) -> Self {
Value::Json(value)
}
}
impl From<&serde_json::Value> for Value {
fn from(value: &serde_json::Value) -> Self {
Value::Json(value.clone())
}
}
#[cfg(feature = "decimal")]
impl From<rust_decimal::Decimal> for Value {
fn from(value: rust_decimal::Decimal) -> Self {
Value::Decimal(value)
}
}
#[cfg(feature = "decimal")]
impl From<&rust_decimal::Decimal> for Value {
fn from(value: &rust_decimal::Decimal) -> Self {
Value::Decimal(*value)
}
}
// Option<T> implementations - convert None to Value::Null
impl<T: Into<Value>> From<Option<T>> for Value {
fn from(value: Option<T>) -> Self {
match value {
Some(v) => v.into(),
None => Value::Null,
}
}
}
pub trait BindValues<'q> {
type Output;