#ORM工具对接示例(Django)

Django是一个Python Web开发框架,内部包含了数据库ORM组件,详情请参考Django官方网站 (opens new window)

django_yashandb是适配Django ORM框架的YashanDB方言库,已通过Django社区用例集。

# 运行环境

  • 支持在Linux和Windows系统下运行。
  • 建议使用python3.8以上的python版本。
  • 适配的Django版本为3.2.25,安装命令如下:
    pip3 install django==3.2.25
    

# Django ORM运行依赖

  • YashanDB Python驱动(python-yasdb)。安装python-yasdb请参考相应文档安装YashanDB Python驱动

  • django_yashandb方言库。安装包请与YashanDB数据库技术支持人员获取。

# 方言库安装

下载django_yashandb包后使用以下命令安装:

pip3 install --force-reinstall django_yashandb-1.0.1-py3-none-any.whl

# 使用方法

  1. 将YashanDB数据库切换为open状态。
  2. 配置Django框架的配置文件,在项目的settings.py添加或更新如下配置。
    DATABASES = {
       "default": {
           "ENGINE": "django_yashandb",
           "HOST": "your_database_host",
           "PORT": "your_database_port",
           "USER": "your_database_name",
           "PASSWORD": "your_database_password",
       },
    }
    
  3. 随后的操作与Django正常的一般操作无异,详情请参考Django官方网站 (opens new window)

# 注意事项

在Django项目中配置使用YashanDB需注意:

  • 不能在Django项目中使用分布式部署的YashanDB。
  • 请勿手动为AutoField、BigAutoField插入与当前数据库中该字段最大值跨度过大的值,可能会导致框架长时间阻塞。
  • 查询数据库列中包含绑定参数时,请显式指定output_field参数的值,以便查询返回值类型为期望值。不包含绑定参数则无此约束。