配置Diesel CLI

Diesel CLI是Diesel提供的可选工具,用于管理数据库模式。 它的两个主要角色是运行数据库迁移,以及创建表示数据库模式的Rust文件。

可以通过toml文件配置Diesel CLI的行为。 默认情况下,Diesel会在与Cargo.toml文件相同的目录中查找diesel.toml。 您可以通过设置DIESEL_CONFIG_FILE环境变量或在命令行上传递--config-file来提供不同的配置文件。 您可以通过运行diesel setup获得一些默认值的基本配置文件。

从Diesel 1.3开始,该文件包含一个部分[print_schema]。 此文件中的所有字段都是可选的。

The file field

此字段指定希望架构的Rust表示生成的文件。 当此字段存在时,修改数据库模式的命令(例如diesel migration run)将自动运行diesel print-schema,并将其结果输出到此文件。

这意味着您可以修改数据库模式,而无需担心运行单独的命令来更新Rust代码。 强烈建议您使用此字段,以确保数据库模式的Rust表示始终与数据库中的实际内容同步。 通常,这设置为src / schema.rs

与其他字段不同,这实际上并不会修改diesel print-schema的行为。 无论此字段是否存在,diesel print-schema都将始终将模式输出到stdout。

The with_docs field

当此字段设置为true时,diesel print-schema将表现为默认情况下传递--with-docs标志。 这会对所有表和列放置doc注释。

The filter field

该字段指定diesel print-schema应输出哪些表。 它对应于命令行上的--only-tables--except-tables。 它的值应该是具有这两个键之一的映射。 例如:

diesel.toml

[print_schema]
# This will cause only the users and posts tables to be output
filter = { only_tables = ["users", "posts"] }

# This will cause all tables *except* the comments table to be
# output
filter = { except_tables = ["comments"] }

The schema field

指定搜索表时要使用的模式。 设置后,diesel print-schema将始终表现为--schema已通过。 该字段仅影响PostgreSQL。 如果未提供任何值,则将搜索public schema。

The import_types field

该字段将use语句添加到每个table!的顶部声明。 设置后diesel print-schema的行为就像传递了--import-types一样。 如果没有给出值,则只导入diesel :: sql_types中的类型。

diesel.toml

[print_schema]
# Add types from `diesel_full_text_search` like `tsvector`
import_types = ["diesel::sql_types::*", "diesel_full_text_search::types::*"]

The patch_file field

指定生成后应用于模式的.patch文件。 对应于命令行上的--patch-file选项。 此选项需要在您的系统上安装diffutils的补丁。

我们无法为您可能要生成的此文件的每个可能的自定义提供选项。 这可用作架构自定义的通用功能。

该文件应该是统一的差异,您可以使用diffgit diff生成。 强烈建议您提供3个以上的上下文行,尤其是在您设置了import_types的情况下。

您可以通过对schema.rs进行更改,然后运行git diff -U6> src / schema.patch来轻松生成此文件。

上次更新: 3/19/2019, 3:59:47 AM