# serde_sql
[](https://crates.io/crates/serde_sql)
[](https://docs.rs/serde_sql)
[](https://github.com/JakkuSakura/serde_sql/actions)
`serde_sql` streams [`serde::Serialize`](https://docs.rs/serde/latest/serde/trait.Serialize.html)
structs directly into SQLite statements without allocating intermediate field structures.
You provide a `String` buffer and value; the crate appends the literal value list `(v1, v2, …)` so
you can embed it in any SQL template. When bootstrapping tables, the crate can also infer a basic
`CREATE TABLE` definition from an example record.
## Features
- Zero-copy output: serialise straight into an existing `String`.
- Handles `Option`, numbers, booleans, and strings with proper escaping.
- Nested structures (maps/arrays) are emitted as JSON text literals.
## Quick start
```toml
[dependencies]
serde_sql = "0.1"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
```
```rust
use serde::Serialize;
use serde_sql::{infer_table_ddl, serialize_insert};
#[derive(Serialize)]
struct User {
id: u64,
name: String,
active: bool,
notes: Option<String>,
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut insert = String::new();
insert.push_str("INSERT INTO users VALUES ");
serialize_insert(
&mut insert,
&User {
id: 1,
name: "Alice".into(),
active: true,
notes: Some("admin".into()),
},
)?;
let ddl = infer_table_ddl(
"users",
&User {
id: 0,
name: "example".into(),
active: false,
notes: None,
},
)?;
assert_eq!(insert, "INSERT INTO users VALUES (1, 'Alice', 1, 'admin')");
assert_eq!(
ddl,
r#"CREATE TABLE IF NOT EXISTS "users" (
"id" INTEGER NOT NULL,
"name" TEXT NOT NULL,
"active" INTEGER NOT NULL,
"notes" TEXT
);"#
);
Ok(())
}
```
### Example
```sh
cargo run --example basic
cargo run --example ddl
```
## Testing
```sh
cargo test
```
## Documentation
- API docs can be generated locally via `cargo doc --open`.
- Additional usage notes live under `docs/usage.md`.