Python 數(shù)據(jù)庫(kù)操作 SQLAlchemy的示例代碼

更新時(shí)間：2019年02月18日 16:06:59 作者：keinYe

這篇文章主要介紹了Python 數(shù)據(jù)庫(kù)操作 SQLAlchemy的示例代碼，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

程序在運(yùn)行過(guò)程中所有的的數(shù)據(jù)都存儲(chǔ)在內(nèi)存 (RAM) 中，「RAM 是易失性存儲(chǔ)器，系統(tǒng)掉電后 RAM 中的所有數(shù)據(jù)將全部丟失」。在大多數(shù)情況下我們希望程序運(yùn)行中產(chǎn)生的數(shù)據(jù)能夠長(zhǎng)久的保存，此時(shí)我們就需要將數(shù)據(jù)保存到磁盤上，無(wú)論是保存到本地磁盤，還是通過(guò)網(wǎng)絡(luò)保存到服務(wù)器上，最終都會(huì)將數(shù)據(jù)寫(xiě)入磁盤文件。將數(shù)據(jù)保存在磁盤中我們需要面對(duì)一個(gè)數(shù)據(jù)格式的問(wèn)題，此時(shí)就需要引入數(shù)據(jù)庫(kù)操作。

數(shù)據(jù)庫(kù)是專門用于數(shù)據(jù)的集中存儲(chǔ)和查詢的軟件，它便于程序保存和讀取數(shù)據(jù)，且能夠通過(guò)特定的條件查詢指定的數(shù)據(jù)。

Python 的標(biāo)準(zhǔn)數(shù)據(jù)庫(kù)接口為 Python DB-API，它為編程人員提供了完善的數(shù)據(jù)庫(kù)應(yīng)用標(biāo)稱接口。但是使用 Python DB-API 需要開(kāi)發(fā)人員自行去拼接 SQL，并把 SQL 做成模板。此時(shí)全靠編程人員來(lái)保證系統(tǒng)的安全性，完全有人來(lái)保證系統(tǒng)的安全性，不可避免的會(huì)出現(xiàn)錯(cuò)誤，為了減少人為原因產(chǎn)生的錯(cuò)誤 ORM 框架應(yīng)運(yùn)而生。

ORM 即 Object-Relational Mapping，把關(guān)系數(shù)據(jù)庫(kù)的表結(jié)構(gòu)映射到對(duì)象上面。負(fù)責(zé)這個(gè)轉(zhuǎn)換過(guò)程的就是 ORM 框架

Python 中的 ORM 框架主要有 SQLObject、Storm、Django's ORM、peewee、SQLALchemy。每種 ORM 框架都有各自的特點(diǎn)和相應(yīng)的應(yīng)用范圍，本文主要介紹 SALALchemy，若你對(duì)其他框架感興趣請(qǐng)自行搜索相關(guān)內(nèi)容。

SQLAlchemy 簡(jiǎn)介

SQLAlchemy 是一個(gè)功能強(qiáng)大的開(kāi)源 Python ORM 工具包。它提供了 “一個(gè)知名企業(yè)級(jí)的持久化模式的，專為高效率和高性能的數(shù)據(jù)庫(kù)訪問(wèn)設(shè)計(jì)的，改編成一個(gè)簡(jiǎn)單的 Python 域語(yǔ)言的完整套件”。它采用了數(shù)據(jù)映射模式（像 Java 中的 Hibernate）而不是 Active Record 模式（像Ruby on Rails 的 ORM）。

SQLAlchemy官網(wǎng)。

SQLAlchemy 的優(yōu)缺點(diǎn)：

優(yōu)點(diǎn)：

企業(yè)級(jí) API，使得代碼有健壯性和適應(yīng)性。
靈活的設(shè)計(jì)，使得能輕松完成復(fù)雜的數(shù)據(jù)查詢。

缺點(diǎn)：

工作單元概念不常見(jiàn)。
重量級(jí) API，導(dǎo)致長(zhǎng)學(xué)習(xí)曲線。

SQLAlchemy 應(yīng)用

以下是一段使用 SQLAlchemy 操作 SQLite 數(shù)據(jù)庫(kù)的代碼

# -*- coding:utf-8 -*-

from sqlalchemy import (
  create_engine,
  Column,
  Integer,
  String,
)

from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

engine = create_engine('sqlite:///./sqlalchemy.sqlite', echo=True)

Base = declarative_base()

class User(Base):
  __tablename__ = 'users'

  id = Column(Integer, primary_key=True, autoincrement=True)
  name = Column(String)
  fullname = Column(String)
  nickname = Column(String)

  def __repr__(self):
    return "<User(name='%s', fullname='%s', nickname='%s')>" % (self.name, self.fullname, self.nickname)


db_session = sessionmaker(bind=engine)
session = db_session()

Base.metadata.create_all(engine)

user1 = User(name='ed', fullname='Ed Jones', nickname='edsnickname')
user2 = User(name='wendy', fullname='Wendy Williams', nickname='windy')
user3 = User(name='mary', fullname='Mary Contrary', nickname='mary')

session.add(user1)
session.add(user2)
session.add(user3)
session.commit()

user = session.query(User).filter(User.id<2).all()
print(user)
user = session.query(User).filter(User.id<=5).all()
print(user)

user1.name = 'admin'
session.merge(user1)
user4 = User(name='fred', fullname='Fred Flintstone', nickname='freddy')
session.merge(user4)
session.query(User).filter(User.id==2).update({'name':'test'})
user = session.query(User).filter(User.id<=5).all()
print(user)

在以上代碼中我們完成了一下工作：

連接到數(shù)據(jù)庫(kù)「本次我們使用的是 SQLite 數(shù)據(jù)庫(kù)」。
創(chuàng)建數(shù)據(jù)庫(kù)表并將其映射到 Python 類上。
創(chuàng)建數(shù)據(jù)實(shí)例，并將其保存到數(shù)據(jù)庫(kù)中。
對(duì)保存在數(shù)據(jù)庫(kù)中的數(shù)據(jù)進(jìn)行讀取和修改。

導(dǎo)入 SQLAlchemy 模塊并連接到 SQLite 數(shù)據(jù)庫(kù)

SQLAlchemy 通過(guò) create_engine 函數(shù)來(lái)創(chuàng)建數(shù)據(jù)庫(kù)連接。create_engine 函數(shù)的第一個(gè)參數(shù)是數(shù)據(jù)了 URL，第二個(gè)參數(shù) echo 設(shè)置為 True 表示在程序的運(yùn)行過(guò)程中我們可以在控制臺(tái)看到操作所涉及到的 SQL 語(yǔ)句。

在本次示例中我們使用的數(shù)據(jù)庫(kù)是 SQLite，你也可以使用其他數(shù)據(jù)庫(kù)。只有在調(diào)試狀態(tài)下將 echo 設(shè)置為 True，在生產(chǎn)環(huán)境請(qǐng)將 echo 設(shè)置為 false 或省略 echo 參數(shù)。

engine = create_engine('sqlite:///./sqlalchemy.sqlite', echo=True)

create_engine 返回的是一個(gè) Engine 實(shí)例，它指向數(shù)據(jù)庫(kù)的一些核心接口。SQLAlchemy會(huì)根據(jù)你選擇的數(shù)據(jù)庫(kù)配置而調(diào)用對(duì)應(yīng)的 DB-API。

create_engine 函數(shù)并會(huì)不真正建立數(shù)據(jù)庫(kù)的 DB-API 連接，當(dāng)調(diào)用 Engine.execute() 或 Engine.connect() 方法時(shí)才會(huì)建立連接。大多數(shù)情況下我們無(wú)需關(guān)注 Engine，SQLAlchemy 會(huì)幫我們處理。

創(chuàng)建數(shù)據(jù)庫(kù)表

將 python 類映射到數(shù)據(jù)庫(kù)表上，這個(gè) Python 類需要時(shí)一個(gè)指定基類的子類，這個(gè)基類應(yīng)當(dāng)含有ORM映射中相關(guān)的類和表的信息。這個(gè)基類可以通過(guò) declarative_base 方法來(lái)創(chuàng)建。
Base = declarative_base()

在這個(gè)示例中使用 Base 基類創(chuàng)建了一個(gè) User 的類來(lái)作為數(shù)據(jù)庫(kù)表。

class User(Base):
  __tablename__ = 'users'

  id = Column(Integer, primary_key=True, autoincrement=True)
  name = Column(String)
  fullname = Column(String)
  nickname = Column(String)

  def __repr__(self):
    return "<User(name='%s', fullname='%s', nickname='%s')>" % (self.name, self.fullname, self.nickname)

在 User 類中我們定義了需要映射到數(shù)據(jù)庫(kù)表上的屬性，主要包括表名稱、列的類型和名稱等。這個(gè)類至少應(yīng)包含一個(gè)名為 tablename 的屬性來(lái)給出數(shù)據(jù)庫(kù)表的名稱，及至少一個(gè)給出表的主鍵「primary key」的列。在 User 類中我們定義了表名稱為 users，定義了 id、name、fullname、nickname 四列數(shù)據(jù)，并設(shè)置 id 為表的主鍵。
創(chuàng)建完成 User 類后，實(shí)際在 SQLite 數(shù)據(jù)庫(kù)中并不存在該表，此時(shí)需要使用 declarative 基類的 Metadata.create_all 在數(shù)據(jù)庫(kù)中創(chuàng)建 users 表，在 create_all 方法中我們需要傳入?yún)?shù) Engine。

通過(guò) Metadata.create_all 傳入的 Engine 參數(shù)，SQLAlchemy 自動(dòng)實(shí)現(xiàn)對(duì)數(shù)據(jù)庫(kù)的連接。

Base.metadata.create_all(engine)

metadata.create_all 方法執(zhí)行完成后在 SQLite 數(shù)據(jù)庫(kù)即可查到名稱為 users 的數(shù)據(jù)表。

保存數(shù)據(jù)實(shí)例到數(shù)據(jù)庫(kù)中

將數(shù)據(jù)保存到數(shù)據(jù)庫(kù)中，我們需要 User 的實(shí)例和用于操作數(shù)據(jù)的 session。

session 是 ORM 數(shù)據(jù)的接口，可以通過(guò) session 來(lái)操作數(shù)據(jù)庫(kù)中的數(shù)據(jù)。

使用已經(jīng)定義完成的 User 類將數(shù)據(jù)實(shí)例化。

user1 = User(name='ed', fullname='Ed Jones', nickname='edsnickname')
user2 = User(name='wendy', fullname='Wendy Williams', nickname='windy')
user3 = User(name='mary', fullname='Mary Contrary', nickname='mary')

獲取 session 首先需要使用 sessionmaker 來(lái)得到 session 的工廠類，然后通過(guò)工廠類來(lái)獲取 session。

db_session = sessionmaker(bind=engine)
session = db_session()

session 通過(guò) Engine 與數(shù)據(jù)庫(kù)進(jìn)行關(guān)聯(lián)。session 創(chuàng)建完成后并不會(huì)立即打開(kāi)與數(shù)據(jù)庫(kù)的連接，只有當(dāng)我們第一使用 session 是，才會(huì)從 Engine 維護(hù)的連接池中取出一個(gè)連接來(lái)操作數(shù)據(jù)庫(kù)，這個(gè)連接在我們關(guān)閉 session 時(shí)會(huì)被釋放。
獲取 session 后可以通過(guò) add 和 commit 方法將數(shù)據(jù)保存到數(shù)據(jù)庫(kù)中。

session.add(user1)
session.add(user2)
session.add(user3)
session.commit()

對(duì)數(shù)據(jù)庫(kù)中的數(shù)據(jù)進(jìn)行查詢和修改

SQLAlchemy 通過(guò) query 來(lái)對(duì)數(shù)據(jù)進(jìn)行查詢，可以通過(guò) filter 方法對(duì)查詢結(jié)果進(jìn)行篩選。

user = session.query(User).filter(User.id<2).all()
print(user)
user = session.query(User).filter(User.id<=5).all()
print(user)

以上代碼通過(guò) query 獲取數(shù)據(jù)庫(kù)中所有 User 數(shù)據(jù)，然后通過(guò) filter 方法篩選出 id 小于 2 和 id 小于等于 5 的數(shù)據(jù)。

數(shù)據(jù)庫(kù)的修改可以通過(guò) merge 和 update 來(lái)實(shí)現(xiàn)

user1.name = 'admin'
session.merge(user1)
user4 = User(name='fred', fullname='Fred Flintstone', nickname='freddy')
session.merge(user4)
session.query(User).filter(User.id==2).update({'name':'test'})
user = session.query(User).filter(User.id<=5).all()
print(user)

使用 merge 修改數(shù)據(jù)，當(dāng)數(shù)據(jù)中存在該數(shù)據(jù)時(shí)修改，不存在是將當(dāng)前數(shù)據(jù)插入數(shù)據(jù)庫(kù)中。

代碼運(yùn)行結(jié)果

以上示例代碼的運(yùn)行結(jié)果如下

2019-02-16 21:45:23,919 INFO sqlalchemy.engine.base.Engine SELECT CAST('test plain returns' AS VARCHAR(60)) AS anon_1
2019-02-16 21:45:23,919 INFO sqlalchemy.engine.base.Engine ()
2019-02-16 21:45:23,919 INFO sqlalchemy.engine.base.Engine SELECT CAST('test unicode returns' AS VARCHAR(60)) AS anon_1
2019-02-16 21:45:23,919 INFO sqlalchemy.engine.base.Engine ()
2019-02-16 21:45:23,920 INFO sqlalchemy.engine.base.Engine PRAGMA table_info("users")
2019-02-16 21:45:23,920 INFO sqlalchemy.engine.base.Engine ()
2019-02-16 21:45:23,921 INFO sqlalchemy.engine.base.Engine
CREATE TABLE users (
  id INTEGER NOT NULL,
  name VARCHAR,
  fullname VARCHAR,
  nickname VARCHAR,
  PRIMARY KEY (id)
)


2019-02-16 21:45:23,921 INFO sqlalchemy.engine.base.Engine ()
2019-02-16 21:45:23,922 INFO sqlalchemy.engine.base.Engine COMMIT
2019-02-16 21:45:23,924 INFO sqlalchemy.engine.base.Engine BEGIN (implicit)
2019-02-16 21:45:23,925 INFO sqlalchemy.engine.base.Engine INSERT INTO users (name, fullname, nickname) VALUES (?, ?, ?)
2019-02-16 21:45:23,925 INFO sqlalchemy.engine.base.Engine ('ed', 'Ed Jones', 'edsnickname')
2019-02-16 21:45:23,926 INFO sqlalchemy.engine.base.Engine INSERT INTO users (name, fullname, nickname) VALUES (?, ?, ?)
2019-02-16 21:45:23,926 INFO sqlalchemy.engine.base.Engine ('wendy', 'Wendy Williams', 'windy')
2019-02-16 21:45:23,926 INFO sqlalchemy.engine.base.Engine INSERT INTO users (name, fullname, nickname) VALUES (?, ?, ?)
2019-02-16 21:45:23,926 INFO sqlalchemy.engine.base.Engine ('mary', 'Mary Contrary', 'mary')
2019-02-16 21:45:23,927 INFO sqlalchemy.engine.base.Engine COMMIT
2019-02-16 21:45:23,929 INFO sqlalchemy.engine.base.Engine BEGIN (implicit)
2019-02-16 21:45:23,929 INFO sqlalchemy.engine.base.Engine SELECT users.id AS users_id, users.name AS users_name, users.fullname AS users_fullname, users.nickname AS users_nickname
FROM users
WHERE users.id < ?
2019-02-16 21:45:23,929 INFO sqlalchemy.engine.base.Engine (2,)
[<User(name='ed', fullname='Ed Jones', nickname='edsnickname')>]
2019-02-16 21:45:23,931 INFO sqlalchemy.engine.base.Engine SELECT users.id AS users_id, users.name AS users_name, users.fullname AS users_fullname, users.nickname AS users_nickname
FROM users
WHERE users.id <= ?
2019-02-16 21:45:23,931 INFO sqlalchemy.engine.base.Engine (5,)
[<User(name='ed', fullname='Ed Jones', nickname='edsnickname')>, <User(name='wendy', fullname='Wendy Williams', nickname='windy')>, <User(name='mary', fullname='Mary Contrary', nickname='mary')>]
2019-02-16 21:45:23,932 INFO sqlalchemy.engine.base.Engine UPDATE users SET name=? WHERE users.id = ?
2019-02-16 21:45:23,932 INFO sqlalchemy.engine.base.Engine ('admin', 1)
2019-02-16 21:45:23,933 INFO sqlalchemy.engine.base.Engine INSERT INTO users (name, fullname, nickname) VALUES (?, ?, ?)
2019-02-16 21:45:23,933 INFO sqlalchemy.engine.base.Engine ('fred', 'Fred Flintstone', 'freddy')
2019-02-16 21:45:23,934 INFO sqlalchemy.engine.base.Engine UPDATE users SET name=? WHERE users.id = ?
2019-02-16 21:45:23,934 INFO sqlalchemy.engine.base.Engine ('test', 2)
2019-02-16 21:45:23,935 INFO sqlalchemy.engine.base.Engine SELECT users.id AS users_id, users.name AS users_name, users.fullname AS users_fullname, users.nickname AS users_nickname
FROM users
WHERE users.id <= ?
2019-02-16 21:45:23,935 INFO sqlalchemy.engine.base.Engine (5,)
[<User(name='admin', fullname='Ed Jones', nickname='edsnickname')>, <User(name='test', fullname='Wendy Williams', nickname='windy')>, <User(name='mary', fullname='Mary Contrary', nickname='mary')>, <User(name='fred', fullname='Fred Flintstone', nickname='freddy')>]

由于我們?cè)O(shè)置 create_engine 中 echo 為 True，因此在執(zhí)行結(jié)果中包含了 SQLAlchemy 打印的 SQL 語(yǔ)句，我們可以取消 crete_engine 中的 echo

engine = create_engine('sqlite:///./sqlalchemy.sqlite')

此時(shí)的執(zhí)行結(jié)果如下：

[<User(name='ed', fullname='Ed Jones', nickname='edsnickname')>]
[<User(name='ed', fullname='Ed Jones', nickname='edsnickname')>, <User(name='wendy', fullname='Wendy Williams', nickname='windy')>, <User(name='mary', fullname='Mary Contrary', nickname='mary')>]
[<User(name='admin', fullname='Ed Jones', nickname='edsnickname')>, <User(name='test', fullname='Wendy Williams', nickname='windy')>, <User(name='mary', fullname='Mary Contrary', nickname='mary')>, <User(name='fred', fullname='Fred Flintstone', nickname='freddy')>]

當(dāng)取消 echo 后，程序運(yùn)行結(jié)果中原有的 SQL 語(yǔ)句消失。

本文只是對(duì) SQLAlchemy 的使用進(jìn)行簡(jiǎn)單的介紹，SQLAlchemy 本身還有很多特性和運(yùn)用方法我們可以共同探討。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: