sql_db_mapper

一个用于生成Rust数据库映射的命令行工具。

连接到PostgreSQL数据库，并创建一个Rust模块，其中包含映射存储函数/过程的完整模式。

使用tokio-postgres和postgres将SQL表、视图和函数映射到Rust结构和函数。

注意

一旦生成，生成的代码不包含检查数据库模式是否已更改的额外检查。虽然某些类型转换可能在调用时失败，但应同时更新生成的代码和数据库。

所有生成的函数都将连接到数据库的客户端作为第一个参数。

重载的SQL过程/函数（具有相同名称但参数不同的两个）映射到接受单个元组作为参数的函数，例如，my_func((client, id, "hello"))和my_func((client, id))这意味着重载之前未重载的SQL过程会对生成的代码造成破坏性更改（除非使用具有选项all或one的use-tuples）。

帮助

sql_db_mapper 0.1.0
Generate a rust wrapper for a PostgreSQL database

USAGE:
    sql_db_mapper [FLAGS] [OPTIONS] --conn <conn> [--] [output]

FLAGS:
    -d, --debug           Activate debug mode
        --dir             Program will treat output as a directory name rather than a file and generate a whole crate.
                          If output is not provided code is printed as usual
    -h, --help            Prints help information
        --no-functions    Only make mappings for tables and views
        --rust-case       Convert names from the database to rust standard (i.e. table names in CamelCase, fields and
                          functions in snake_case)
    -u, --ugly            Skip running output through rustfmt
    -V, --version         Prints version information

OPTIONS:
        --conn <conn>
            String to connect to database, see tokio_postgres::Config for details. If not provided environment variable
            DATABASE_URL is checked instead
        --rustfmt-config <rustfmt-config>              string passed to rustfmt --config
        --rustfmt-config-path <rustfmt-config-path>    string passed to rustfmt --config-path
        --third-party <third-party>...
            A comma seperated list of third party crates which contain types that will be mapped to and from sql types.
            Valid values are "bit_vec,chrono,eui48,geo_types,rust_decimal,serde_json,time,uuid"
        --use-tuples <use-tuples>
            How to use tuples (used by default for just overloads). Options: overloads (the default, use tuples to
            represent function overloading). all (Have all functions take a tuple for consitency). none (skip mapping
            overloaded procs at all). one_overload (avoid tuples by only mapping the oldest sql proc in the database)
            [default: overloads]

ARGS:
    <output>    Output file, stdout if not present

常见错误

| 无法在模块 `super::pg_catalog` 中找到类型 `????`
指定的类型只能由第三方crate之一映射。postgres_types::FromSql列出了可以映射的所有类型，除了Numeric，它使用rust_decimal::Decimal进行映射。

sql_db_mapper_core

包含从tokio-postgres Rows转换为Rust类型的TryFromRow trait，并为几个常见类型实现了它。
重新导出可转换为/从SQL类型转换的类型。

sql_db_mapper_derive

提供来自TryFromRow（在sql_db_mapper_core中定义）的derive宏。

在build.rs脚本中使用

创建一个新的库crate，并使Cargo.toml看起来如下所示

[package]
name = "rust_test"
version = "0.1.0"
edition = "2018"

[dependencies]
sql_db_mapper_core = { version = "0.1", features = ["with-bit-vec-0_6", "with-chrono-0_4", "with-eui48-0_4", "with-geo-types-0_6", "with-rust_decimal-1", "with-serde_json-1", "with-time-0_2", "with-uuid-0_8", ] }
postgres-types = { version = "0.2", features = ["derive"] }
async-trait = { version = "0.1", optional = true }

serde = { version = "1.0", features = ["derive"] }

[build-dependencies]
sql_db_mapper = { path = "../sql_db_mapper/sql_db_mapper" }

[features]
sync = []
async = ["async-trait"]

根据您的喜好更改crate的名称、版本以及sql_db_mapper_core的功能

创建一个包含以下内容的build.rs文件

use sql_db_mapper::{ Opt, Tuples, ThirdParty };

fn main() {
	let options = Opt {
		debug: false,
		ugly: false,
		dir: false, // this should be false
		rust_case: true,
		rustfmt_config: None,
		rustfmt_config_path: None,
		no_functions: false,
		use_tuples: Tuples::ForOverloads,
		third_party: vec![
			ThirdParty::Chrono,
			ThirdParty::Time,
			ThirdParty::Eui48,
			ThirdParty::GeoTypes,
			ThirdParty::SerdeJson,
			ThirdParty::Uuid,
			ThirdParty::BitVec,
			ThirdParty::RustDecimal,
		],
		conn: std::env::var("DATABASE_URL").expect("Must provide connection string in environment variable 'DATABASE_URL'"),
		output: Some("./src/lib.rs".into())
	};

	let mut client = options.get_client();
	let full_db = client.get_all(options.no_functions);

	full_db.make_output(&options);
}

这样应该足够开始使用了。

可能的未来工作

• 与代码生成相关的更多选项
  • 从COMMENT ON抓取文本并将其放入文档注释中
  • 允许接受（例如）&varchar作为参数的函数接受&str（varchar是String的typedef，因此函数可能需要像HashMap的get一样泛型）
• 考虑添加对其他流行数据库的支持，或者Rust数据库库
  • sqlx和diesel代码生成器会很有用

许可证

以下任一许可证下发布

• Apache License，版本2.0 (LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
• MIT许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

任您选择。

贡献

除非您明确声明，否则任何有意提交以包含在作品中的贡献，根据Apache-2.0许可证的定义，将按上述方式双重许可，没有任何额外的条款或条件。