給Django用戶的SQLAlchemy介紹

http://www.zlovezl.cn/articles/sqlalchemy-intro-for-django-guys/

SQLAlchemy是什麼？

SQLAlchemy的官網上寫着它的介紹文字:

SQLAlchemy is the Python SQL toolkit and Object Relational Mapper that gives
application developers the full power and flexibility of SQL.

SQLAlchemy 是一個非常強大的ORM和數據庫工具，但是它龐大的文檔和複雜的功能總是讓很多人望而生畏。而Django的ORM相對來說就讓很多人覺得簡單實用。

事實上，SQLAlchemy其實也沒有那麼複雜，光使用它一些比較高級的功能其實並沒有比使用Django ORM複雜多少，而它豐富的功能則能讓你在遇到更復雜的問題時處理起來得心應手。

寫作本文的主要目的在於：

通過對比SQLAlchemy ORM和Django ORM的主要使用方法，儘量簡單直觀的讓Django用戶能夠快速瞭解和上手SQLAlchemy這款強大的工具。
不牽扯到SQLAlchemy具體的技術細節，包括Engine連接池、Session的具體工作原理等等

SQLAlchemy相對於Django內建的ORM來說，有幾處非常明顯的優點：

可獨立使用，任何使用Python的項目都可以用它來操作數據庫
和直接使用原始的DBAPI相比，提供了非常豐富的特性：連接池、auto-map等等
提供了更底層的SQL抽象語言，能用原始sql解決的問題基本上都可以用SQLAlchemy解決

接下來我們針對日常的數據庫操作來對比一下Django ORM和SQLAlchemy。

文中使用的 SQLAlchemy 版本爲 0.9.8

Django VS SQLAlchemy

建立數據表

首先，我們需要先建立幾個表。

Django

在Django中，如果要建表，就是在models.py中定義你的數據類型：

from django.db import models

class Game(models.Model):
    ... ...

class GameCompany(models.Model):
    ... ...

因爲文章主要面向有經驗的Django用戶，所以此處不寫出詳細的定義代碼。定義Model以後我們還需要在settings.py中DATABASES處設置需要連接的數據庫地址。最後，使用syncdb來完成數據庫表的創建。

SQLAlchemy

在SQLAlchemy中，定義表結構的過程和Django類似：

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String, ForeignKey, Date
from sqlalchemy.orm import relationship, backref

Base = declarative_base()

# 定義表結構
class GameCompany(Base):
    __tablename__ = 'game_company'

    id = Column(Integer, primary_key=True)
    name = Column(String(200), nullable=False)
    country = Column(String(50))


class Game(Base):
    __tablename__ = 'game'

    id = Column(Integer, primary_key=True)
    company_id = Column(Integer, ForeignKey('game_company.id'), index=True)
    category = Column(String(10))
    name = Column(String(200), nullable=False)
    release_date = Column(Date)

    # 和Django不同，外鍵需要顯式定義，具體好壞見仁見智
    # 此處的relation可以爲lazy加載外鍵內容時提供一些可配置的選項
    company = relationship('GameCompany', backref=backref('games'))


# 此處定義要使用的數據庫
engine = create_engine('mysql://root:root@localhost:5379/sqlalchemy_tutorial?charset=utf8')
# 調用create_all來創建表結構，已經存在的表將被忽略
Base.metadata.create_all(engine)

插入一些數據

接下來，我們往表中插入一些數據

Django

Django中比較常用的插入數據方法就是使用 .save() 了。

nintendo = GameCompany(name="nintendo", country="Japan")
nintendo.save()

game1 = Game(
    company=nintendo,
    category="ACT",
    name="Super Mario Bros",
    release_date='1985-10-18')
game1.save()

# 或者使用create
Game.objects.create(... ...)

SQLAlchemy

在SQLAlchemy ORM中，有一個非常關鍵的對象 session ，所有對於數據的操作都是通過session來進行的，所以要插入數據之前，我們得先初始化一個session：

from sqlalchemy.orm import sessionmaker
Session = sessionmaker(bind=engine)
session = Session()

之後插入數據的方法也和Django比較相似：

# 添加數據
nintendo = GameCompany(name="Nintendo", country="Japan")
capcom = GameCompany(name="Capcom", country="Japan")
game1 = Game(
    company=nintendo,
    category="ACT",
    name="Super Mario Bros",
    release_date='1985-10-18'
)
game2 = Game(
    company=capcom,
    category="ACT",
    name="Devil May Cry 3: Dante's Awakening",
    release_date="2005-03-01",
)
game3 = Game(
    company=nintendo,
    category="RPG",
    name="Mario & Luigi: Dream Team",
    release_date="2013-08-11",
)

# 使用add_all來讓這些objects和session產生關係
session.add_all([nintendo, capcom, game1, game2])
# 在沒有開啓autocommit的模式下，不要忘了調用commit來讓數據寫到數據庫中
session.commit()

除了commit之外，session還有rollback()等方法，你可以把session對象簡單看成是一次 transaction，所以當你對內容進行修改時，需要調用 session.commit() 來提交這些修改。

去文檔可以瞭解更多session相關內容：http://docs.sqlalchemy.org/en/rel_0_9/orm/session.html

常用操作

簡單查詢

批量查詢

# -- Django --
Game.objects.filter(category="RPG")

# -- SQLAlchemy --
# 使用filter_by是和django ORM比較接近的方式
session.query(Game).filter_by(category="RPG")
session.query(Game).filter(Game.category == "RPG")

查詢單個對象

# -- Django --
Game.objects.get(name="Super Mario Bros")

# -- SQLAlchemy --
session.query(Game).filter_by(name="Super Mario Bros").one()
# `get_objects_or_None()`
session.query(Game).filter_by(name="Super Mario Bros").scalar()

Django中得各種 > 、< 都是使用在字段名稱後面追加 "__gt"、"__lt" 來實現的，在SQLAlchemy 中這樣的查詢還要更直觀一些

# -- Django --
Game.objects.filter(release_date__gte='1999-01-01')
# 取反
Game.objects.exclude(release_date__gte='1999-01-01')

# -- SQLAlchemy --
session.query(Game).filter(Game.release_date >= '1999-01-01').count()
# 取反使用 ~ 運算符
session.query(Game).filter(~Game.release_date >= '1999-01-01').count()

通過外鍵組合查詢

# -- Django --
Game.objecs.filter(company__name="Nintendo")

# -- SQLAlchemy --
session.query(Game).join(GameCompany).filter(GameCompany.name == "Nintendo")

多條件或查詢

# -- Django --
from django.db.models import Q
Game.objects.filter(Q(category="RPG") | Q(category="ACT"))

# -- SQLAlchemy --
from sqlalchemy import or_
session.query(Game).filter(or_(Game.category == "RPG", Game.category == "ACT"))
session.query(Game).filter((Game.category == "RPG") | (Game.category == "ACT"))

in查詢

# -- Django --
Game.objects.filter(category__in=["GAL", "ACT"])

# -- SQLAlchemy --
session.query(Game).filter(Game.category.in_(["GAL", "ACT"]))

like查詢

# -- Django --
Game.objects.filter(name__contains="Mario")

# -- SQLAlchemy --
session.query(Game.name.contains('Mario'))

統計個數

簡單統計總數

# -- Django --
Game.objects.filter(category="RPG").count()

# -- SQLAlchemy --
session.query(Game).filter_by(category="RPG").count()

分組統計個數

# -- Django --
from django.db.models import Count
Game.objects.values_list('category').annotate(Count('pk')).order_by()

# -- SQLAlchemy --
from sqlalchemy import func
session.query(Game.category, func.count(Game.category)).group_by(Game.category).all()

結果排序

對查詢結果進行排序

# -- Django --
Game.objects.all().order_by('release_date')
Game.objects.all().order_by('-release_date')
# 多字段排序
Game.objects.all().order_by('-release_date', 'category')

# -- SQLAlchemy --
session.query(Game).order_by(Game.release_date)
session.query(Game).order_by(Game.release_date.desc())
# 多字段排序
session.query(Game).order_by(Game.release_date.desc(), Game.category)

修改數據

# -- Django --
game =  Game.objects.get(pk=1)
game.name = 'Super Mario Brothers'
game.save()

# -- SQLAlchemy --
game = session.query(Game).get(1)
game.name = 'Super Mario Brothers'
session.commit()

批量修改

# -- Django --
Game.objects.filter(category="RPG").update(category="ARPG")

# -- SQLAlchemy --
session.query(Game).filter_by(category="RPG").update({"category": "ARPG"})

批量刪除

# -- Django --
Game.objects.filter(category="ARPG").delete()

# -- SQLAlchemy --
session.query(Game).filter_by(category="ARPG").delete()

SQLAlchemy其他一些值得關注的功能

上面簡單列了一些SQLAlchemy ORM和Django ORM的使用方法對比，SQLAlchemy同時還提供了一些其他非常有用的功能。

Automap

假如你有一個Django項目，通過ORM創建了一大堆Model。這時來了一個新項目，需要操作這些表，應該怎麼辦？拷貝這些Models？使用原始的DB-API加上sql來操作？

其實使用SQLAlchemy的Automap可以讓你的工作變得非常的方便，你只要在新項目連接到舊數據庫，然後稍微配置一下Automap，就可以使用SQLAlchemy的ORM操作那些通過別的系統創建的表了。

就像這樣：

from sqlalchemy.ext.automap import automap_base
from sqlalchemy.orm import Session
from sqlalchemy import create_engine

Base = automap_base()
engine = create_engine("sqlite:///mydatabase.db")
Base.prepare(engine, reflect=True)

# user和address就是表明，通過這樣的語句就可以把他們分別映射到User和Address類
User = Base.classes.user
Address = Base.classes.address

更多信息可以參考詳細文檔：http://docs.sqlalchemy.org/en/rel_0_9/orm/extensions/automap.html

Alembic

Django有south可以方便做表結構修改？SQLAlchemy當然也可以，甚至比south更爲強大。自動migrate？手動migrate？統統不是問題。

更多信息可參考文檔：http://alembic.readthedocs.org/en/latest/index.html

給Django用戶的SQLAlchemy介紹

SQLAlchemy是什麼？

Django VS SQLAlchemy

建立數據表

Django

SQLAlchemy

插入一些數據

Django

SQLAlchemy

常用操作

簡單查詢

多條件或查詢

in查詢

like查詢

統計個數

結果排序

修改數據

批量修改

批量刪除

SQLAlchemy其他一些值得關注的功能

Automap

Alembic

AI 畫圖真刺激，手把手教你如何用 ComfyUI 來畫出刺激的圖

公司剛入職了一名 Java 中級開發，短短 4 行代碼居然湊齊了 3 個 bug！我哭了~~

數據展示動態（跑分）顯示

公衆號5月C#/.NET熱文一覽

git 下載大陸鏡像地址

linux cpu佔用率分析

Django權限機制的實現

django guardian 對象級別權限設計

騰訊專家分享：騰訊做業務監控的心得和經驗

在Python中使用JSON

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結