[20260529]sqlplus set doc的使用.txt

--//SET DOC[UMENT] {ON|OFF} 是 SQL*Plus 中的一个已废弃(obsolete)命令，用于控制 DOCUMENT 命令(同样已废弃)所创建的文档块是
--//否输出到屏幕。

--//SQL*Plus 中，DOCUMENT 命令允许在脚本中嵌入多行说明文本，并以 # 单独一行结束；SET DOCUMENT [ON|OFF]则控制该文本块是否
--//显示：

--//感觉这功能还是有一定用处，特别在写大量注解的时候，做一个简单例子。

1.环境：
SCOTT@book01p> @ ver2
==============================
PORT_STRING                   : x86_64/Linux 2.4.xx
VERSION                       : 21.0.0.0.0
BANNER                        : Oracle Database 21c Enterprise Edition Release 21.0.0.0.0 - Production
BANNER_FULL                   : Oracle Database 21c Enterprise Edition Release 21.0.0.0.0 - Production
Version 21.3.0.0.0
BANNER_LEGACY                 : Oracle Database 21c Enterprise Edition Release 21.0.0.0.0 - Production
CON_ID                        : 0
PL/SQL procedure successfully completed.

2.简单测试脚本：
$ cat z1.txt
SET DOCUMENT ON

DOCUMENT
========================================
  功能:     显示科室代码以及名称(1)
  日期:     2026-05-29
========================================
#

SELECT * FROM dept;
-- 关闭文档显示，后续 DOCUMENT 块将不再输出
SET DOCUMENT OFF

DOCUMENT
========================================
  功能:     显示科室代码以及名称(2)
  日期:     2026-05-29
========================================
#
SELECT * FROM dept;

SCOTT@book01p> @ z1.txt
DOC>========================================
DOC>  功能:     显示科室代码以及名称(1)
DOC>  日期:     2026-05-29
DOC>========================================
DOC>#

    DEPTNO DNAME                          LOC
---------- ------------------------------ -------------
        10 ACCOUNTING                     NEW YORK
        20 RESEARCH                       DALLAS
        30 SALES                          CHICAGO
        40 OPERATIONS                     BOSTON


    DEPTNO DNAME                          LOC
---------- ------------------------------ -------------
        10 ACCOUNTING                     NEW YORK
        20 RESEARCH                       DALLAS
        30 SALES                          CHICAGO
        40 OPERATIONS                     BOSTON

--//前面设置SET DOCUMENT ON,执行时输出前面.加入SET DOCUMENT OFF后,第2部分的注解不输出.