当前位置：Gxlcms > 数据库问题 > SQLAlchemy技术文档（中文版）-上

SQLAlchemy技术文档（中文版）-上

时间：2021-07-01 10:21:17 帮助过：3人阅读

1.版本检查

  1. <span style="color: #0000ff;">import</span><span style="color: #000000;"> sqlalchemy
  2. sqlalchemy.</span><span style="color: #800080;">__version__</span>

2.连接

  1. <span style="color: #0000ff;">from</span> sqlalchemy <span style="color: #0000ff;">import</span><span style="color: #000000;"> create_engine
  2. engine </span>= create_engine(<span style="color: #800000;">‘</span><span style="color: #800000;">sqlite:///:memory:</span><span style="color: #800000;">‘</span>,echo=True)

echo参数为True时，会显示每条执行的SQL语句，可以关闭。create_engine()返回一个Engine的实例，并且它表示通过数据库语法处理细节的核心接口，在这种情况下，数据库语法将会被解释称Python的类方法。

3.声明映像

当使用ORM【1】时，构造进程首先描述数据库的表，然后定义我们用来映射那些表的类。在现版本的SQLAlchemy中，这两个任务通常一起执行，通过使用Declarative方法，我们可以创建一些包含描述要被映射的实际数据库表的准则的映射类。

使用Declarative方法定义的映射类依据一个基类，这个基类是维系类和数据表关系的目录——我们所说的Declarative base class。在一个普通的模块入口中，应用通常只需要有一个base的实例。我们通过declarative_base()功能创建一个基类：

  1. <span style="color: #0000ff;">from</span><span style="color: #000000;"> sqlalchemy.ext.declarative import declarative_base
  2. Base </span>= declarative_base()

 

有了这个base，我们可以依据这个base定义任意数量的映射类。一个简单的user例子：

  1. <span style="color: #0000ff;">from</span> sqlalchemy <span style="color: #0000ff;">import</span><span style="color: #000000;"> Column, Integer, String
  2. </span><span style="color: #0000ff;">class</span><span style="color: #000000;"> User(Base):
  3. </span><span style="color: #800080;">__tablename__</span>= <span style="color: #800000;">‘</span><span style="color: #800000;">users</span><span style="color: #800000;">‘</span><span style="color: #000000;">
  4. id</span>= Column(Integer, primary_key=<span style="color: #000000;">True)
  5. name </span>= Column(String)

用Declarative构造的一个类至少需要一个__tablename__属性，一个主键行。

4.构造模式（项目中没用到）

5.创建映射类的实例

  1. ed_user = User(name=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,fullname=<span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>, password=<span style="color: #800000;">‘</span><span style="color: #800000;">edspassword</span><span style="color: #800000;">‘</span>)

 

6.创建会话

现在我们已经准备毫和数据库开始会话了。ORM通过Session与数据库建立连接的。当应用第一次载入时，我们定义一个Session类（声明create_engine()的同时），这个Session类为新的Session对象提供工厂服务。

  1. <span style="color: #0000ff;">from</span> sqlalchemy.orm <span style="color: #0000ff;">import</span><span style="color: #000000;"> sessionmaker
  2. Session </span>= sessionmaker(bind=engine)

这个定制的Session类会创建绑定到数据库的Session对象。如果需要和数据库建立连接，只需要实例化一个Session：

  1. session = Session()

 

虽然上面的Session已经和数据库引擎Engine关联，但是还没有打开任何连接。当它第一次被使用时，就会从Engine维护的一个连接池中检索是否存在连接，如果存在便会保持连接知道我们提交所有更改并且/或者关闭session对象。

7.添加新对象（简略）

  1. ed_user = User(name=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>, fullname=<span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>, password=<span style="color: #800000;">‘</span><span style="color: #800000;">edspassword</span><span style="color: #800000;">‘</span><span style="color: #000000;">)
  2. session.add(ed_user)</span>

 

至此，我们可以认为，新添加的这个对象实例仍在等待中；ed_user对象现在并不代表数据库中的一行数据。直到使用flush进程，Session才会让SQL保持连接。如果查询这条数据的话，所有等待信息会被第一时间刷新，查询结果也会立即发行。

  1. session.commit()

通过commit()可以提交所有剩余的更改到数据库。

8.回滚

  1. session.rollback()

 

9.查询

通过Session的query()方法创建一个查询对象。这个函数的参数数量是可变的，参数可以是任何类或者是类的描述的集合。下面是一个迭代输出User类的例子：

  1. <span style="color: #0000ff;">for</span> instance <span style="color: #0000ff;">in</span><span style="color: #000000;"> session.query(User).order_by(User.id):
  2. </span><span style="color: #0000ff;">print</span> instance.name,instance.fullname

 

Query也支持ORM描述作为参数。任何时候，多个类的实体或者是基于列的实体表达都可以作为query()函数的参数，返回类型是元组：

  1. <span style="color: #0000ff;">for</span> name, fullname <span style="color: #0000ff;">in</span><span style="color: #000000;"> session.query(User.name,User.fullname): 
  2. </span><span style="color: #0000ff;">print</span> name, fullname

 

Query返回的元组被命名为KeyedTuple类的实例元组。并且可以把它当成一个普通的Python数据类操作。元组的名字就相当于属性的属性名，类的类名一样。

  1. <span style="color: #0000ff;">for</span> row <span style="color: #0000ff;">in</span><span style="color: #000000;"> session.query(User, User.name).all():
  2. </span><span style="color: #0000ff;">print</span><span style="color: #000000;"> row.User,row.name
  3. </span><User(name=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,fullname=<span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>, password=<span style="color: #800000;">‘</span><span style="color: #800000;">f8s7ccs</span><span style="color: #800000;">‘</span>)>ed

 

label()不知道怎么解释，看下例子就明白了。相当于row.name

  1. <span style="color: #0000ff;">for</span> row <span style="color: #0000ff;">in</span> session.query(User.name.label(<span style="color: #800000;">‘</span><span style="color: #800000;">name_label</span><span style="color: #800000;">‘</span><span style="color: #000000;">)).all():
  2. </span><span style="color: #0000ff;">print</span>(row.name_label)

 

aliased()我的理解是类的别名，如果有多个实体都要查询一个类，可以用aliased()

  1. <span style="color: #0000ff;">from</span> sqlalchemy.orm <span style="color: #0000ff;">import</span><span style="color: #000000;"> aliased
  2. user_alias </span>= aliased(User, name=<span style="color: #800000;">‘</span><span style="color: #800000;">user_alias</span><span style="color: #800000;">‘</span><span style="color: #000000;">)
  3. </span><span style="color: #0000ff;">for</span> row <span style="color: #0000ff;">in</span><span style="color: #000000;"> session.query(user_alias,user_alias.name).all():
  4. </span><span style="color: #0000ff;">print</span> row.user_alias

 

Query的 基本操作包括LIMIT和OFFSET，使用Python数组切片和ORDERBY结合可以让操作变得很方便。

  1. <span style="color: #0000ff;">for</span> u <span style="color: #0000ff;">in</span> session.query(User).order_by(User.id)[1:3]:
  1. <span lang="en-US"><span lang="en-US"><br>#只查询第二条和第三条数据
  2. </span></span>

 

9.1使用关键字变量过滤查询结果，filter 和 filter_by都适用。

   【2】使用很简单，下面列出几个常用的操作：

  1. query.filter(User.name == <span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>) <span style="color: #008000;">#</span><span style="color: #008000;">equals</span>
  2. query.filter(User.name != <span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>) <span style="color: #008000;">#</span><span style="color: #008000;">not equals</span>
  3. query.filter(User.name.like(<span style="color: #800000;">‘</span><span style="color: #800000;">%ed%</span><span style="color: #800000;">‘</span>)) <span style="color: #008000;">#</span><span style="color: #008000;">LIKE</span>
  4. uery.filter(User.name.in_([<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,<span style="color: #800000;">‘</span><span style="color: #800000;">wendy</span><span style="color: #800000;">‘</span>, <span style="color: #800000;">‘</span><span style="color: #800000;">jack</span><span style="color: #800000;">‘</span>])) <span style="color: #008000;">#</span><span style="color: #008000;">IN</span>
  5. query.filter(User.name.in_(session.query(User.name).filter(User.name.like(<span style="color: #800000;">‘</span><span style="color: #800000;">%ed%</span><span style="color: #800000;">‘</span>))<span style="color: #008000;">#</span><span style="color: #008000;">IN</span>
  6. query.filter(~User.name.in_([<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,<span style="color: #800000;">‘</span><span style="color: #800000;">wendy</span><span style="color: #800000;">‘</span>, <span style="color: #800000;">‘</span><span style="color: #800000;">jack</span><span style="color: #800000;">‘</span>]))<span style="color: #008000;">#</span><span style="color: #008000;">not IN</span>
  7. query.filter(User.name == None)<span style="color: #008000;">#</span><span style="color: #008000;">is None</span>
  8. query.filter(User.name != None)<span style="color: #008000;">#</span><span style="color: #008000;">not None</span>
  9. <span style="color: #0000ff;">from</span> sqlalchemy <span style="color: #0000ff;">import</span><span style="color: #000000;"> and_
  10. query.filter(and_(User.name </span>==<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,User.fullname ==<span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>)) <span style="color: #008000;">#</span><span style="color: #008000;"> and</span>
  11. query.filter(User.name == <span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,User.fullname ==<span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>) <span style="color: #008000;">#</span><span style="color: #008000;"> and</span>
  12. query.filter(User.name == <span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>).filter(User.fullname == <span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>)<span style="color: #008000;">#</span><span style="color: #008000;"> and</span>
  13. <span style="color: #0000ff;">from</span> sqlalchemy <span style="color: #0000ff;">import</span><span style="color: #000000;"> or_
  14. query.filter(or_(User.name </span>==<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>, User.name ==<span style="color: #800000;">‘</span><span style="color: #800000;">wendy</span><span style="color: #800000;">‘</span>)) <span style="color: #008000;">#</span><span style="color: #008000;">or</span>
  15. query.filter(User.name.match(<span style="color: #800000;">‘</span><span style="color: #800000;">wendy</span><span style="color: #800000;">‘</span>)) <span style="color: #008000;">#</span><span style="color: #008000;">match</span>

 

9.2.返回列表和数量（标量？）

all()返回一个列表：可以进行Python列表的操作。

  1. query = session.query(User).filter(User.name.like(<span style="color: #800000;">‘</span><span style="color: #800000;">%ed</span><span style="color: #800000;">‘</span><span style="color: #000000;">)).order_by(User.id)
  2. query.all()
  3. [</span><User(name=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,fullname=<span style="color: #800000;">‘</span><span style="color: #800000;">EdJones</span><span style="color: #800000;">‘</span>, password=<span style="color: #800000;">‘</span><span style="color: #800000;">f8s7ccs</span><span style="color: #800000;">‘</span>)>,<User(name=<span style="color: #800000;">‘</span><span style="color: #800000;">fred</span><span style="color: #800000;">‘</span><span style="color: #000000;">,
  4. fullname</span>=<span style="color: #800000;">‘</span><span style="color: #800000;">FredFlinstone</span><span style="color: #800000;">‘</span>, password=<span style="color: #800000;">‘</span><span style="color: #800000;">blah</span><span style="color: #800000;">‘</span>)>]

 

first()适用于限制一个情况，返回查询到的第一个结果作为标量？：好像只能作为属性，类

  1. <span style="color: #000000;">query.first()
  2. </span><User(name=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>,fullname=<span style="color: #800000;">‘</span><span style="color: #800000;">Ed Jones</span><span style="color: #800000;">‘</span>, password=<span style="color: #800000;">‘</span><span style="color: #800000;">f8s7ccs</span><span style="color: #800000;">‘</span>)>

 

one()完全获取所有行，并且如果查询到的不只有一个对象或是有复合行，就会抛出异常。

  1. <span style="color: #0000ff;">from</span> sqlalchemy.orm.exc <span style="color: #0000ff;">import</span><span style="color: #000000;"> MultipleResultsFound
  2. user </span>=<span style="color: #000000;"> query.one()
  3. </span><span style="color: #0000ff;">try</span><span style="color: #000000;">:
  4. 　　user </span>=<span style="color: #000000;"> query.one()
  5. </span><span style="color: #0000ff;">except</span><span style="color: #000000;">
  6. 　　MultipleResultsFound, e:
  7. 　　</span><span style="color: #0000ff;">print</span><span style="color: #000000;"> e
  8. Multiple rows were found </span><span style="color: #0000ff;">for</span> one()

 

如果一行也没有：

  1. <span style="color: #0000ff;">from</span> sqlalchemy.orm.exc <span style="color: #0000ff;">import</span><span style="color: #000000;"> NoResultFound
  2. </span><span style="color: #0000ff;">try</span><span style="color: #000000;">:
  3. 　　user </span>= query.filter(User.id == 99<span style="color: #000000;">).one()
  4. </span><span style="color: #0000ff;">except</span><span style="color: #000000;">
  5. NoResultFound, e:
  6. 　　</span><span style="color: #0000ff;">print</span><span style="color: #000000;"> e
  7. No row was found </span><span style="color: #0000ff;">for</span> one()

 

one()方法对于想要解决“no items found”和“multiple items found”是不同的系统是极好的。（这句有语病啊）例如web服务返回，本来是在no results found情况下返回”404“的，结果在多个results found情况下也会跑出一个应用异常。

scalar()作为one()方法的依据，并且在one()成功基础上返回行的第一列。

  1. query = session.query(User.id).filter(User.name == <span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span><span style="color: #000000;">)
  2. query.scalar()</span>

 

9.3.使用字符串SQL

字符串能使Query更加灵活，通过text()构造指定字符串的使用，这种方法可以用在很多方法中，像filter()和order_by()。

  1. <span style="color: #0000ff;">from</span> sqlalchemy <span style="color: #0000ff;">import</span><span style="color: #000000;"> text
  2. </span><span style="color: #0000ff;">for</span> user <span style="color: #0000ff;">in</span> session.query(User).filter(text(<span style="color: #800000;">"</span><span style="color: #800000;">id<224</span><span style="color: #800000;">"</span>)).order_by(text(<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>)).all()

 

绑定参数可以指定字符串，用params()方法指定数值。

  1. session.query(User).filter(text(<span style="color: #800000;">"</span><span style="color: #800000;">id<:value and name=:name</span><span style="color: #800000;">"</span><span style="color: #000000;">)).
  2. params(value</span>=224, name=<span style="color: #800000;">‘</span><span style="color: #800000;">fred</span><span style="color: #800000;">‘</span>).order_by(User.id).one()

如果要用一个完整的SQL语句，可以使用from_statement()。

  1. session.query(User).from_statement(text(<span style="color: #800000;">"</span><span style="color: #800000;">SELECT* FROM users where name=:name</span><span style="color: #800000;">"</span><span style="color: #000000;">)).            params(name</span>=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>).all()

 

也可以用from_statement()获取完整的”raw”，用字符名确定希望被查询的特定列:

  1. session.query(<span style="color: #800000;">"</span><span style="color: #800000;">id</span><span style="color: #800000;">"</span>,<span style="color: #800000;">"</span><span style="color: #800000;">name</span><span style="color: #800000;">"</span>, <span style="color: #800000;">"</span><span style="color: #800000;">thenumber12</span><span style="color: #800000;">"</span><span style="color: #000000;">).
  2. from_statement(text(</span><span style="color: #800000;">"</span><span style="color: #800000;">SELECT id, name, 12 as </span><span style="color: #800000;">""</span><span style="color: #800000;">thenumber12 FROM users where name=:name</span><span style="color: #800000;">"</span><span style="color: #000000;">)).　params(name</span>=<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span><span style="color: #000000;">).all()
  3. [(</span>1,u<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>, 12)]
  1. 感觉这个不太符合<span lang="en-US">ORM的思想啊。。。</span>
  1. <em id="__mceDel">
  2. </em>

9.4 计数

count()用来统计查询结果的数量。

  1. session.query(User).filter(User.name.like(<span style="color: #800000;">‘</span><span style="color: #800000;">%ed</span><span style="color: #800000;">‘</span>)).count()

 

func.count()方法比count()更高级一点【3】

  1. <span style="color: #0000ff;">from</span> sqlalchemy <span style="color: #0000ff;">import</span><span style="color: #000000;"> func
  2. session.query(func.count(User.name),User.name).group_by(User.name).all()
  3.  
  4. [(</span>1,u<span style="color: #800000;">‘</span><span style="color: #800000;">ed</span><span style="color: #800000;">‘</span>), (1,u<span style="color: #800000;">‘</span><span style="color: #800000;">fred</span><span style="color: #800000;">‘</span>), (1,u<span style="color: #800000;">‘</span><span style="color: #800000;">mary</span><span style="color: #800000;">‘</span>), (1,u<span style="color: #800000;">‘</span><span style="color: #800000;">wendy</span><span style="color: #800000;">‘</span>)]

 

为了实现简单计数SELECT count(*) FROM table，可以这么写：

  1. session.query(func.count(<span style="color: #800000;">‘</span><span style="color: #800000;">*</span><span style="color: #800000;">‘</span>)).select_from(User).scalar()

 

如果我们明确表达计数是根据User表的主键的话，可以省略select_from(User):

  1. session.query(func.count(User.id)).scalar()

 

上面两行结果均为4。

SQLAlchemy技术文档（中文版）-上

标签：ams   int   关闭   计数   sqlite   use   val   添加   理解   

人气教程排行

本站所有资源全部来源于网络，若本站发布的内容侵害到您的隐私或者利益，请联系我们删除！