SET CLPPlus コマンド

SET CLPPlus コマンドは、CLPPlus インターフェースに関するセッション・レベルの変数を制御します。

重要:
  • SET コマンドの呼び出しごとに、パラメーターを 1 つのみ指定できます。
  • バッチ・スクリプトで、複数の SET コマンドを連続して発行することができます。

呼び出し

このコマンドは CLPPlus インターフェースから実行する必要があります。

許可

なし

必要な接続

なし

コマンド構文

構文図を読む構文図をスキップするSETARRAYSIZEinteger-valueAUTOCOMMITAUTOONOFFOFFALLIMMEDIATEstatement_countAUTOTRACEAUTOTONOFFTRACEONLYTRACEEXPLAINEXPSTATISTICSSTATBGCOLORcolorr,g,bCOLORcolorr,g,bCOLSEPcolumn-separatorDUPLICATESONOFFECHOONOFFENCODINGencoding-formatENVARSUBSTITUTIONENVARSUBSTONOFFESCAPEONOFFcharacterFEEDBACKFEEDONOFFrow-thresholdFLUSHFLUONOFFFONTname,style,sizeHEADINGHEADHEAONOFFHEADSEPHEADSLOGMODElogmode-valueJCCLOGMODEjcclogmode-valueLINESIZELINwidth-of-lineLOCALElocale_nameLOGPATHlog-pathLONGinteger-valueNEWPAGENEWPlines-per-pageNULLnull-stringNUMFORMATformat-stringNUMWIDTHOFFinteger-valuePAGESIZEPAGESlines-per-pageSQLCASESQLCMIXEDMIXUPPERUPLOWERLOPAUSEPAUONOFFPRESERVEWHITESPACETRUEFALSERECSEPONOFFRECSEPCHARcharacterSERVEROUTPUTONOFFSIZEUNLIMITEDnFORMATWRAPPEDWORD_WRAPPEDTRUNCATEDSQLPROMPTSQLPpromptTERMOUTTERMONOFFTIMINGTIMIONOFFTRIMOUTTRIMOONOFFTRIMSPOOLTRIMSONOFFUNDERLINEONOFFVERBOSEONOFFVERIFYVERONOFFWRAPONOFF

コマンド・パラメーター

ARRAYSIZE integer-value
サーバーから一度にフェッチされる行数を定義します。 このパラメーターを使用して、照会のパフォーマンスを調整できます。 有効な値は 1 から 10000 までです。 デフォルト値は 10 です。
AUTOCOMMIT | AUTO
CLPPlus の SQL ステートメントのコミット動作を制御します。 CLPPlus は常に、DDL ステートメントを自動的にコミットします。
ON | IMMEDIATE
SQL ステートメントの自動コミットメントを使用可能にします。
OFF
DDL ステートメント以外の SQL ステートメントの自動コミットメントを使用不可にします。
OFFALL
SQL ステートメントの自動コミットメントを使用不可にします。
AUTOTRACE | AUTOT
CLPPlus セッションでの SQL ステートメントのプランの Explain と統計情報の表示を制御します。
ON
AUTOTRACE を使用可能にします。 AUTOTRACE パラメーターを ON に設定すると、セッションが終了するまで、または AUTOTRACE パラメーターが OFF に設定されるまで、CLPPlus は Explain 情報を表示し続けます。
OFF
AUTOTRACE を使用不可にします。
TRACEONLY | TRACE
照会実行出力の表示を使用不可にします。
EXPLAIN | EXP
プランの Explain の表示を使用可能にします。
STATISTICS | STAT
ステートメントの統計の表示を使用可能にします。
BGCOLOR color|r,g,b
ウィンドウ・モードでの背景色を設定します。
color
color 変数に有効な値は、次のとおりです。
  • BLACK|black
  • BLUE|blue
  • CYAN|cyan
  • DARK_GRAY|darkGray
  • GRAY|gray
  • GREEN|green
  • LIGHT_GRAY|lightGray
  • MAGENTA|magenta
  • ORANGE|orange
  • PINK|pink
  • RED|red
  • WHITE|white
  • YELLOW|yellow
r,g,b
指定された赤、緑、および青の値を使用して、不透明な RGB 色を設定します。 赤、緑、および青の値として有効な範囲は、0 から 255 までです。 無効な値はすべて 255 として扱われます。
COLOR color|r,g,b
ウィンドウ・モードでのフォントの色を設定します。
color
color 変数に有効な値は、次のとおりです。
  • BLACK|black
  • BLUE|blue
  • CYAN|cyan
  • DARK_GRAY|darkGray
  • GRAY|gray
  • GREEN|green
  • LIGHT_GRAY|lightGray
  • MAGENTA|magenta
  • ORANGE|orange
  • PINK|pink
  • RED|red
  • WHITE|white
  • YELLOW|yellow
r,g,b
指定された赤、緑、および青の値を使用して、不透明な RGB 色を設定します。 赤、緑、および青の値として有効な範囲は、0 から 255 までです。 無効な値はすべて 255 として扱われます。
COLSEP column-separator
表の列間に、指定された区切り文字を配置します。 区切り文字は 1 つの文字でなければなりません。 特殊文字やスペース (デフォルト値) にすることもできます。
DUPLICATES
BREAK コマンドに関して指定するブレーク列の重複列値の印刷を制御します。
ON
重複列の値の印刷ができます。
OFF
重複列の値の印刷はできません。
ECHO
すべてのコマンドを CLPPlus インターフェースの標準出力に表示するかどうかを制御します。
ON
コマンドの表示を使用可能にします。
OFF
コマンドの表示を使用不可にします。
ENCODING encoding-format
CLPPlus セッションで使用されるエンコード形式を制御します。 ウィンドウ・モードおよび非ウィンドウ・モードの CLPPlus コンソールでのエンコード形式を設定できます。 デフォルト値は UTF-8 です。

非ウィンドウ・モード CLPPlus コンソールでのエンコード形式を設定した場合、指定されたエンコード形式を使用するのは、コンソールに読み込まれるバッチ・ファイルおよびスプール・ファイルに書き込まれる出力だけです。 非ウィンドウ・モード CLPPlus コンソールは、対話式コマンドの入力処理や標準出力への送信を、指定されたエンコード形式で行わない可能性があります。

有効なエンコード形式の値を以下にリストします。
Big5, Big5-HKSCS, CESU-8, EUC-JP, EUC-KR, GB18030,
GB2312, GBK, hp-roman8, IBM-Thai, IBM00858, 
IBM00924, IBM01140, IBM01141, IBM01142, IBM01143,
IBM01144, IBM01145, IBM01146, IBM01147, IBM01148,
IBM01149, IBM037, IBM1026, IBM1047, IBM273, IBM277,
IBM278, IBM280, IBM284, IBM285, IBM290, IBM297,
IBM420, IBM424, IBM437, IBM500, IBM775, IBM850,
IBM852, IBM855, IBM857, IBM860, IBM861, IBM862,
IBM863, IBM864, IBM865, IBM866, IBM868, IBM869,
IBM870, IBM871, IBM918, ISO-2022-CN, ISO-2022-JP,
ISO-2022-JP-2, ISO-2022-KR, ISO-8859-1, ISO-8859-10,
ISO-8859-13, ISO-8859-14, ISO-8859-15, ISO-8859-16,
ISO-8859-2, ISO-8859-3, ISO-8859-4, ISO-8859-5,
ISO-8859-6, ISO-8859-7, ISO-8859-8, ISO-8859-9,
JIS_X0201, JIS_X0212-1990, KOI8-R, KOI8-U, KZ-1048,
PTCP154, Shift_JIS, TIS-620, US-ASCII, UTF-16,
UTF-16BE, UTF-16LE, UTF-32, UTF-32BE, UTF-32LE,
UTF-8, windows-1250, windows-1251, windows-1252,
windows-1253, windows-1254, windows-1255,
windows-1256, windows-1257, windows-1258,
windows-31j, windows-874, x-Big5-HKSCS-2001,
x-Big5-Solaris, x-compound-text, x-EUC-TW,
x-EUC_CN, x-EUC_JP_LINUX, x-eucJP-Open, x-IBM-udcJP,
x-IBM1006, x-IBM1025, x-IBM1027, x-IBM1041, 
x-IBM1043, x-IBM1046, x-IBM1046S, x-IBM1047_LF,
x-IBM1088, x-IBM1097, x-IBM1098, x-IBM1112, 
x-IBM1114, x-IBM1115, x-IBM1122, x-IBM1123, 
x-IBM1124, x-IBM1141_LF, x-IBM1153, x-IBM1166, 
x-IBM1351, x-IBM1362, x-IBM1363, x-IBM1363C, 
x-IBM1364, x-IBM1370, x-IBM1371, x-IBM1380, 
x-IBM1381, x-IBM1382, x-IBM1383, x-IBM1385, 
x-IBM1386, x-IBM1388, x-IBM1390, x-IBM1390A, 
x-IBM1399, x-IBM1399A, x-IBM16684, x-IBM16684A, 
x-IBM29626, x-IBM29626C, x-IBM300, x-IBM300A, 
x-IBM301, x-IBM33722, x-IBM33722A, x-IBM33722C, 
x-IBM420S, x-IBM4933, x-IBM720, x-IBM737, 
x-IBM808, x-IBM833, x-IBM834, x-IBM835, x-IBM836,
x-IBM837, x-IBM856, x-IBM859, x-IBM864S, x-IBM867,
x-IBM874, x-IBM875, x-IBM897, x-IBM921, x-IBM922,
x-IBM924_LF, x-IBM927, x-IBM930, x-IBM930A, x-IBM933,
x-IBM935, x-IBM937, x-IBM939, x-IBM939A, x-IBM942, 
x-IBM942C, x-IBM943, x-IBM943C, x-IBM947, x-IBM948,
x-IBM949, x-IBM949C, x-IBM950, x-IBM951, x-IBM954,
x-IBM954C, x-IBM964, x-IBM970, x-IBM971, x-ISCII91,
x-ISO-2022-CN-CNS, x-ISO-2022-CN-GB, x-iso-8859-11,
x-ISO-8859-6S, x-JIS0208, x-JISAutoDetect, x-Johab,
x-KOI8_RU, x-KSC5601, x-MacArabic, 
x-MacCentralEurope, x-MacCroatian, x-MacCyrillic, 
x-MacDingbat, x-MacGreek, x-MacHebrew, x-MacIceland,
x-MacRoman, x-MacRomania, x-MacSymbol, x-MacThai,
x-MacTurkish, x-MacUkraine, x-MS932_0213, 
x-MS950-HKSCS, x-MS950-HKSCS-XP, x-mswin-936,
x-mswin-936A, x-PCK, x-SJIS_0213, x-UTF-16LE-BOM,
X-UTF-32BE-BOM, X-UTF-32LE-BOM, x-UTF_8J,
x-windows-1256S, x-windows-50220, x-windows-50221,
x-windows-949, x-windows-950, x-windows-iso2022jp 
ENVVARSUBSTITUTION | ENVVARSUBST
CLPPlus インターフェースが環境変数置換をサポートするかどうかを制御します。
ON
環境変数置換を使用可能にします。 これはデフォルト値です。 CLPPlus は、接頭部としてドル記号 ($) 文字があるテキスト、およびパーセント記号 (%) 文字で囲まれたテキストをすべて環境変数として扱い、それらを関連する値に置換します。
OFF
環境変数置換を使用不可にします。
ESCAPE
CLPPlus インターフェースでエスケープ文字を使用するよう設定するかどうかを制御します。
ON
デフォルトのエスケープ文字「¥」を使用可能にします。
OFF
現在定義されているエスケープ文字を使用不可にします。
character
character に指定された値でエスケープ文字を使用可能にします。
FEEDBACK | FEED
SQL ステートメントを発行した後で、対話式情報の表示を制御します。
ON
対話式情報の表示を使用可能にします。 これはデフォルトのアクションです。
OFF
対話式情報の表示を使用不可にします。
row-threshold
フィードバックを使用可能にするために必要な最小行数を指定します。
FLUSH| FLU
出力バッファーが外部プログラムにアクセス可能であるかどうかを制御します。 出力バッファーが付加されている間、FLUSH パラメーターはアクティブな状態のままです。 ただし、ステートメントを呼び出したり、あるいはコマンドを実行したりする際、このプロセスによってより大きな処理能力が要求されます。
ON
バッファーが外部プログラムにアクセスできるようにします。
OFF
バッファーが外部プログラムにアクセスできないようにします。
FONT
ウィンドウ・モードのフォントの名前、スタイル、およびサイズを設定します。
name
設定するフォントの名前を指定します。 可能な値は、以下のとおりです。
  • monospaced
  • sansserif
  • serif
  • 有効なシステム・フォント名
style
フォント・スタイルを指定します。 可能な値は、以下のとおりです。
0
プレーン・テキスト。
1
太字テキスト。
2
イタリック・テキスト。
3
太字のイタリック・テキスト。
size
フォント・サイズを指定します。受け入れられる値は整数です。
HEADING | HEA
SELECT ステートメントの列見出しを表示するかどうかを決定します。
ON
列見出しの表示を使用可能にします。
OFF
列見出しの表示を使用不可にします。
HEADSEP | HEADS
COLUMN HEADING コマンドで使用される見出し区切り文字を設定します。 デフォルト文字は垂直バー (|) です。
LOGMODE logmode-value
CLPPlus クライアント・レイヤーおよび JDBC ドライバー・レイヤー (JCC) のトレースおよびロギングを制御します。 logmode-value 変数には、以下のいずれかの値を指定できます。
CLPPLUS
CLPPlus クライアント・レイヤーのみのトレースおよびロギングを実行します。
JCC
JDBC クライアント・レイヤーのみのトレースおよびロギングを実行します。
BOTH
CLPPlus クライアント・レイヤーおよび JDBC クライアント・レイヤーのトレースおよびロギングを実行します。
NONE
すべてのトレースおよびロギングを使用不可にします。
JCCLOGMODE jcclogmode-value
トレースとロギングのいずれかまたは両方の対象となる JCC クライアント・レイヤー・フィーチャーを指定します。 jcclogmode-value 変数には、以下のいずれかの値を指定できます。 jcclogmode-value 変数の値を指定するには、LOGMODE パラメーターを 1 または 2 に設定する必要があります。
0
(TRACE_NONE)
1
(TRACE_CONNECTION_CALLS)
2
(TRACE_STATEMENT_CALLS)
4
(TRACE_RESULT_SET_CALLS)
16
(TRACE_DRIVER_CONFIGURATION)
32
(TRACE_CONNECTS)
64
(TRACE_DRDA_FLOWS)
128
(TRACE_RESULT_SET_META_DATA)
256
(TRACE_PARAMETER_META_DATA)
512
(TRACE_DIAGNOSTICS)
1024
(TRACE_SQLJ)
2048
(TRACE_XA_CALLS)
-1
(TRACE_ALL)。 デフォルトで、-1 の設定が使用され、すべてのレイヤーがトレース対象であることを意味します。
LINESIZE | LIN width-of-line
行の幅を文字数で指定します。 有効な範囲は 1 から 32767 までです。 デフォルト値は 80 です。
LOCALElocale_name
CLPPlus 環境で使用するメッセージのロケールの名前を設定します。
LOGPATHlog-path
LOGMODE および JCCLOGMODE パラメーターの設定を使用するトレースのログ・レコードを保持するために使われるファイルのパスを設定します。
LONG integer-value
CLOB や XML などのラージ・テキスト・オブジェクト用に表示する文字数を定義します。 デフォルト値は 50 です。 有効な範囲は 1 から 2147483647 までです。
NEWPAGE | NEWP lines-per-page
改ページの後に印刷されるブランク行の数を制御します。 値は 0 から 100 までの整数です。 デフォルト値は 1 です。これは、改ページの後にブランク行が 1 行印刷されることを示します。 値 0 を指定すると、それぞれの新規ページの先頭に用紙送りが印刷されます。
NULL null-string
出力バッファー内の列で NULL 値用に表示される文字ストリングを設定します。 このストリングにはスペースおよび特殊文字を含めることができます。 デフォルトでは、このストリングとしてスペースが設定されています。 ストリングを引用符で囲んでも、その値に影響はありません。 文字の大/小文字は保持されます。
NUMFORMAT format-string
数字を表示するために使われるデフォルトの書式制御ストリングを設定します。 サポートされる書式は、COLUMN FORMAT format-string の場合と同じです。
NUMWIDTH
数字の表示に使用するデフォルト幅を設定します。 デフォルト値は OFF です。
PAGESIZE | PAGES lines_per_page
1 ページに収まる表示行の数を設定します。 デフォルト値は 25 です。 有効な値は 0 および 2 から 50000 の値です。
PRESERVEWHITESPACE
TRUE
SQL および PL/SQL のすべての構文とブロックのインデントを保持します。 空白文字はウィンドウ・モードと非ウィンドウ・モードの両方で保持されます。 入力がファイルから読み取られる場合も、CLPPlus で対話式に読み取られる場合も、この動作が当てはまります。 デフォルト設定は TRUE です。
FALSE
SQL および PL/SQL のすべての構文とブロックでスペースを切り取ります。
SQLCASE | SQLC
サーバーに伝送される SQL ステートメントの文字を大文字に変換するか、小文字に変換するかを制御します。
MIXED | MIX
文字ストリングに大文字および小文字を含めることができることを指定します。
UPPER | UP
文字ストリングをすべて大文字に変換します。
LOWER | LO
文字ストリングに小文字のみを含めることができることを指定します。
PAUSE | PAU
それぞれの改ページの前に処理を停止するかどうかを決定します。 出力を 1 つのページに表示できない場合、それぞれの改ページの前にメッセージ Hit ENTER to continue とともにプロンプトが出されます。
ON
出力の表示を一時停止します。
OFF
一時停止せずに出力を表示します。
RECSEP
RECSEPCHAR パラメーターを使って設定したレコード区切り文字を、結果セットの各レコードの印刷後に表示するかどうかを指定します。
ON
結果セット内の各レコードの後に、レコード分離文字を印刷します。
OFF
レコード分離文字を印刷しません。
RECSEPCHAR character
RECSEP パラメーターで使用される単一のレコード区切り文字を指定します。
SERVEROUTPUT
サーバー・サイドのプロシージャーからの出力メッセージが取り出されて、クライアント・コンソールに表示されるかどうかを指定します。
ON
サーバー・サイド・プロシージャーの出力メッセージが取り出されて表示されることを指定します。
OFF
サーバー・サイド・プロシージャーの出力メッセージの取り出しと表示が行われないことを指定します。
SIZE
画面に表示する文字数を指定します。 可能な値は、以下のとおりです。
UNLIMITED
デフォルト値。
n
特定の文字数を指定します (n は正整数でなければなりません)。
FORMAT
コンソールにサーバー出力を表示する際に使用する書式スタイルを指定します。
TRUNCATED
行サイズを超えるテキストを切り捨てます。
WORD_WRAPPED
テキストを次の行にオーバーフローさせることを可能にしますが、その際、単語が 2 行にまたがって分割されないようにします。
WRAPPED
必要な場合に、テキストを次の行にオーバーフローさせることを可能にします。
SQLPROMPT | SQLP prompt
CLPPlus インターフェースのプロンプトを指定します。 デフォルトでは、プロンプトは SQL> です。このプロンプトはストリングでなければならず、特殊文字およびスペースを含めることができます。 ストリングを引用符で囲んでも、引用符は表示されません。また、文字の大/小文字は保持されます。
TERMOUT | TERM
出力を CLPPlus インターフェースの標準出力に表示するかどうかを決定します。
ON
画面に出力を表示します。
OFF
出力を表示しません。
TIMING | TIMI
SQL ステートメントが発行された後に、SQL ステートメントごとに経過時間を表示するかどうかを制御します。
ON
経過時間を表示することを指定します。
OFF
経過時間を表示しないことを指定します。
TRIMOUT | TRIMO
出力がコンソールに書き込まれる前に、出力から末尾ブランク・スペースを削除するかどうかを制御します。
ON
末尾ブランク・スペースが削除されることを指定します。
OFF
末尾ブランク・スペースが削除されないことを指定します。これはデフォルトです。
TRIMSPOOL | TRIMS
スプール出力がスプール・ファイルに書き込まれる前に、スプール出力から末尾ブランク・スペースを削除するかどうかを制御します。
ON
末尾ブランク・スペースが削除されることを指定します。
OFF
末尾ブランク・スペースが削除されないことを指定します。これはデフォルトです。
UNDERLINE
列見出しに下線を付けるかどうかを指定します。
ON
列見出しに下線を付けることを指定します。
OFF
列見出しに下線を付けないことを指定します。
USECURRENTDIRLOGPATH
LOGPATH の値を制御します。
ON
ユーザーが明示的に LOGPATH の値を設定した場合を除き、LOGPATH は <CurrentDirectory>/clpplus.log に設定されます。
OFF
LOGPATH に影響を及ぼしません。
VERBOSE
CLPPlus のすべてのメッセージがコンソールに出力されるかどうかを決定します。
ON
CLPPlus のすべてのメッセージをコンソールに出力することを指定します。
OFF
メッセージのうち特定のサブセットのみコンソールに出力することを指定します。 これはデフォルト値です。
VERIFY | VER
置換変数を使用したときに SQL ステートメントの元の値と新しい値を表示するかどうかを決定します。
ON
古い値と新しい値を表示することを指定します。
OFF
古い値と新しい値を表示しないことを指定します。
WRAP
列値を表示するときに使用するデフォルトの位置合わせを設定します。
ON
列幅を超える列値を折り返すことを指定します。
OFF
列幅を超える列値を切り捨てることを指定します。