精通 Oracle+Python，第 1 部分：查询最佳应践

首先，熟悉 Oracle-Python 连接性的基本概念

2007 年 9 月发布

在 Python 做事方式的核心原则中，有一个规定是要求具有到 API 的高级接口。数据库 API（在此例中为 Oracle API）就是一个例子。使用 Computronix 的 cx_Oracle Python 模块，您可以在维持与 Python 数据库 API 规范 v2.0 的兼容性的同时，控制 Oracle 的查询模型。

对于所有遵循该规范的客户端库而言，使用 DB API 2.0 查询数据库的模型都是一致的。在此基础上，cx_Oracle 的主要开发人员 Anthony Tuininga 添加了一组丰富的属性和方法，以向开发人员揭示 Oracle 独有的特性。仅用标准的方法而忘掉“额外的”方法是绝对可能的，但在本文中您不会这么做。通用数据库包装这一概念可能在某些情况下起作用，但与此同时，您会失去 RDBMS 提供的所有优化。

DB API 2.0 和 cx_Oracle 介绍

Python 数据库 API 规范 v2.0 是集体努力的成果，用于统一不同数据库系统的访问模型。拥有一组相对较少的方法和属性，在更换数据库供应商时就易于学习并保持一致。它不以任何方式将数据库对象映射到 Python 结构中。用户仍然需要手写 SQL。在更换到另一数据库后，此 SQL 可能需要重新编写。尽管如此，它还是出色而妥善地解决了 Python 数据库的连接性问题。

该规范定义了 API 的各个部分，如模块接口、连接对象、游标对象、类型对象和构造器、DB API 的可选扩展以及可选的错误处理机制。

数据库和 Python 语言之间的网关是连接对象。它包含烹制数据库驱动的应用程序所需的全部组件，不仅符合 DB API 2.0，而且是规范方法和属性的一个超集。在多线程的程序中，模块和连接可以在不同线程间进行共享，但是不支持游标共享。这一限制通常是可接受的，因为共享游标可能带有死锁风险。

Python 大量使用了异常模型，DB API 定义了若干标准异常，它们在调试应用程序中的问题时会非常有用。下面是一些标准异常，同时提供了原因类型的简要说明：

• Warning — 数据在进行插入等操作时被截断
• Error — 这里提到的除 Warning 外的所有异常的基类
• InterfaceError — 数据库接口而非数据库本身故障（本例为 cx_Oracle 问题）
• DatabaseError — 严格意义上的数据库问题
• DataError — 包含如下结果数据的问题：除数为 0，值超出范围等
• OperationalError — 与编程人员无关的数据库错误：连接丢失、内存分配错误、事务处理错误等
• IntegrityError — 数据库的关系完整性受到了影响，例如，外键约束失效
• InternalError — 数据库出现内部错误，例如，无效的游标、事务处理不同步
• ProgrammingError — 未找到表、SQL 语句中的语法错误、参数的数量指定错误等
• NotSupportedError — 调用的 API 部件并不存在

连接过程首先从连接对象开始，这是创建游标对象的基础。除游标操作外，连接对象还使用 commit() 和 rollback() 方法对事务进行管理。执行 SQL 查询、发出 DML/DCL 语句和获取结果这些过程均受游标控制。

在游标和连接类的实现中，cx_Oracle 对标准的 DB API 2.0 规范进行了最大程度的扩展。如果需要，所有这些扩展都将在文本中进行清楚地标记。

入门

在使用查询和游标前，需要首先建立一个到数据库的连接。提供证书和数据源名称的方法有多种，其结果都是相似的。在从下面的 Python 交互式会话提提取的内容中，连接对象 db、db1 和 db2 都是等同的。makedsn() 函数根据给定的参数值创建一个 TNS 条目。此处将它赋值给变量 dsn_tns。如果环境设置得当，您可以使用更短的形式 cx_Oracle.connect('hr/hrpwd')，从而省略用于 db 和 db1 的 Easy Connect 字符串。

	  
>>> import cx_Oracle
>>> db = cx_Oracle.connect('hr', 'hrpwd', 'localhost:1521/XE')
>>> db1 = cx_Oracle.connect('hr/hrpwd@localhost:1521/XE')
>>> dsn_tns = cx_Oracle.makedsn('localhost', 1521, 'XE')
>>> print dsn_tns
(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521)))
  (CONNECT_DATA=(SID=XE)))
>>> db2 = cx_Oracle.connect('hr', 'hrpwd', dsn_tns)	  

在连接对象的范围内（如分配给上面的 db 变量的连接对象），您可以通过查询版本属性获得数据库版本（这是 DB API 2.0 的一个扩展）。这可以用于使 Python 程序依赖于具体版本的 Oracle 产品。同样地，您可以通过查询 dsn 属性获得连接的连接字符串。

>>> print db.version
10.2.0.1.0
>>> versioning = db.version.split('.')
>>> print versioning
['10', '2', '0', '1', '0']
>>> if versioning[0]=='10':
...     print "Running 10g"
... elif versioning[0]=='9':
...    print "Running 9i"
...
Running 10g
>>> print db.dsn
localhost:1521/XE

游标对象

您可以使用连接对象的 cursor() 方法定义任意数量的游标。简单的程序使用一个游标就可以了，该游标可以一再地重复使用。但较大的项目可能要求几个不同的游标。

	  
>>> cursor = db.cursor()

应用程序逻辑通常要求清晰地区分处理针对数据库发出的语句时所经历的各个阶段。这有助于更好地理解性能瓶颈并编写更快且经过优化的代码。语句处理分三个阶段：

1. 分析（可选）
• cx_Oracle.Cursor.parse([statement])
  不一定要调用，因为在执行阶段将自动分析 SQL 语句。该方法可以用于在执行语句前对其进行验证。当这类语句中检测出错误时，会引发 DatabaseError 异常，相应的错误消息通常可能是“ORA-00900:invalid SQL statement, ORA-01031:insufficient privileges or ORA-00921:unexpected end of SQL command.”
  
  
2. 执行
• cx_Oracle.Cursor.execute(statement, [parameters], **keyword_parameters)
  此方法可以接受单个参数 — 一条 SQL 语句 — 直接针对数据库来运行。通过 parameters 或 keyword_parameters 参数赋值的绑定变量可以指定为字典、序列或一组关键字参数。如果已经提供了字典或关键字参数，那么这些值将与名称绑定。如果给出的是序列，将根据这些值的位置对它们进行解析。如果是查询操作，此方法返回一个变量对象列表；如果不是则返回 None。
• cx_Oracle.Cursor.executemany(statement, parameters)
  对于批量插入尤其有用，因为它可以将所需的 Oracle 执行操作的数量限制为仅一个。有关如何使用该方法的详细信息，请参见下面的“一次多行”部分。
  
  
3. 获取（可选）— 仅用于查询（因为 DDL 和 DCL 语句不返回结果）。在不执行查询的游标上，这些方法将引发 InterfaceError 异常。
• cx_Oracle.Cursor.fetchall()
  以字节组列表形式获取结果集中的所有剩余行。如果没有剩余的行，它返回一个空白列表。获取操作可以通过设置游标的 arraysize 属性进行调整，该属性可设置在每个底层请求中从数据库中返回的行数。arraysize 的设置越高，需要在网络中往返传输的次数越少。arraysize 的默认值为 1。
• cx_Oracle.Cursor.fetchmany([rows_no])
  用于从数据库中获取接下来的 rows_no 行。如果该参数未指定，该方法获取的行数是 arraysize 的数量。如果 rows_no 大于获取到的行的数目，该方法获取的行数是剩余的行数。
• cx_Oracle.Cursor.fetchone()
  从数据库中获取单个字节组，如果无剩余行则返回 none。

在继续了解游标示例前，请先了解 pprint 模块的 pprint 函数。它用于以清晰、可读的形式输出 Python 数据结构。

	  
>>> from pprint import pprint
>>> cursor.execute('SELECT * FROM jobs')
[, , 
 , ]
>>> pprint(cursor.fetchall())
[('AD_PRES', 'President', 20000, 40000),
 ('AD_VP', 'Administration Vice President', 15000, 30000),
 ('AD_ASST', 'Administration Assistant', 3000, 6000),
 ('FI_MGR', 'Finance Manager', 8200, 16000),
 ('FI_ACCOUNT', 'Accountant', 4200, 9000),
  |
 ('PR_REP', 'Public Relations Representative', 4500, 10500)]	

cx_Oracle 游标是迭代器。利用这些强大的 Python 结构，您可以一种自然的方式对序列进行迭代，该方式仅根据需要获取后续的项目。高成本的数据库选择操作自然符合这一思路，因为数据只在需要时才被获取。您可以进行迭代操作直至找到需要的值或满足另一条件，而不必创建或获取整个的结果集。

>>> cursor = db.cursor()
>>> cursor.execute('SELECT * FROM jobs')
[, , 
 , ]
>>> for row in cursor:    ## notice that this is plain English!
...     print row
...
('AD_VP', 'Administration Vice President', 15000, 30000)
('AD_ASST', 'Administration Assistant', 3000, 6000)
('FI_MGR', 'Finance Manager', 8200, 16000)
('FI_ACCOUNT', 'Accountant', 4200, 9000)
('AC_MGR', 'Accounting Manager', 8200, 16000)
 |
('PR_REP', 'Public Relations Representative', 4500, 10500)	

执行 list(cursor) 后，会针对 cursor.fetchall() 执行相同的任务。这是因为内置的 list() 函数会在给定的迭代器结束之前一直进行迭代。

数据类型

在获取阶段，基本的 Oracle 数据类型会映射到它们在 Python 中的等同数据类型中。cx_Oracle 维护一个单独的、有助于这一转换的数据类型集合。Oracle - cx_Oracle - Python 映射为：

Oracle	cx_Oracle	Python
VARCHAR2 NVARCHAR2 LONG	cx_Oracle.STRING	str
CHAR	cx_Oracle.FIXED_CHAR
NUMBER	cx_Oracle.NUMBER	int
FLOAT		float
DATE	cx_Oracle.DATETIME	datetime.datetime
TIMESTAMP	cx_Oracle.TIMESTAMP
CLOB	cx_Oracle.CLOB	cx_Oracle.LOB
BLOB	cx_Oracle.BLOB

除涉及大型对象的情况外，上述数据类型对于用户通常是透明的。截止到版本 4.3，cx_Oracle 仍然由自已来处理这些数据类型，而没有与内置的文件类型打包到一起。

cx_Oracle 目前不负责处理的其他数据类型包括 XMLTYPE 和所有复杂的类型。目前所有对未支持类型的列的查询都会失败，同时引发 NotSupportedError 异常。您需要从查询中清除它们或将它们转换为支持的数据类型。

例如，考虑下面用于存储聚合的 RSS 新闻提供的表：

	  
CREATE TABLE rss_feeds (
  feed_id NUMBER PRIMARY KEY,
  feed_url VARCHAR2(250) NOT NULL,
  feed_xml XMLTYPE
);	  

在试图使用 Python 查询此表时，需执行一些额外的步骤。在下例中，XMLType.GetClobVal() 用于以 CLOB 值形式从表中返回 XML。

>>> cursor.execute('SELECT * FROM rss_feeds')

Traceback (most recent call last):
  File "", line 1, in 
    cursor.execute('SELECT * FROM rss_feeds')
NotSupportedError: Variable_TypeByOracleDataType: unhandled data type 108
>>> cursor.execute('SELECT feed_id, feed_url, XMLType.GetClobVal(feed_xml) FROM rss_feeds')
[, , 
 ]

您可能已经注意到了，cx_Oracle.Cursor.execute* 系列方法为查询返回列数据类型。这些是变量对象列表（DB API 2.0 的扩展），它们在获取阶段之前获取值 None，在获取阶段之后获取合适的数据值。有关数据类型的详细信息可以通过游标对象的描述属性获得。该描述是一个包含 7 项内容的字节组，每个字节组包含列名、列类型、显示大小、内部大小、精度、范围以及是否存在空的可能。注意列信息仅可供 SQL 查询语句访问。

>>> column_data_types = cursor.execute('SELECT * FROM employees')
>>> print column_data_types
[, , 
 , , 
 , , 
 , , 
 , , 
 ]
>>> pprint(cursor.description)
[('EMPLOYEE_ID', , 7, 22, 6, 0, 0),
 ('FIRST_NAME', , 20, 20, 0, 0, 1),
 ('LAST_NAME', , 25, 25, 0, 0, 0),
 ('EMAIL', , 25, 25, 0, 0, 0),
 ('PHONE_NUMBER', , 20, 20, 0, 0, 1),
 ('HIRE_DATE', , 23, 7, 0, 0, 0),
 ('JOB_ID', , 10, 10, 0, 0, 0),
 ('SALARY', , 12, 22, 8, 2, 1),
 ('COMMISSION_PCT', , 6, 22, 2, 2, 1),
 ('MANAGER_ID', , 7, 22, 6, 0, 1),
 ('DEPARTMENT_ID', , 5, 22, 4, 0, 1)]

绑定变量模式

正如 Oracle 精英 Tom Kyte 介绍的那样，绑定变量是数据库开发的核心原则。它们不仅使程序运行更快，同时可以防范 SQL 注入攻击。请看以下查询：

SELECT * FROM emp_details_view WHERE department_id=50
SELECT * FROM emp_details_view WHERE department_id=60
SELECT * FROM emp_details_view WHERE department_id=90
SELECT * FROM emp_details_view WHERE department_id=110

在逐个运行时，它们需要分别进行分析，这为您的应用程序增加了额外的开销。通过使用绑定变量，您可以告诉 Oracle 对一个查询只分析一次。cx_Oracle 支持按名称或位置绑定变量。

按名称传递绑定变量要求执行方法的 parameters 参数是一个字典或一组关键字参数。下面的 query1 和 query2 是等同的：

	  
>>> named_params = {'dept_id':50, 'sal':1000}
>>> query1 = cursor.execute('SELECT * FROM employees 
  WHERE department_id=:dept_id AND salary>:sal', named_params)
>>> query2 = cursor.execute('SELECT * FROM employees 
  WHERE department_id=:dept_id AND salary>:sal', dept_id=50, sal=1000)	  

在使用已命名的绑定变量时，您可以使用游标的 bindnames() 方法检查目前已指定的绑定变量：

	  
>>> print cursor.bindnames()
['DEPT_ID', 'SAL']	 
 

按位置传递与此相似，但是您需要谨慎命名。变量名是任意的，因此这种方式很容易使查询混乱。在下例中，三个查询 r1、r2 和 r3 都是等同的。parameters 变量必须作为序列提供。

>>> r1 = cursor.execute('SELECT * FROM locations 
 WHERE country_id=:1 AND city=:2', ('US', 'Seattle'))
>>> r2 = cursor.execute('SELECT * FROM locations 
 WHERE country_id=:9 AND city=:4', ('US', 'Seattle'))
>>> r3 = cursor.execute('SELECT * FROM locations 
 WHERE country_id=:m AND city=:0', ('US', 'Seattle'))

在绑定时，您可以首先准备该语句，然后利用改变的参数执行 None。根据绑定变量时准备一个语句即足够这一原则，Oracle 将如同在上例中一样对其进行处理。准备好的语句可执行任意次。

>>> cursor.prepare('SELECT * FROM jobs WHERE min_salary>:min')
>>> r = cursor.execute(None, {'min':1000})
>>> print len(cursor.fetchall())
19

您已经限制了分析的次数。在下一段中，我们将清除不必要的执行，尤其是昂贵的批量插入。

一次多行

大型的插入操作不需求多次的单独插入，这是因为 Python 通过 cx_Oracle.Cursor.executemany 方法完全支持一次插入多行。限制执行操作的数量极大地改善了程序性能，因此在编写存在大量插入操作的应用程序时应首先考虑这一功能。

我们首先为 Python 模块列表创建一个表，这次直接从 Python 开始。您将在以后删除该表。

>>> create_table = """
CREATE TABLE python_modules (
  module_name VARCHAR2(50) NOT NULL,
  file_path VARCHAR2(300) NOT NULL
)
"""
>>> from sys import modules
>>> cursor.execute(create_table)
>>> M = []
>>> for m_name, m_info in modules.items():
...   try:
...     M.append((m_name, m_info.__file__))
...   except AttributeError:
...     pass
...
>>> len(M)
76
>>> cursor.prepare("INSERT INTO python_modules(module_name, file_path) VALUES (:1, :2)")
>>> cursor.executemany(None, M)
>>> db.commit()
>>> r = cursor.execute("SELECT COUNT(*) FROM python_modules")
>>> print cursor.fetchone()
(76,)
>>> cursor.execute("DROP TABLE python_modules PURGE")

仅向数据库发出一个执行操作，要求将 76 个模块名称全部插入。这对大型插入操作而言是一个巨大的性能提升。注意此处的两点小的不同：cursor.execute(create_tab) 不产生任何输出，这是因为它是一个 DDL 语句，而 (76,) 是一个有单个元素的字节组。不含逗号的 (76) 仅等同于整数 76。

结论

在熟悉了 Oracle-Python 连接性的基本概念后，您就可以开始编写您自己的数据库驱动的应用程序了。我强烈推荐利用 Python 交互式 shell，因它真的可以节省学习时间。

您已经学习了 SQL 语句经过的三个阶段以及如何将 Oracle 数据库需要执行的步骤减至最少。绑定变量是数据库应用程序开发不可避免的一部分，Python 支持按名称或位置进行绑定。

您还了解了 Oracle 和 Python 数据类型间的平滑转换，以及在将游标作为迭代器进行处理的上下文中数据库数据的自然处理方式。所有这些特性都促进了生产效率的提高并支持专注于数据，而这正是核心所在。