首页
/ Diesel CLI 中 exclude_custom_type_definitions 配置项的正确使用方式

Diesel CLI 中 exclude_custom_type_definitions 配置项的正确使用方式

2025-05-17 08:01:57作者:董斯意

在使用 Diesel ORM 框架与 PostgreSQL 数据库交互时,开发者经常会遇到需要处理自定义 SQL 类型的情况。特别是在结合 postgis-diesel 扩展处理地理空间数据时,正确配置 schema 生成行为尤为重要。

Diesel CLI 工具提供了一个名为 exclude_custom_type_definitions 的配置项,用于控制自定义类型的生成行为。然而,当前文档中存在一个拼写错误,将正确的配置项名称 except_custom_type_definitions 误写为了 exclude_custom_type_definitions

当开发者按照错误文档配置时,会出现两个问题:

  1. 生成的 schema 文件会被错误地保存到以配置值为名称的文件中,而非指定的 src/schema.rs
  2. 无法正确排除自定义类型定义,导致重复定义问题

正确的配置方式是在 diesel.toml 文件中使用:

[print_schema]
file = "src/schema.rs"
custom_type_derives = ["diesel::query_builder::QueryId"]
import_types = ["diesel::sql_types::*", "postgis_diesel::sql_types::*"]
except_custom_type_definitions = ["Geometry"]

这种配置下,Diesel CLI 会:

  1. 正确将输出保存到指定的 schema.rs 文件
  2. 跳过 Geometry 类型的自定义定义,转而使用 postgis-diesel 提供的类型
  3. 为其他自定义类型自动生成合适的 Rust 类型定义

对于使用 postgis-diesel 等扩展的开发者来说,这个配置尤为重要。它允许开发者复用扩展库中已经定义好的类型,避免重复定义导致的编译错误或类型不一致问题。

建议开发者在遇到 schema 生成行为不符合预期时,首先检查 diesel.toml 中的配置项拼写是否正确,特别是这个容易混淆的配置项名称。正确的配置可以显著提升开发体验,特别是在处理复杂自定义类型时。

登录后查看全文
热门项目推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
867
513
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
265
305
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57
GitNextGitNext
基于可以运行在OpenHarmony的git,提供git客户端操作能力
ArkTS
10
3