crates.io Documentation MIT

include-sqlite-sql is an extension of include-sql for using SQLite SQL in Rust. It completes include-sql by providing impl_sql macro to generate database access methods from the included SQL. include-sqlite-sql uses Rusqlite for database access.

Example

Write your SQL and save it in a file. For example, let's say the following is saved as library.sql in the project's src folder:

```sql -- name: getloanedbooks? -- Returns the list of books loaned to a patron -- # Parameters -- param: userid: &str - user ID SELECT booktitle FROM library WHERE loanedto = :userid ORDER BY 1;

-- name: loanbooks! -- Updates the book records to reflect loan to a patron -- # Parameters -- param: userid: &str - user ID -- param: bookids: u32 - book IDs UPDATE library SET loanedto = :userid , loanedon = currenttimestamp WHERE bookid IN (:book_ids); ```

And then use it in Rust as:

```rust , ignore use includesqlitesql::{includesql, implsql}; use rusqlite::{Result, Connection};

include_sql!("src/library.sql");

fn main() -> Result<()> { let args : Vec = std::env::args().collect(); let dbpath = &args[1]; let user_id = &args[2];

let db = Connection::open(dbpath)?;

db.get_loaned_books(user_id, |row| {
    let book_title : &str = row.get_ref("book_title")?.as_str()?;
    println!("{}", book_title);
    Ok(())
})?;

Ok(())

} ```

Documentation

The included documentation describes the supported SQL file format and provides additional details on the generated code.