代码拉取完成，页面将自动刷新
根据结构体定义同步生成数据库表结构，简化增删改操作和大部分的单表查询操作，省去大部分手写 sql 语句和 bind 参数操作。
当前仅支持 postgres 数据库。
目标是帮助大部分 sql 功能开发节省心思，而不是覆盖全部的 sql 功能。
在 Cargo.toml 中添加依赖
[dependencies]
# easy-sqlx-core = { git = "https://gitee.com/knowgo/easy-sqlx.git", features = ["postgres"] }
# easy-sqlx = { git = "https://gitee.com/knowgo/easy-sqlx.git" }
tokio = { version = "1", features = ["full"] }
easy-sqlx-core = { features = ["postgres"], version = "^0" }
easy-sqlx = { version = "^0.8" }
sqlx = { version = "^0", features = [
"runtime-async-std",
"tls-native-tls",
"postgres",
"macros",
"chrono",
] }
tracing = { version = "0.1.40" }
tracing-subscriber = { version = "0.3.18" } # , features = ["env-filter"] }
chrono = { version = "0.4", features = ["serde"] }
定义表结构 #[derive(Table)]
use easy_sqlx::WhereAppend; // 引用 WhereAppend
#[derive(Table, FromRow, Debug)]
#[table(
indexes [
(name = "name_index_1", columns("name"))
]
)]
#[index(columns("name"))]
struct User {
#[col(column = "key", comment = "123")]
#[col(pk)]
pub id: i64,
#[col(comment = "姓名", len = 20)]
pub name: Option<String>,
pub blob: Option<Vec<u8>>,
#[col()]
pub create_time: Option<chrono::NaiveTime>,
}
不同步表结构的话，只需要使用 Table 和 col(pk) 即可，可空字段必须为 Option<data_type>
table 属性
name 表名称
query_only 只做查询操作，含此属性的结构体不同步表结构，不生成增删改代码
comment 注释，会添加到字段对应的每一个操作函数的注释中
schema 表空间
from 从另一个表 rename 而来
recreate 重新创建表,在同一个数据库中不会重复操作，直到修改其值
trim_columns 清理 struct 中未定义的数据库列
trim_indexes 清理 table 未定义的索引
indexes 索引数组，参见索引
index 属性，可定义在 table 属性内，也可以单独定义到 struct
name 索引名称
columns() 索引的列，字符串数组，使用小括号包围
unique 是否唯一索引
col 属性,Option 包裹的列为 nullable ，否则为必填
ignore 忽略，不与数据库关联
pk 主键
autoincr 自增类型
column 字段名称
len 长度，字符串长度或精度
col_type sql 数据类型，用于自定义数据库类型
comment 说明
default 默认值
from[未完成] 从另一个字段重命名而来
replace 如果修改数据类型发生错误时，删除原字段，重新创建
同步表结构，参数 connection 为数据库连接
sync_tables(connection, vec![User::table()]).await?;
let user = User {
id: 1,
name: Some("test".to_string()),
..Default::default()
};
user.insert().execute(&mut conn).await.unwrap();
User::build_insert()
.set(User::id(2)) // 设置字段值，未设置的为 null
.execute(&mut conn)
.await
.unwrap();
let user = User {
id: 1,
name: Some("test---1".to_string()),
..Default::default()
};
user.update().execute(&mut conn).await.unwrap();
User::build_update()
.set(User::name("007".to_string()))
.and(User::id_eq(2))
.execute(&mut conn)
.await
.unwrap();
User::update_by_id(2)
.set(User::name("by_id"))
.execute(&mut conn)
.await
.unwrap();
接收 User::*() 参数，其中 * 为字段名称，括号内为要设置的值 对于可空字段，即 Option 包裹的字段，还可以使用 User::*_opt() 函数来设置值， 此时可以传入 None 来设置字段为 null
let user = User {
id: 1, // 主键值为 1
name: Some("test---1".to_string()),
..Default::default()
};
user.delete().execute(&mut conn).await.unwrap();
User::delete_by_id(2).execute(&mut conn).await.unwrap();
User::build_delete()
.and(User::id_eq(2)) // 删除 id 为 2 的记录
.execute(&mut conn).await.unwrap();
增删改调用的 execute 函数，有对应 execute_return 函数， 此函数可以返回该条语句插入、修改、或删除的记录
let u: User = User::select_by_id(1) // 联合主键会有多个参数
.one(&mut conn).await.unwrap();
println!("{:?}", u);
User::select() // 生成 SelectBuilder
.and(User::id_eq(1)) // 查询条件 id = 1
.one(&mut conn).await.unwrap();
let umap: HashMap<i64, User> = User::select()
.map_all(&mut conn, |o: &User| o.id)
.await
.unwrap();
println!("{:?}", umap);
let max: Option<i64> = User::select()
.optional_scalar(&mut conn, &User::col_id().max())
.await
.unwrap();
println!("max: {}", min.unwrap());
let min: Option<i64> = User::select()
.optional_scalar(&mut conn, &User::col_id().min())
.await
.unwrap();
println!("min: {}", min.unwrap());
let wh = Where::new(User::id_gt(0)); // id > 0
let mut page_result: PageResult<User> = User::select()
.and(wh.clone())
.order_by(User::id_asc()) // id 升序
.page(&mut conn, &PageRequest::new(10, 1))
.await
.unwrap();
// 统计分页信息
page_result.set_total( User::select().and(wh).count(&mut conn).await.unwrap());
select_by_id 和 select 返回一个与表关联的 SelectBuilder 对象。
SelectBuilder 提供了查询条件的添加和组合功能，并支持排序条件
and 和 or 为添加查询条件函数，首次添加条件时 and 和 or 功能一致，再次添加时
and(cond) : cond 将于前面所有的条件进行 and 操作
or(cond) : cond 将于前面所有的条件进行 or 操作
参数 cond 也可以是 Where 对象，Where 对象可以包含多个条件
实际上，查询本身的条件也是 Where 对象。
每一个查询条件项都使用类似 User::*_eq() 的函数生成，其中 * 为字段名称，
下线线之后表示操作符，当前支持
eq =
gt >
ge >=
lt <
le <=
neq <>
like like
以及接收数组(注意：调用前要保证数组不为 empty)作为参数的
in in ()
not_in not in ()
和没有参数的
is_null
is_not_null
SelectBuilder 提供以下几种获取数据的方法
one 获取一条记录
optional 获取一条记录，如果不存在返回 None
all 获取全部记录
map_all 以 HashMap 形式返回查询结果
page 分页查询
count 查询记录数
one_scalar 获取一个标量
optional_scalar 获取一个可选标量，如果不存在返回 None
all_scalars 获取全部标量
page_scalars 分页获取标量
#[derive(Table, Default, Debug, Clone, FromRow)]
#[table(name = "User", query_only)] // name 属性指定表名称， query_only 表示只生成查询相关代码
pub struct UserSummary {
#[col(pk)]
pub id: i64,
pub name: String,
}
let u: UserSummary = UserSummary::select_by_id(1)
.one(&mut conn).await.unwrap();
println!("{:?}", u);
修改 Cargo.toml
easy-sqlx-core = { features = ["postgres", "logsql"], version = "^0" }
程序启动时，订阅日志
let layer = tracing_subscriber::fmt::layer()
.with_file(true)
.with_line_number(true)
.with_filter(tracing_subscriber::filter::LevelFilter::INFO);
Registry::default().with(layer).init();
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
马建仓 AI 助手