DBMS_OUTPUT程序包是我们在Oracle开发过程中常用的一个包体,使用该包我们可以从
存储过程、包或
触发器发送信息(messages)。Oracle推荐在debug PL/SQL程序时使用该
程序包,不推荐使用该包来做报表输出或其他格式化输出之用。
概述
DBMS_OUTPUT包主要用于调试PL/SQL程序,或者在SQL*PLUS命令中显示信息(displaying message)和报表,譬如我们可以写一个简单的匿名PL/SQL程序块,而该块出于某种目的使用DBMS_OUTPUT包来显示一些信息。
在该DBMS_OUTPUT包中存在2个
存储过程,它们是PUT_LINE和PUT过程,使用这2个Procedure可以做到将信息存放到PL/SQL的Buffer中,以便其他的
触发器、存储过程、程序包来读取。在独立的PL/SQL程序或匿名块中,我们还可以使用GET_LINES和GET这2个
存储过程来将存放在PL/SQL Buffer中的信息输出(display)到屏幕。
DBMS_OUTPUT包子程序摘要
|
|
DISABLE 存储过程 |
禁用消息输出 |
ENABLE 存储过程 |
启用消息输出 |
GET_LINE 存储过程 |
从buffer中获取单行信息 |
GET_LINES 存储过程 |
从buffer中获取信息数组 |
NEW_LINE 存储过程 |
终结有PUT过程所创建的一行 |
PUT 存储过程 |
将一行信息放到buffer中 |
PUT_LINE 存储过程 |
将部分行信息放到buffer中 |
注意目前PUT过程已废弃,因为遗留问题将被保留,但不在推荐使用。
DISABLE存储过程
该存储过程用以禁用对PUT, PUT_LINE, NEW_LINE, GET_LINE, and GET_LINES过程的调用,并会清理buffer中任何残存信息。
与之相反的是ENABLE存储过程,若在SQL*PLUS中使用SERVEROUTPUT选项则不需要调用该存储过程。
语法
DBMS_OUTPUT.DISABLE;
编译器指示
pragma restrict_references(disable,WNDS,RNDS);
ENABLE存储过程
该存储过程用以启用对PUT, PUT_LINE, NEW_LINE, GET_LINE, and GET_LINES存储过程的调用。
语法
DBMS_OUTPUT.ENABLE (
buffer_size IN INTEGER DEFAULT 20000);
编译指示
pragma restrict_references(enable,WNDS,RNDS);
参量
|
|
buffer_size |
Buffer长度的上限,单位为bytes字节。将buffer_size设置为NULL即指定没有限制 |
使用注意事项
当在SQL*PLUS总使用 SET SERVEROUTPUT选项时没有必要使用该过程若有多次对ENABLE过程的调用,那么buffer_size以最后指定的为准。当用户没有指定buffer size为NULL时,该参量的上限为1,000,000字节,而下限为2,000一般建议buffer size设置为NULL,10g中默认值使用20000以便兼容老的数据库版本。
GET_LINE 存储过程
该过程用以从buffer中获取单行信息。
语法
DBMS_OUTPUT.GET_LINE (
line OUT VARCHAR2,
status OUT INTEGER);
参量
|
|
line |
将返回buffer中的一行信息,但不包括最后的换行符。一般建议申明该参数为VARCHAR2(32767)类型,以避免出现ORA-06502: PL/SQL: numeric or value error: character string buffer too small”.错误 |
status |
若调用成功则返回0,若buffer中没有更多行的信息则返回1 |
使用注意事项
可以选择是从buffer中获取单行还是多行的数组信息。使用GET_LINE过程可以获取单行信息。从性能考虑,应当减少调用次数,使用GET_LINES函数直接从buffer中返回一个多行的数组若在使用SQL*PLUS则可以设置SET SERVEROUTPUT选项控制是否直接输出到屏幕在调用GET_LINE或GET_LINES后,任何行信息在下一次的PUT, PUT_LINE, or NEW_LINE前没有被获取的都将被丢弃,以避免误会
GET_LINES 存储过程
该存储过程用以从Buffer中获取一个多行的的数组
语法
DBMS_OUTPUT.GET_LINES (
lines OUT CHARARR,
numlines IN OUT INTEGER);
DBMS_OUTPUT.GET_LINES (
lines OUT DBMSOUTPUT_LINESARRAY,
numlines IN OUT INTEGER);
参量
|
|
lines |
返回Buffer中多行信息的数组。该数组中每行的最大长度为32767bytes。 |
numlines |
想要获取行的数量。在成功获取多行信息后,该过程将返回实际获取的行数。若返回的数字小于要求的值时,说明buffer中没有更多行的信息了。 |
使用注意事项:
可以选择是从buffer中获取单行还是多行的数组信息。使用GET_LINE过程可以获取单行信息。从性能考虑,应当减少调用次数,使用GET_LINES函数直接从buffer中返回一个多行的数组若在使用SQL*PLUS则可以设置SET SERVEROUTPUT选项控制是否直接输出到屏幕在调用GET_LINE或GET_LINES后,任何行信息在下一次的PUT, PUT_LINE, or NEW_LINE前没有被获取的都将被丢弃,以避免误会