首页
/ Aldjemy 项目技术文档

Aldjemy 项目技术文档

2024-12-25 03:42:10作者:廉皓灿Ida

1. 安装指南

1.1 安装步骤

  1. 首先,确保你已经安装了Python和Django。
  2. 使用pip安装Aldjemy:
    pip install aldjemy
    
  3. 在Django项目的settings.py文件中,将aldjemy添加到INSTALLED_APPS列表中:
    INSTALLED_APPS = [
        ...
        'aldjemy',
        ...
    ]
    

1.2 配置选项

  • ALDJEMY_DATA_TYPES: 你可以通过这个设置参数自定义字段类型,将Django字段类型映射到SQLAlchemy字段类型。参数必须是一个字典,键是field.get_internal_type()的结果,值是一个单参数函数。
  • ALDJEMY_ENGINES: 你可以通过这个设置参数扩展或覆盖支持的SQLAlchemy引擎列表。参数应该是一个字典,键是Django数据库引擎设置中的子字符串(例如sqlite3),值是SQLAlchemy驱动程序(例如sqlitesqlite+pysqlite)。

2. 项目的使用说明

Aldjemy的主要功能是将SQLAlchemy集成到现有的Django项目中,帮助你构建复杂的查询,这些查询对于Django ORM来说可能比较困难。

2.1 基本使用

Aldjemy会自动为所有Django模型添加一个sa属性,该属性是SQLAlchemy的Model。你可以使用这个属性来执行复杂的查询。

示例:

User.sa.query().filter(User.sa.username=='Brubeck')
User.sa.query().join(User.sa.groups).filter(Group.sa.name=="GROUP_NAME")

2.2 显式连接

SQLAlchemy的哲学是使用显式连接,因此不要期望Aldjemy是Django ORM的完全替代品。你应该在特殊情况下使用Aldjemy来帮助你完成复杂的查询。

3. 项目API使用文档

3.1 模型属性

  • sa: 每个Django模型都会有一个sa属性,该属性是SQLAlchemy的Model。你可以使用这个属性来执行SQLAlchemy查询。

3.2 查询示例

  • 过滤查询:
    User.sa.query().filter(User.sa.username=='Brubeck')
    
  • 连接查询:
    User.sa.query().join(User.sa.groups).filter(Group.sa.name=="GROUP_NAME")
    

4. 项目安装方式

4.1 通过pip安装

pip install aldjemy

4.2 添加到Django项目

settings.py文件中,将aldjemy添加到INSTALLED_APPS列表中:

INSTALLED_APPS = [
    ...
    'aldjemy',
    ...
]

通过以上步骤,你就可以在Django项目中使用Aldjemy来构建复杂的SQLAlchemy查询了。

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