Python调用Oracle存储过程如何获取DBMS_OUTPUT输出？

DBMS_OUTPUT的输出默认不会随存储过程执行自动返回给客户端，Oracle SQL Developer能直接显示输出，是因为工具内部自动完成了启用输出缓冲区、存储过程执行后拉取缓冲区内容的操作，Python调用时需要手动实现这部分逻辑。

实现步骤 #

• 调用存储过程前，执行DBMS_OUTPUT.ENABLE启用输出缓冲区，可指定缓冲区大小，传入None代表不限制容量
• 按原有逻辑调用目标存储过程
• 循环调用DBMS_OUTPUT.GET_LINE拉取缓冲区中的所有输出行，直到缓冲区为空
• 可选：拉取完成后执行DBMS_OUTPUT.DISABLE关闭输出，释放缓冲区资源

代码示例 #

对应原有调用逻辑的完整可运行代码如下（以常用的cx_Oracle驱动为例，新版oracledb驱动仅需替换导入包名即可）：

import cx_Oracle

# 此处省略创建数据库连接conn的代码
cursor = conn.cursor()

# 启用DBMS_OUTPUT缓冲区
cursor.callproc("DBMS_OUTPUT.ENABLE", (None,))

# 原有存储过程调用逻辑保持不变
cursor.callproc('search', ('math', 'paris'))

# 定义变量绑定存储过程输出参数
line_content = cursor.var(cx_Oracle.STRING)
line_status = cursor.var(cx_Oracle.NUMBER)
output_result = []

# 循环读取所有输出行
while True:
    cursor.callproc("DBMS_OUTPUT.GET_LINE", (line_content, line_status))
    # 状态值为0代表读取到有效行，非0代表缓冲区已无内容
    if line_status.getvalue() != 0:
        break
    output_result.append(line_content.getvalue())

# 关闭DBMS_OUTPUT
cursor.callproc("DBMS_OUTPUT.DISABLE")

# 输出所有拿到的DBMS_OUTPUT内容
for line in output_result:
    print(line)

优化说明 #

• 如果存储过程输出内容较多，可以替换DBMS_OUTPUT.GET_LINE为DBMS_OUTPUT.GET_LINES一次性批量拉取多行，减少数据库交互次数，提升执行效率
• 使用新版python-oracledb驱动时，仅需将导入语句替换为import oracledb，变量类型对应替换为oracledb.STRING、oracledb.NUMBER即可，其余逻辑完全一致

内容的提问来源于stack exchange，提问作者sqll