Crate dysql

Do dynamic-sql query through proc-macro

It bases on [sqlx] crate (default feature), you can switch them by setting the features. It uses [Ramhorns-ext] the high performance template engine implementation of [Mustache]

Example (Sqlx)

main.rs

//...
 
async fn main() {
    let conn = connect_postgres_db().await;
     
    // fetch all
    let dto = UserDto{ id: None, name: None, age: Some(15) };
    let rst = fetch_all!(|&dto, &conn| -> User {
        r#"SELECT * FROM test_user 
        WHERE 1 = 1
          {{#name}}AND name = :name{{/name}}
          {{#age}}AND age > :age{{/age}}
        ORDER BY id"#
    }).unwrap();
    assert_eq!(
        vec![
            User { id: 2, name: Some("zhanglan".to_owned()), age: Some(21) }, 
            User { id: 3, name: Some("zhangsan".to_owned()), age: Some(35) }
        ], 
        rst
    );
 
    let rst = fetch_one!(...).unwrap();
 
    let rst = fetch_scalar!(...).unwrap();
     
    let affected_rows_num = execute!(...).unwrap();
     
    let insert_id = insert!(...).unwrap();
 
    sql!('sql_fragment_1', "select * from table1");
    let rst = fetch_one!(|...| sql_fragment_1 + "where age > 10").unwrap();
 
    let mut page_dto = ...;
    let pagination = page!(|&mut page_dto, &conn| -> User).unwrap();
}

Example (sqlx)

Full example please see: Dysql sqlx example

Modules

• encoding
  Utilities dealing with writing the bits of a template or data to the output and escaping special HTML characters.
• traits
  This module contains helper traits that are used internally to manage sequences of types implementing the Content trait, allowing us to statically manage parent section lookups without doing extra work on runtime.

Macros

• execute
  Execute query
• fetch_all
  fetch all datas that filtered by dto
• fetch_one
  fetch one data that filtered by dto
• fetch_scalar
  Fetch a scalar value from query
• insert
  Insert data Note: if you use this macro under postgres database, you should add “returning id” at the end of sql statement by yourself.
• page
  page query
• sql
  Define a global sql fragment

Structs

• DySqlError
• DysqlContext
• EmptyObject
• ErrorInner
• PageDto
• Pagination
• ParseSqlError
• Ramhorns
  Aggregator for Templates, that allows them to be loaded from the file system and use partials: {{>partial}}
• Section
  A section of a Template that can be rendered individually, usually delimited by {{#section}} ... {{/section}} tags.
• SimpleInnerError
• SimpleSection
  SimpleSection 是用于参数值绑定的 section
• SimpleTemplate
  用于在 SQL 中绑定 DTO 值的简化模版
• SortModel
• Template
  A preprocessed form of the plain text template, ready to be rendered with data contained in types implementing the Content trait.
• Value

Enums

• Kind
• SimpleValue
• SqlDialect
• TemplateError
  Error type used that can be emitted during template parsing.

Statics

• SQL_TEMPLATE_CACHE

Traits

• Content
  Trait allowing the rendering to quickly access data stored in the type that implements it. You needn’t worry about implementing it, in virtually all cases the #[derive(Content)] attribute above your types should be sufficient.

Functions

• extract_params_buf
  extract sql and params from raw sql
• gen_named_sql
• get_sql_template
• get_sql_template_cache
• hash_it
• put_sql_template
• save_sql_template

Type Aliases

• DySqlResult
• ParseSqlResult
• SimpleError

Derive Macros

• Content