使用DBMS_OUTPUT向消息缓冲区发送消息或获取消息_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

DBMS_OUTPUT包用于向消息缓冲区发送消息，或者从消息缓冲区获取消息。

下表列出了DBMS_OUTPUT包允许使用的存储过程和函数。

表 1. DBMS_OUTPUT函数/存储过程
函数/存储过程	返回类型	描述
DISABLE	N/A	禁止访问缓冲区的消息。
ENABLE(buffer size)	N/A	允许访问缓冲区的消息。
GET_LINE(line OUT, status OUT)	N/A	从缓冲区中检索一行文本。
GET_LINES(lines OUT, numlines IN OUT)	N/A	从缓冲区中检索行数组。
NEW_LINE	N/A	放置一个行结束符。
PUT(item)	N/A	在缓冲区中放置部分行消息。
PUT_LINE(item)	N/A	在缓冲区中放置行消息。
SERVEROUTPUT(stdout)	N/A	使用`PUT`、`PUT_LINE`或`NEW_LINE`将消息直接发送到标准输出或消息缓冲区。

下表列出了DBMS_OUTPUT包允许使用的公共变量。

表 2. DBMS_OUTPUT公共变量
变量名称	变量类型	变量值	变量说明
chararr	TABLE	-	用于存储多行消息文本。

CHARARR

变量CHARARR用于存储多行消息文本。语法如下：

TYPE chararr IS TABLE OF VARCHAR2(32767) INDEX BY BINARY_INTEGER;

DISABLE

存储过程DISABLE用于清空消息缓冲区。在执行存储过程DISABLE时，将不能再访问任何在缓冲区中的消息。

您可以使用存储过程ENABLE或SERVEROUTPUT(TRUE)来重新发送和接收消息。语法如下：

DISABLE

示例

BEGIN
    DBMS_OUTPUT.DISABLE;
END;

ENABLE

存储过程ENABLE允许向消息缓冲区发送消息，或从消息缓冲区中接收消息。语法如下：

ENABLE [ (buffer_size INTEGER) ]

参数


参数名称	参数说明
buffer_size	消息缓冲区的最大长度。以字节为单位。如果指定的buffer_size小于2000，那么会自动把它设为2000。

示例

下面的匿名代码块使消息传递的功能生效。通过设置SERVEROUTPUT(TRUE)，可以强制把消息送到标准输出中。

BEGIN
    DBMS_OUTPUT.ENABLE;
    DBMS_OUTPUT.SERVEROUTPUT(TRUE);
    DBMS_OUTPUT.PUT_LINE('Messages enabled');
END;

Messages enabled

您也可以只通过使用SERVEROUTPUT(TRUE)实现相同的效果。

BEGIN
    DBMS_OUTPUT.SERVEROUTPUT(TRUE);
    DBMS_OUTPUT.PUT_LINE('Messages enabled');
END;

Messages enabled

下面的匿名代码块使消息传递的功能生效，通过设置SERVEROUTPUT(FALSE)，可以将消息送到消息缓冲区中。

BEGIN
    DBMS_OUTPUT.ENABLE;
    DBMS_OUTPUT.SERVEROUTPUT(FALSE);
    DBMS_OUTPUT.PUT_LINE('Message sent to buffer');
END;

GET_LINE

使用存储过程GET_LINE，您可以从消息缓冲区中获取一行由行结束符终止的文本。语法如下：

GET_LINE(line OUT VARCHAR2, status OUT INTEGER)

参数


参数名称	参数说明
line	用于从消息缓冲区接收文本行的变量。
status	如果从消息缓冲区返回一行文本，返回0。如果没有文本返回，返回1。

示例

下面的匿名代码块，将表emp中的记录以逗号分隔，并将分隔后的记录以字符串的形式写到消息缓冲区中。

EXEC DBMS_OUTPUT.SERVEROUTPUT(FALSE);

DECLARE
    v_emprec        VARCHAR2(120);
    CURSOR emp_cur IS SELECT * FROM emp ORDER BY empno;
BEGIN
    DBMS_OUTPUT.ENABLE;
    FOR i IN emp_cur LOOP
        v_emprec := i.empno || ',' || i.ename || ',' || i.job || ',' ||
            NVL(LTRIM(TO_CHAR(i.mgr,'9999')),'') || ',' || i.hiredate ||
            ',' || i.sal || ',' ||
            NVL(LTRIM(TO_CHAR(i.comm,'9990.99')),'') || ',' || i.deptno;
        DBMS_OUTPUT.PUT_LINE(v_emprec);
    END LOOP;
END;

下面的匿名代码块，先从消息缓冲区中读取文本消息，再将前一个示例写入的消息写入到messages表中，然后显示消息中的记录。

CREATE TABLE messages (
    status          INTEGER,
    msg             VARCHAR2(100)
);

DECLARE
    v_line          VARCHAR2(100);
    v_status        INTEGER := 0;
BEGIN
    DBMS_OUTPUT.GET_LINE(v_line,v_status);
    WHILE v_status = 0 LOOP
        INSERT INTO messages VALUES(v_status, v_line);
        DBMS_OUTPUT.GET_LINE(v_line,v_status);
    END LOOP;
END;

使用SELECT 查询messages表信息。

SELECT msg FROM messages;

显示结果如下：

                               msg
-----------------------------------------------------------------
 7369,SMITH,CLERK,7902,17-DEC-80 00:00:00,800.00,,20
 7499,ALLEN,SALESMAN,7698,20-FEB-81 00:00:00,1600.00,300.00,30
 7521,WARD,SALESMAN,7698,22-FEB-81 00:00:00,1250.00,500.00,30
 7566,JONES,MANAGER,7839,02-APR-81 00:00:00,2975.00,,20
 7654,MARTIN,SALESMAN,7698,28-SEP-81 00:00:00,1250.00,1400.00,30
 7698,BLAKE,MANAGER,7839,01-MAY-81 00:00:00,2850.00,,30
 7782,CLARK,MANAGER,7839,09-JUN-81 00:00:00,2450.00,,10
 7788,SCOTT,ANALYST,7566,19-APR-87 00:00:00,3000.00,,20
 7839,KING,PRESIDENT,,17-NOV-81 00:00:00,5000.00,,10
 7844,TURNER,SALESMAN,7698,08-SEP-81 00:00:00,1500.00,0.00,30
 7876,ADAMS,CLERK,7788,23-MAY-87 00:00:00,1100.00,,20
 7900,JAMES,CLERK,7698,03-DEC-81 00:00:00,950.00,,30
 7902,FORD,ANALYST,7566,03-DEC-81 00:00:00,3000.00,,20
 7934,MILLER,CLERK,7782,23-JAN-82 00:00:00,1300.00,,10
(14 rows)

GET_LINES

您可以使用存储过程GET_LINES从消息缓冲区中获取多行文本，再将这些文本放到一个集合中。语法如下：

GET_LINES(lines OUT CHARARR, numlines IN OUT INTEGER)

参数


参数名称	参数说明
lines	从消息缓冲区中接收文本行的表。关于lines的描述，参见变量CHARARR 。
numlines IN	从消息缓冲区中取出的文本行数。
numlines OUT	从消息缓冲区中实际取出的文本行数量。如果numlines的输出值小于输入值，那么表示在消息缓冲区中，没有文本了。

示例

示例中，使用存储过程GET_LINES将放在消息缓冲区中emp的记录存放到一个数组中。

EXEC DBMS_OUTPUT.SERVEROUTPUT(FALSE);

DECLARE
    v_emprec        VARCHAR2(120);
    CURSOR emp_cur IS SELECT * FROM emp ORDER BY empno;
BEGIN
    DBMS_OUTPUT.ENABLE;
    FOR i IN emp_cur LOOP
        v_emprec := i.empno || ',' || i.ename || ',' || i.job || ',' ||
            NVL(LTRIM(TO_CHAR(i.mgr,'9999')),'') || ',' || i.hiredate ||
            ',' || i.sal || ',' ||
            NVL(LTRIM(TO_CHAR(i.comm,'9990.99')),'') || ',' || i.deptno;
        DBMS_OUTPUT.PUT_LINE(v_emprec);
    END LOOP;
END;

DECLARE
    v_lines         DBMS_OUTPUT.CHARARR;
    v_numlines      INTEGER := 14;
    v_status        INTEGER := 0;
BEGIN
    DBMS_OUTPUT.GET_LINES(v_lines,v_numlines);
    FOR i IN 1..v_numlines LOOP
        INSERT INTO messages VALUES(v_numlines, v_lines(i));
    END LOOP;
END;

使用SELECT 查询messages表信息。

SELECT msg FROM messages;

显示结果如下：

                               msg
-----------------------------------------------------------------
 7369,SMITH,CLERK,7902,17-DEC-80 00:00:00,800.00,,20
 7499,ALLEN,SALESMAN,7698,20-FEB-81 00:00:00,1600.00,300.00,30
 7521,WARD,SALESMAN,7698,22-FEB-81 00:00:00,1250.00,500.00,30
 7566,JONES,MANAGER,7839,02-APR-81 00:00:00,2975.00,,20
 7654,MARTIN,SALESMAN,7698,28-SEP-81 00:00:00,1250.00,1400.00,30
 7698,BLAKE,MANAGER,7839,01-MAY-81 00:00:00,2850.00,,30
 7782,CLARK,MANAGER,7839,09-JUN-81 00:00:00,2450.00,,10
 7788,SCOTT,ANALYST,7566,19-APR-87 00:00:00,3000.00,,20
 7839,KING,PRESIDENT,,17-NOV-81 00:00:00,5000.00,,10
 7844,TURNER,SALESMAN,7698,08-SEP-81 00:00:00,1500.00,0.00,30
 7876,ADAMS,CLERK,7788,23-MAY-87 00:00:00,1100.00,,20
 7900,JAMES,CLERK,7698,03-DEC-81 00:00:00,950.00,,30
 7902,FORD,ANALYST,7566,03-DEC-81 00:00:00,3000.00,,20
 7934,MILLER,CLERK,7782,23-JAN-82 00:00:00,1300.00,,10
(14 rows)

NEW_LINE

存储过程NEW_LINE在消息缓冲区中写入一个行结束符。语法如下：

NEW_LINE

PUT

存储过程PUT将一个字符串写到消息缓冲区中。您可以使用存储过程NEW_LINE增加一个行结束符。语法如下：

PUT(item VARCHAR2)

参数


参数名称	参数说明
item	写到消息缓冲区中文本。

示例

下面的示例使用存储过程PUT展示了从表emp中查询出的雇员信息列表，这些雇员信息是以逗号分隔方式展现的。

DECLARE
    CURSOR emp_cur IS SELECT * FROM emp ORDER BY empno;
BEGIN
    FOR i IN emp_cur LOOP
        DBMS_OUTPUT.PUT(i.empno);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.ename);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.job);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.mgr);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.hiredate);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.sal);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.comm);
        DBMS_OUTPUT.PUT(',');
        DBMS_OUTPUT.PUT(i.deptno);
        DBMS_OUTPUT.NEW_LINE;
    END LOOP;
END;

显示结果如下：

7369,SMITH,CLERK,7902,17-DEC-80 00:00:00,800.00,,20
7499,ALLEN,SALESMAN,7698,20-FEB-81 00:00:00,1600.00,300.00,30
7521,WARD,SALESMAN,7698,22-FEB-81 00:00:00,1250.00,500.00,30
7566,JONES,MANAGER,7839,02-APR-81 00:00:00,2975.00,,20
7654,MARTIN,SALESMAN,7698,28-SEP-81 00:00:00,1250.00,1400.00,30
7698,BLAKE,MANAGER,7839,01-MAY-81 00:00:00,2850.00,,30
7782,CLARK,MANAGER,7839,09-JUN-81 00:00:00,2450.00,,10
7788,SCOTT,ANALYST,7566,19-APR-87 00:00:00,3000.00,,20
7839,KING,PRESIDENT,,17-NOV-81 00:00:00,5000.00,,10
7844,TURNER,SALESMAN,7698,08-SEP-81 00:00:00,1500.00,0.00,30
7876,ADAMS,CLERK,7788,23-MAY-87 00:00:00,1100.00,,20
7900,JAMES,CLERK,7698,03-DEC-81 00:00:00,950.00,,30
7902,FORD,ANALYST,7566,03-DEC-81 00:00:00,3000.00,,20
7934,MILLER,CLERK,7782,23-JAN-82 00:00:00,1300.00,,10

PUT_LINE

存储过程PUT_LINE向消息缓冲区写入一行带有行结束符的文本。语法如下：

PUT_LINE(item VARCHAR2)

参数


参数名称	参数说明
item	写入消息缓冲区的文本。

示例

下面的示例使用存储过程PUT_LINE展示了从emp表中查出的雇员记录，这些记录是以逗号分隔列表的形式展现的。

DECLARE
    v_emprec        VARCHAR2(120);
    CURSOR emp_cur IS SELECT * FROM emp ORDER BY empno;
BEGIN
    FOR i IN emp_cur LOOP
        v_emprec := i.empno || ',' || i.ename || ',' || i.job || ',' ||
            NVL(LTRIM(TO_CHAR(i.mgr,'9999')),'') || ',' || i.hiredate ||
            ',' || i.sal || ',' ||
            NVL(LTRIM(TO_CHAR(i.comm,'9990.99')),'') || ',' || i.deptno;
        DBMS_OUTPUT.PUT_LINE(v_emprec);
    END LOOP;
END;

显示结果如下：

7369,SMITH,CLERK,7902,17-DEC-80 00:00:00,800.00,,20
7499,ALLEN,SALESMAN,7698,20-FEB-81 00:00:00,1600.00,300.00,30
7521,WARD,SALESMAN,7698,22-FEB-81 00:00:00,1250.00,500.00,30
7566,JONES,MANAGER,7839,02-APR-81 00:00:00,2975.00,,20
7654,MARTIN,SALESMAN,7698,28-SEP-81 00:00:00,1250.00,1400.00,30
7698,BLAKE,MANAGER,7839,01-MAY-81 00:00:00,2850.00,,30
7782,CLARK,MANAGER,7839,09-JUN-81 00:00:00,2450.00,,10
7788,SCOTT,ANALYST,7566,19-APR-87 00:00:00,3000.00,,20
7839,KING,PRESIDENT,,17-NOV-81 00:00:00,5000.00,,10
7844,TURNER,SALESMAN,7698,08-SEP-81 00:00:00,1500.00,0.00,30
7876,ADAMS,CLERK,7788,23-MAY-87 00:00:00,1100.00,,20
7900,JAMES,CLERK,7698,03-DEC-81 00:00:00,950.00,,30
7902,FORD,ANALYST,7566,03-DEC-81 00:00:00,3000.00,,20
7934,MILLER,CLERK,7782,23-JAN-82 00:00:00,1300.00,,10

SERVEROUTPUT

存储过程SERVEROUTPUT将消息发送到命令行的标准输出或消息缓冲区。通过设置SERVEROUTPUT(TRUE)，能够在隐含状态下执行存储过程ENABLE。SERVEROUTPUT语法如下：

SERVEROUTPUT(stdout BOOLEAN)

SERVEROUTPUT的默认值取决于实际应用场景。例如：

在Oracle的SQL*PLUS中默认为SERVEROUTPUT(FALSE)。

说明在Oracle的SQL*PLUS中，这个默认值是通过SQL*PLUS的SET命令控制。
在PSQL中默认为SERVEROUTPUT(TRUE)。

参数


参数名称	参数说明
stdout	指定`PUT`、`PUT_LINE`或`NEW_LINE`发送消息的目的地。如果`SERVEROUTPUT`的最新状态是TRUE，那么将消息送到命令行的标准输出中。如果`SERVEROUTPUT`的最新状态是FALSE，那么将消息送到消息缓冲区中。

示例

下面的匿名代码块，将第一条信息发送到命令行的标准输出，第二条信息发送到消息缓冲区。

BEGIN
    DBMS_OUTPUT.SERVEROUTPUT(TRUE);
    DBMS_OUTPUT.PUT_LINE('This message goes to the command line');
    DBMS_OUTPUT.SERVEROUTPUT(FALSE);
    DBMS_OUTPUT.PUT_LINE('This message goes to the message buffer');
END;

显示结果如下：

This message goes to the command line

如果在同一个会话中执行下面的匿名代码块，那么就会将前面示例中存放在消息缓冲区的消息做为一条新的信息在命令行上显示出来。

BEGIN
    DBMS_OUTPUT.SERVEROUTPUT(TRUE);
    DBMS_OUTPUT.PUT_LINE('Flush messages from the buffer');
END;

显示结果如下：

This message goes to the message buffer
Flush messages from the buffer