Python ORM框架SQLAlchemy学习笔记之关系映射实例


Posted in Python onJune 10, 2014

昨天简单介绍了SQLAlchemy的使用,但是没有能够涉及其最精彩的ORM部分,今天我将简单说明一下,当然主要还是讲解官方文档的内容,由于是学习笔记,有可能存在精简或者自己理解的部分,不做权威依据。

当我们开始使用ORM,一种可配置的结构可以用于描述我们的数据库表,稍后我们定义的类将会被映射到这些表上。当然现代的SQLAlchemy(新版本SQLAlchemy,原文是modern SQLAlchemy)使用Declarative把这两件事一起做了,即允许我们把创建类和描述定义数据库表以及它们之间的映射关系一次搞定。

这段话是什么意思呢?简单来说吧,SQLAlchemy分为Classic (经典模式)和Modern (现代模式),Classic定义数据库表的模式比较传统,需要先描述这个表。

1. Classic 映射

比如以官方文档中的例子,我们拥有表结构如下:

CREATE TABLE [users] (
  [id]       INTEGER PRIMARY KEY,
  [name]     TEXT NOT NULL,
  [fullname] TEXT NOT NULL,
  [password] TEXT NOT NULL
);

下面我们描述这张表:

from sqlalchemy import Table, MetaData, Column, Integer, Stringmetadata = MetaData()
user = Table('users', metadata,
            Column('id', Integer, primary_key=True),
            Column('name', String(50)),
            Column('fullname', String(50)),
            Column('password', String(12))
        )

好,这样我们的表算是描述完成了,接下来我们需要定义我们的Python类,比如这样的:
class User(object):
    def __init__(self, name, fullname, password):
        self.name = name
        self.fullname = fullname
        self.password = password

如何让我们定义的类与之前描述的表结构发生映射关系就是我们接下来要做的:
from sqlalchemy.orm import mapper
mapper(User, user)

大家注意到mapper函数,第一个参数是我们类的名称,第二个参数是我们先前描述的表定义。

这就是传统的定义ORM的方法,有关这个方法的更多信息,可以阅读文档Mapper Configuration,以后有机会再和大家详谈。

2. Modern 映射

当大家都乐此不疲的定义描述表,定义类,再映射来实现ORM的时候,SQLAlchemy团队搞出了更简单的映射方法,那就是Modern模式了,即通过定义映射类来一次性完成所有任务。

为了定义的类能够被SQLAlchemy管理,所以引入了Declarative这个概念,也就是说我们所有的类必须是Declarative基类的子类,而这个基类可以通过下面的办法来获取:

from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()

当然一个程序内,这个基类最好是唯一的,建议存储在全局变量比如Base中供所有映射类使用。

现在通过刚才的代码我们得到了名为Base的基类,通过这个基类我们可以定义N多的映射子类,而这些子类都能被SQLAlchemy Declarative系统管理到。

下面我们还是看刚才的那个users表的例子:

from sqlalchemy import Column, Integer, String
class User(Base):
     __tablename__ = 'users'     id = Column(Integer, primary_key=True)
     name = Column(String)
     fullname = Column(String)
     password = Column(String)
     def __init__(self, name, fullname, password):
         self.name = name
         self.fullname = fullname
         self.password = password
     def __repr__(self):
        return "<User('%s','%s', '%s')>" % (self.name, self.fullname, self.password)

就这段代码就完成了我们先前在Classic中需要的三步,代码比原先更简洁和容易管理了,同刚才Classic中Table定义的Column,这个代表数据库表中的列,当然Integer和String代表着数据库表的字段类型了。

这样User类就建立起与数据库表的映射,真实表的名字可以使用__tablename__指明,然后是表列的集合,包括id、name、fullname以及password,当然想必大家已经知道了,我们通过primary_key=True已经指明id为主键了。当然一些数据库表可能不包含有主键(例如视图View,当然视图也可以被映射),ORM为了能够实际映射表需要至少一个列被定义为主键列。多列,比如复合多主键也能够被很好地映射支持。

大家可能注意到User类中还包含有通常意义上的Python魔术方法,包含__init__()初始化类(构造方法)以及__repr__()字符串化支持方法,当然这些都是可选的,如果需要这个类可以加入程序所需要的任意多方法或者属性,你只要把这个类看作一个普通的Python类就可以了。

当然User类唯一不能马虎的就是必须继承至Base,这个Base就是刚才我们通过declarative_base()生成的类,通过它我们可以接下来让SQLAlchemy Declarative系统管理并操作这些映射类和数据库表。

实际上包括继承的Base类,所有的类都应该是Python的新式类(new style class),关于新式类的更多信息可以参考Python手册。

随着我们的User映射类通过Declarative系统构造成功,我们就拥有了相关的定义信息,比如在Classic定义中介绍的Table()描述,也包含映射到表的类,就是User自身,我们可以通过User.__table__来查看我们的表描述情况:

>>> User.__table__ 
Table('users', MetaData(None),
    Column('id', Integer(), table=<users>, primary_key=True, nullable=False),
    Column('name', String(), table=<users>),
    Column('fullname', String(), table=<users>),
    Column('password', String(), table=<users>), schema=None)

当然找到描述表的数据结构,也应该能找到mapper,我们的Mapper对象可以通过__mapper__属性来获取,比如这样的:
>>> User.__mapper__ 
<Mapper at 0x...; User>

同样的MetaData可以通过.metadata属性找到。

好啦,下面轻松一下,见证奇迹的时刻,我们需不需要定义创建好实体数据库然后再定义ORM?对于SQLAlchemy来说这些都是小事一桩,其都可以给你一手包办,也就是说你可以完全不必理会数据库,交给SQLAlchemy就可以了,比如通过MetaData.create_all()并将engine参数传入即可(什么是engine?参考我的笔记1),比如通过下面的方式创建我们的users表。

>>> Base.metadata.create_all(engine) 
PRAGMA table_info("users")
()
CREATE TABLE users (
    id INTEGER NOT NULL,
    name VARCHAR,
    fullname VARCHAR,
    password VARCHAR,
    PRIMARY KEY (id)
)
()
COMMIT

由于我们开启了engine的echo=True,所以在交互命令下SQLAlchemy把SQL语句也输出了,正好可以检验是否符合我们的要求。

这样简单的create_all()我们就轻松建立起先前ORM映射定义的表啦。

时间不早了,今天先聊到这儿,下次再谈SQLAlchemy的其他特性。

Python 相关文章推荐
详解使用python的logging模块在stdout输出的两种方法
May 17 Python
python版简单工厂模式
Oct 16 Python
python Celery定时任务的示例
Mar 13 Python
解决pycharm无法调用pip安装的包问题
May 18 Python
Python基于pandas实现json格式转换成dataframe的方法
Jun 22 Python
python utc datetime转换为时间戳的方法
Jan 15 Python
OpenCV+Python识别车牌和字符分割的实现
Jan 31 Python
计算机二级python学习教程(3) python语言基本数据类型
May 16 Python
python框架flask表单实现详解
Nov 04 Python
pytorch-RNN进行回归曲线预测方式
Jan 14 Python
pytorch实现保证每次运行使用的随机数都相同
Feb 20 Python
python 详解turtle画爱心代码
Feb 15 Python
Python ORM框架SQLAlchemy学习笔记之安装和简单查询实例
Jun 10 #Python
Python使用htpasswd实现基本认证授权的例子
Jun 10 #Python
python网络编程学习笔记(10):webpy框架
Jun 09 #Python
python网络编程学习笔记(九):数据库客户端 DB-API
Jun 09 #Python
python网络编程学习笔记(八):XML生成与解析(DOM、ElementTree)
Jun 09 #Python
python网络编程学习笔记(七):HTML和XHTML解析(HTMLParser、BeautifulSoup)
Jun 09 #Python
python网络编程学习笔记(六):Web客户端访问
Jun 09 #Python
You might like
BBS(php &amp; mysql)完整版(二)
2006/10/09 PHP
php中strstr、strrchr、substr、stristr四个函数的区别总结
2014/09/22 PHP
php+mysql实现无限级分类
2015/11/11 PHP
使用一个for循环将N*N的二维数组的所有值置1实现方法
2017/05/29 PHP
PHP调用QQ互联接口实现QQ登录网站功能示例
2019/10/24 PHP
JS的replace方法介绍
2012/10/20 Javascript
使用 Node.js 做 Function Test实现方法
2013/10/25 Javascript
Json序列化和反序列化方法解析
2013/12/19 Javascript
七个很有意思的PHP函数
2014/05/12 Javascript
网页收藏夹显示ICO图标(代码少)
2015/08/04 Javascript
js实现文本框支持加减运算的方法
2015/08/19 Javascript
原生js获取iframe中dom元素--父子页面相互获取对方dom元素的方法
2016/08/05 Javascript
JS封装的三级联动菜单(使用时只需要一行js代码)
2016/10/24 Javascript
jQuery中map函数的两种方式
2017/04/07 jQuery
Angular2使用Angular CLI快速搭建工程(一)
2017/05/21 Javascript
jQuery实现鼠标移到某个对象时弹出显示层功能
2018/08/23 jQuery
微信小程序12行js代码自己写个滑块功能(推荐)
2020/07/15 Javascript
js实现滚动条自动滚动
2020/12/13 Javascript
python list 合并连接字符串的方法
2013/03/09 Python
python实现百万答题自动百度搜索答案
2018/01/16 Python
详解Python_shutil模块
2019/03/15 Python
简单了解python中的f.b.u.r函数
2019/11/02 Python
使用pandas的box_plot去除异常值
2019/12/10 Python
利用PyCharm操作Github(仓库新建、更新,代码回滚)
2019/12/18 Python
py-charm延长试用期限实例
2019/12/22 Python
解决pycharm同一目录下无法import其他文件
2020/02/12 Python
浅谈在django中使用filter()(即对QuerySet操作)时踩的坑
2020/03/31 Python
利物浦足球俱乐部官方商店(美国):Liverpool FC US
2019/10/09 全球购物
opencv实现图像几何变换
2021/03/24 Python
业务部经理岗位职责
2014/01/04 职场文书
网吧消防安全制度
2014/01/28 职场文书
西柏坡观后感
2015/06/08 职场文书
幼儿园托班教育随笔
2015/08/14 职场文书
jQuery实现广告显示和隐藏动画
2021/07/04 jQuery
CentOS下安装Jenkins的完整步骤
2022/04/07 Servers
html用代码制作虚线框怎么做? dw制作虚线圆圈的技巧
2022/12/24 HTML / CSS