sqlx-xugu

基于 sqlx 的 rust 虚谷数据库驱动。

支持虚谷数据库 v11/v12。

Install

添加依赖，注意版本要跟 sqlx 保持一致

# Cargo.toml
sqlx = { version = "=0.8.6", features = ["runtime-tokio"] }
sqlx-xugu = { version = "0.8.6-2" }

Cargo Feature Flags

添加 feature, 注意要跟 sqlx 保持一致

# Cargo.toml
sqlx = { version = "=0.8.6", features = ["runtime-tokio", "chrono", "uuid", "rust_decimal", "bigdecimal", "time"] }
sqlx-xugu = { version = "0.8.6-2", features = ["chrono", "uuid", "rust_decimal", "bigdecimal", "time"] }

• uuid: 添加对 UUID 的支持。

• chrono: 添加对 chrono 中的日期和时间类型的支持。

• time: 添加对 time crate 中的日期和时间类型的支持 (alternative to chrono, which is preferred by query! macro, if both enabled)

• bigdecimal: 使用 bigdecimal crate 添加对 NUMERIC 的支持。

• rust_decimal: 使用 rust_decimal crate 添加对 NUMERIC 的支持。

• json: 使用 serde_json crate 添加对 JSON 的支持。

Usage

快速入门

use sqlx_xugu::XuguPoolOptions;

#[tokio::main] // Requires the `attributes` feature of `tokio`
// or #[async_std::main]
// or #[actix_web::main]
async fn main() -> Result<(), sqlx::Error> {
    // Create a connection pool
    //  for Xugu, use XuguPoolOptions::new()
    let pool = XuguPoolOptions::new()
        .max_connections(5)
        .connect("xugu://user:[email protected]:5138/SYSTEM").await?;

    // 进行简单的查询以返回给定的参数 (使用问号 `?` 占位符)
    let row: (i64,) = sqlx::query_as("SELECT ?")
        .bind(150_i64)
        .fetch_one(&pool).await?;

    assert_eq!(row.0, 150);

    Ok(())
}

建立连接

可以使用 XuguConnection 并调用 connect() 建立单个连接。

use sqlx::Connection;
use sqlx_xugu::XuguConnection;

let conn = XuguConnection::connect("xugu://user:[email protected]:5138/SYSTEM").await?;

通常，您需要为应用程序创建一个连接池 (sqlx::Pool) 来调节它正在使用的服务器端连接数。

let pool = XuguPool::connect("xugu://user:[email protected]:5138/SYSTEM").await?;

// 指定连接池大小和连接时间等参数
let pool = XuguPoolOptions::new()
    .max_connections(50)
    .acquire_timeout(std::time::Duration::from_secs(5))
    .idle_timeout(std::time::Duration::from_secs(300))
    .max_lifetime(std::time::Duration::from_secs(86400))
    .connect("xugu://user:[email protected]:5138/SYSTEM?ssl=ssl")
    .await?;

sqlx-xugu 驱动url格式，支持以下几种

1. xugu://ip:port/databaseName[?property=value[&property=value]]
  * 例：xugu://127.0.0.1:5138/SYSTEM?user=GUEST&password=GUEST&version=301&time_zone=GMT

2. xugu://user:passwd@ip:port/databaseName[?property=value[&property=value]]
  * 例：xugu://GUEST:[email protected]:5138/SYSTEM?version=301&time_zone=GMT

连接参数

更多请参考 sqlx 相关文档

• docs.rs: https://docs.rs/sqlx/latest/sqlx/
• Github: https://github.com/launchbadge/sqlx
• crates.io: https://crates.io/crates/sqlx

联系方式

• Bug 反馈: GitHub Issues
• 一般讨论: GitHub Discussions
• 商务合作: [email protected]

许可证

MIT or Apache 2.0

免责声明

sqlx-xugu 跟 成都虚谷伟业科技有限公司 不构成任何知识产权归属关系。这个程序不含任何担保。

软件以“现状”提供，不提供任何明示或暗示的保证，包括但不限于可销性、特定用途适用性和非侵权等保证。 无论如何，作者或版权持有人对因软件或软件使用或其他交易产生的、涉及合同、侵权或其他诉讼的索赔、损害或其他责任均不承担责任。