Python ORM框架之SQLAlchemy 的基礎用法

Posted on by

一、SQLAlchemy 介紹

1.1 ORM 的概念

ORM全稱Object Relational Mapping（對象關系映射），通過 ORM 就能使用 python 中的對象操作數據庫（在底層轉換為sql語句），免去sql語句的書寫。

但是，由於抽象程度較高，所以 sql 語句的執行效率比較低，因此有些情況下，還是需要我們親自書寫sql語句。

ORM 是通過以下對應關系，將 python 代碼轉換為 sql 語句的：

python對象 關系型數據庫
類 表
類屬性 字段
類的實例對象 記錄
實例對象的屬性值 記錄的字段值

1.2 SQLAlchemy介紹

在 django 中訪問數據庫，通常會使用 django 自帶的 ORM（Object Relational Mapping）對象關系映射來訪問數據庫，隻需要用python的語法來操作對象，就能被自動映射為 sql 語句。

而 SQLAlchemy 則是一個專門的對象關系映射器和 Python SQL工具包，旨在實現高效和高性能的數據庫訪問。

1.3 架構

  • Schema / Types： 類到表之間的映射規則。
  • SQL Expression Language ：SQL 語句。
  • Engine ：引擎。
  • Connection Pooling： 連接池。
  • Dialect： 方言，調用不同的數據庫 API(Oracle, postgresql, Mysql) 並執行對應的 SQL語句。

1.4 異步

SQLAlchemy 在1.4版本之前，通過 greenlet 實現對異步的支持，而在1.4及之後版本中，添加瞭 python asyncio 標準庫的支持。所以，這需要 python 解釋器版本在 3.6+。

1.5 安裝

安裝 SQLAlchemy（1.4版本）：

pip install SQLAlchemy

如果需要 greenlet 異步支持：

pip install sqlalchemy[asyncio]

二、SQLAlchemy 快速入門

2.1 創建配置（可選）

這一步不是必要的，但將配置單獨放置一個文件中，能方便我們管理和修改。

創建一個配置文件，如 settings.py：

DBMS = 'mysql'  # 數據庫管理系統名稱：如 sqlite、mysql、oracle等 
DBAPI = 'pymysql'  # 所使用的 DBAPI（第三方驅動程序），如 pysqlite、pymysql 等

# 下面就是數據庫管理系統的內容：主機IP、端口、用戶名、密碼、數據庫
HOST = 'localhost'  
PORT = 3306  
USERNAME = 'root'
PASSWORD = '123456'
DB = 'myclass'

DB_URI = f'{DBMS}+{DBAPI}://{USERNAME}:{PASSWORD}@{HOST}:{PORT}/{DB}'

2.2 創建引擎和獲取、關閉連接

任何 SQLAlchemy 應用程序的開始都是一個名為 Engine 的對象，它是一個為特定的數據庫服務器創建一次的全局對象，可以理解為通過 SQLAlchemy 操作數據庫的連接中心，保存著連接池。

from sqlalchemy import create_engine
from settings import DB_URI


engine = create_engine(DB_URI)  # 創建引擎
# 也可以直接傳入字符串，不使用配置文件
# engine = create_engine("數據庫管理系統名稱+驅動://用戶名:密碼@主機IP:端口號/數據庫名稱", echo=True, future=True)

conn = engine.connect()  # 獲取連接
result = conn.execute('SQL語句')  # 執行SQL
print(result.fetchone())  # 打印 SQL 執行結果中的一行
conn.close()  # 關閉連接

create_engine()的其他常用參數：

  • echo：設置為 True，表示將 SQL 記錄到記錄器，該記錄器將 SQL 寫入標準輸出。
  • future：使用2.0風格的引擎和連接 API，以便使用 2.0 版本中的新特性。
  • encoding：默認為 utf-8。
  • pool_size：在連接池中保持打開的連接數。

2.3 創建 ORM 模型

from sqlalchemy.orm import declarative_base
from sqlalchemy import Column, Integer, String

# 創建基類
Base = declarative_base()


# 每一個模型類都要繼承 declarative_base() 創建的基類
class User(Base):
    # 定義表名
    __tablename__ = 'users'
    
    # 定義字段，參數為字段類型和約束
    id = Column(Integer, primary_key=True, autoincrement=True)
    name = Column(String)
    age = Column(Integer)
    sex = Column(String(10))

2.4 創建會話

每次在 python 中執行完操作後，都需要通過 session 提交到數據庫：

from sqlalchemy.orm import sessionmaker

# 創建會話，相當於 Django ORM 的 objects
Session = sessionmaker(bind=engine)
session = Session()

# 執行數據的增刪改查……
# 比如，新增數據
# session.add(模型類(類屬性=值,……))

# 提交
session.commit()
# 關閉session
session.close()

在commit()之前，可以取消對實例對象所做的修改，也就是回滾：

session.rollback()

2.5 創建和刪除表

創建所有表：

Base.metadata.create_all(engin)  

刪除所有表：

Base.metadata.drop_all(engin)

2.6 新增數據

新增數據：

變量名 = 模型類(類屬性=值,……)
session.add(變量名)

批量新增：

session.add_all([
    模型類(類屬性=值,……),
    模型類(類屬性=值,……)
    ……
])

2.7 查詢數據

查詢所有：

變量名 = session.query(模型類).all()

返回模型類實例對象列表。

查詢指定字段：

變量名 = session.query(模型類.字段).all()

隻獲取返回結果的第一個：

變量名 = session.query(模型類).first()

連表查詢：

變量名 = session.query(模型類1,模型類2).filter(條件).all()

# 如，查詢用戶 ID 及其愛好的 ID
res = session.query(User, Hobby).filter(User.hobby_id == Hobby.id).all()

返回一個元組構成的列表，元組包含兩個實例對象。

過濾：

變量名 = session.query(模型類).filter(條件).all()

# 如，查詢年齡大於18歲的學生名字
res = session.query(Student.name).filter(Student.age >= 18).all()

條件中常用運算符：

多條件過濾：

# 條件之間默認為 and 關系
變量名 = session.query(模型類).filter(條件1, 條件2……).all()


# 使用 or 
from sqlalchemy import or_
變量名 = session.query(模型類).filter(or_(條件1, 條件2……)).all()

排序：

變量名 = session.query(模型類).order_by(排序依據字段.desc()).all()     # desc 表示倒序，寫 asc 或不寫就是升序

統計個數：

變量名 = session.query(模型類).count()

切片：

變量名 = session.query(模型類).all()[1:3]

2.8 修改數據

變量名 = session.query(模型類).filter(條件).update({"字段":值})
# 不要忘記提交

2.9 刪除數據

session.query(模型類).filter(條件).delete()

三、多表操作

下面的內容中，我將稱定義瞭外鍵字段的模型類為被關聯模型，另一個為關聯模型。

3.1 一對多

創建模型：

外鍵定義在多的一方。

from sqlalchemy import ForeignKey
from sqlalchemy.orm import relationship

class 模型類名稱(Base):
    __tablename__ = '表名'
    
    字段 = Column(類型,約束)
    ……
    外鍵字段 = Column(類型,其他約束,ForeignKey(關聯模型.字段))  # 重點
    關聯模型名稱小寫 = relationship("關聯模型的名稱",backref="用於反向查詢的名稱")    # 不是字段，不會在數據庫中創建

新增數據：

# 正向新增
變量名 = 被關聯模型(字段=值,……,外鍵字段=關聯模型(字段=值……))
session.add(變量名)

# 反向新增
變量名A = 關聯模型(字段=值,……)
變量名A.backref的值 = [被關聯模型的實例1，被關聯模型的實例2……]
session.add(變量名A)

正向查詢：

先獲取被關聯模型的實例，然後通過實例.外鍵獲取關聯對象。

反向查詢：

先獲取關聯模型的實例，然後通過實例.backref的值獲取被關聯模型的實例對象。

3.2 多對多

創建模型：

新建中間表，隻保存雙方的對應關系即可。

在其中一方，定義 relationship：

關聯模型類名稱小寫 = relationship("關聯模型類的名稱", secondary='中間表模型類的名稱小寫', backref="用於反向查詢的名稱")    # 不是字段，不會在數據庫中創建

新增數據：

在雙方創建好數據後，直接在中間表中添加對應關系。

正向、反向查詢：

與一對多模型一致。

到此這篇關於Python ORM框架之SQLAlchemy 的基礎用法的文章就介紹到這瞭,更多相關SQLAlchemy 的用法內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：