首页
/ 在ormar中实现PostgreSQL原生UUID类型的正确使用方式

在ormar中实现PostgreSQL原生UUID类型的正确使用方式

2025-07-08 16:15:00作者:邬祺芯Juliet

ormar是一个优秀的Python异步ORM框架,它提供了简洁的API来操作关系型数据库。在使用ormar与PostgreSQL数据库交互时,开发者可能会遇到UUID类型字段被映射为PostgreSQL的bpchar类型的问题。本文将深入探讨这一现象的原因,并提供解决方案。

问题背景

在PostgreSQL中,UUID是一种原生支持的数据类型,专门用于存储通用唯一标识符。然而,当使用ormar框架定义模型时,默认情况下UUID字段会被映射为bpchar类型(即定长字符串类型),而不是PostgreSQL的原生UUID类型。

这种映射虽然功能上可以正常工作,但存在几个潜在问题:

  1. 存储效率较低 - bpchar类型通常比原生UUID类型占用更多空间
  2. 查询性能可能受影响 - 原生UUID类型的索引效率更高
  3. 与其他系统交互时可能出现兼容性问题

解决方案

ormar框架提供了足够的灵活性来解决这个问题。我们可以通过继承ormar.UUID类并重写get_column_type方法来实现对PostgreSQL原生UUID类型的支持:

from sqlalchemy.dialects import postgresql

class PostgresUUID(ormar.UUID):
    """
    自定义UUID字段,使用PostgreSQL原生UUID类型
    """
    
    @classmethod
    def get_column_type(cls, **kwargs: Any) -> postgresql.UUID:
        # 指定使用PostgreSQL的UUID类型
        return postgresql.UUID()

然后在模型定义中使用这个自定义字段类:

class BaseFieldsMixin:
    """基础模型,包含公共字段和功能"""
    
    id: UUID = PostgresUUID(primary_key=True, default=uuid4, uuid_format="uuid")
    created_at: datetime = ormar.DateTime(default=lambda: datetime.now())
    updated_at: Optional[datetime] = ormar.DateTime(nullable=True)
    
    async def save(self) -> None:
        """重写save方法以更新updated_at时间戳"""
        self.updated_at = datetime.now(timezone.utc)
        await super().save()

实现原理

这个解决方案的核心在于重写get_column_type方法。ormar框架在设计时就考虑到了扩展性,允许开发者通过继承字段类来定制数据库列类型。

PostgresUUID类继承了ormar.UUID的所有功能,但通过重写get_column_type方法,明确告诉ormar在PostgreSQL数据库中使用原生UUID类型而不是默认的字符串类型。

最佳实践

  1. 一致性:在整个项目中统一使用PostgresUUID类来定义所有UUID字段,保持数据库模式的一致性。

  2. 迁移考虑:如果从现有系统迁移,需要注意从bpchar到UUID类型的转换可能带来的影响。

  3. 性能考量:对于大型系统,使用原生UUID类型可以带来存储和查询性能的提升。

  4. 跨数据库兼容性:如果项目需要支持多种数据库,可以考虑实现更智能的get_column_type方法,根据当前使用的数据库方言返回适当的类型。

总结

通过自定义字段类的方式,我们可以轻松地在ormar中使用PostgreSQL的原生UUID类型。这种方法既保持了ormar的简洁API,又充分利用了PostgreSQL的特性,是兼顾开发效率和数据库性能的理想选择。

对于使用ormar与PostgreSQL交互的项目,推荐采用这种模式来定义UUID字段,以获得更好的数据库兼容性和性能表现。

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

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
52
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
670
446
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
138
223
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
361
355
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
97
156
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
817
149
gin-vue-admingin-vue-admin
🚀Vite+Vue3+Gin的开发基础平台,支持TS和JS混用。它集成了JWT鉴权、权限管理、动态路由、显隐可控组件、分页封装、多点登录拦截、资源权限、上传下载、代码生成器【可AI辅助】、表单生成器和可配置的导入导出等开发必备功能。
Go
46
8
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
110
74
凹语言凹语言
凹语言 | 因为简单,所以自由
Go
17
5
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
112
253