vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/tool/dws_gsql_006.html
Lu, Huayi 346ac31da9 DWS TG 8.1.3.200 VERSION 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2023-08-28 09:20:17 +00:00

359 lines
53 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001233922173"></a><a name="EN-US_TOPIC_0000001233922173"></a>
<h1 class="topictitle1">Command Reference</h1>
<div id="body0000001106890936"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2fa45cf79e20402391243263b228dd00">For details about gsql parameters, see <a href="#EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_td295af60028d45cc9362b2f0f81eba40">Table 1</a>, <a href="#EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t38966fee2fc446a29beba6e56096c827">Table 2</a>, <a href="#EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t1d787f9ef30b445297beffcd91b50860">Table 3</a>, and <a href="#EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t3d331a5b00504ac19e34e1da02d04d22">Table 4</a>.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_td295af60028d45cc9362b2f0f81eba40"></a><a name="en-us_topic_0000001233922179_en-us_topic_0000001145410531_td295af60028d45cc9362b2f0f81eba40"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_td295af60028d45cc9362b2f0f81eba40" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r4b34b1237925471196a7ca28b77b49ce"><th align="left" class="cellrowborder" valign="top" width="22.34%" id="mcps1.3.2.2.4.1.1"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a09209e618ecf4b548bea4ac886a9f07b">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.6%" id="mcps1.3.2.2.4.1.2"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ac49cae8b27e143568f4c57a468e18c5f">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.060000000000002%" id="mcps1.3.2.2.4.1.3"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aaad237a0d930454692a5af6464b8ffa0">Value Range</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r558462e3cde14e04a97e579fb5942d45"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3542a25433104664aae507c7fdc40736">-c, --command=COMMAND</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_afb91efc59f9747f086fd5c5048523a91">Specifies that gsql runs a string command and then exits.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aae9cc3c6b1ee459aabfb89eab5c8dea8">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_row20386168114917"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p1638614824915">-C, --set-file=FILENAME</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p9386148184913">Uses the file as the command source instead of interactive input. After processing the file, gsql does not exit and continues to process other contents.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p1386586493">An absolute path or relative path that meets the OS path naming convention</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rc142d3dc525940a3a7ffca57511186d7"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a987010a1d9fb41c5bb40cf00ebd01e76">-d, --dbname=DBNAME</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a817bbb6e1f274e52b7f74016ef22338c">Specifies the name of the database to be connected.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a96262fbabc6c43dbadda216d340eac33">A character string.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_row4855154412496"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p18855444184917">-D, --dynamic-param</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p9855144124916">Controls the generation of variables and the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b1435112597338">${}</strong> variable referencing method during SQL statement execution. For details, see <a href="dws_gsql_002.html#EN-US_TOPIC_0000001234200693__en-us_topic_0000001233922133_en-us_topic_0000001098650792_lc8477a0a74144ad1822fa622fe2f1136">Variable</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p7855244164910">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r71ce59ca2d0d4681a775c41627b749fc"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a313ffd9b948445a99b68750d74766bb0">-f, --file=FILENAME</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2473e90625c4456cbcae87166508d2ec">Specifies that files are used as the command source instead of interactively-entered commands. After the files are processed, exit from gsql. If <em id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_i842352697115459">FILENAME</em> is - (hyphen), then standard input is read.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a7a8782e4225b48e9ac50bea7f03bd4c3">An absolute path or relative path that meets the OS path naming convention</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_re5ecf541b7b54c669108c10b2430ee45"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_add13ebd5bb214492b7f0b451f3ad6f04">-l, --list</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a4aead0b4e82f4fdb927468034c4419da">Lists all available databases and then exits.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a18ebeb7faefe4dde88b50433fee15cac">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r9bb845a7311d4392bdab3b32688788b0"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ab43c6fa926524d949d76f5a3a56cb0c8">-v, --set, --variable=NAME=VALUE</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a04b0a2a2f69743a78606d80256b46e46">Sets the gsql variable <em id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_en-us_topic_0085032771_i842352697162725">NAME</em> to <em id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_en-us_topic_0085032771_i842352697162741">VALUE</em>.</p>
<p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a4edc6d0519704fd6873723fdf2a00deb">For details about variable examples and descriptions, see <a href="dws_gsql_002.html#EN-US_TOPIC_0000001234200693__en-us_topic_0000001233922133_en-us_topic_0000001098650792_lc8477a0a74144ad1822fa622fe2f1136">Variable</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3a738462eaa64c968f814caa65001247">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r6ef4cbb87b0b48f19d63f710c3b94ea7"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a563a0ed3f05e40a68e0e66911133c18b">-X, --no-gsqlrc</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a65001a24e54a451b93e8673d22adee34">Does not read the startup file (neither the system-wide <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b842352706141315">gsqlrc</strong> file nor the user's <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b842352706141320">~/.gsqlrc</strong> file).</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_n93db8fe252bc4bb2a2b6ed2aee9ba03d"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a61d1382f2248449c97dce359080d32d2">The startup file is <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b842352706141327">~/.gsqlrc</strong> by default or it can be specified by the environment variable <em id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_i84235269716329">PSQLRC</em>.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3f4868530ec04cf7ae51aee1548b325b">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r4b6fbafc735a446a8e1b6e7b1ae6ef44"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a6d96e81984834e86b1dd19cf9790c719">-1 ("one"), --single-transaction</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2e762ccf127043e8888136b41240d8fb">When gsql uses the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b842352706193527">-f</strong> parameter to execute a script, <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b36361027287">START TRANSACTION</strong> and <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b16736133011815">COMMIT</strong> are added to the start and end of the script, respectively, so that the script is executed as one transaction. This ensures that the script is executed successfully. If the script cannot be executed, the script is invalid.</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_nbd5b47e19d7c4632a38c43b110383318"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_af0c1269e73d042209a578e648f3c03cd">If the script has used START TRANSACTION, COMMIT, and ROLLBACK, this parameter is invalid.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a91b0bd7c00b9408e8d8ca457f0637c3e">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r7a8dd28ee9444421884fab01be5643da"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa1439ea130c043629a9e30a580903a41">-?, --help</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a528480f09e7e414f8ceba52302daf7e2">Displays help information about gsql CLI parameters, and exits.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a18d93f3848f44db68815d57a58f9316f">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r44435f6aa9c54ebfbcabae2de0a1762f"><td class="cellrowborder" valign="top" width="22.34%" headers="mcps1.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_af23a8b44ba1c4850a78e2da41167ede9">-V, --version</p>
</td>
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa81b010cee9f4ec3aaebcb7c1fe9aa1d">Prints the gsql version and exits.</p>
</td>
<td class="cellrowborder" valign="top" width="24.060000000000002%" headers="mcps1.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ade968dafda064c039e8a71ad53bfc47f">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t38966fee2fc446a29beba6e56096c827"></a><a name="en-us_topic_0000001233922179_en-us_topic_0000001145410531_t38966fee2fc446a29beba6e56096c827"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t38966fee2fc446a29beba6e56096c827" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Input and output parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r6577ca202dff416da16f77a4ea94468a"><th align="left" class="cellrowborder" valign="top" width="14.610000000000001%" id="mcps1.3.3.2.4.1.1"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2f24a96f97744ca08be861dd221d139b">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.64999999999999%" id="mcps1.3.3.2.4.1.2"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ab5649e0802174c27b06e38ad65492ea5">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.74%" id="mcps1.3.3.2.4.1.3"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae992cba610c24edca71aeb5ab061518e">Value Range</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r94a88e98d64349079c2ad9432e1c89f1"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae0a47f2e8f874275bfc2301c7311d00e">-a, --echo-all</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a1289e1700587440da190f51fb4cf048e">Prints all input lines to standard output as they are read.</p>
<div class="caution" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_n985b87cb3c434710bf5920988cbdd7ca"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae445a16fd71f43e8865e3cf73467ebaa">When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a7b2a3771f9494445bffe06cc8314b1c7">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rcd0730157c144722ac32805ba49fdebd"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a5c2e4dd9bb2a446e8fc7c0690d4076a6">-e, --echo-queries</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ab76e34030872433b877665e6d6ac87e8">Copies all SQL statements sent to the server to standard output as well.</p>
<div class="caution" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_nb9415cfa18cd428baad87457decb06d2"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aab93b2def0fe4bb9b0bb559cd77ef9e4">When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a905c985c4a1e422f827e4feaf4cb5039">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r206525eb75d64b5c9003e9356371b842"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a343afdcdddbd4075b0a58a3557d50f34">-E, --echo-hidden</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae8d11ad55ec74c1d9289f1f4cc65730a">Echoes the actual queries generated by <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b842352706164710">\d</strong> and other backslash commands.</p>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a9ebb9c8e74424c1aa2fb3cf935e7608d">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rc7beb5948b2b4d9782266a5a35fcb9f3"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa3f5b6df39b44074ae0d3bb25a0244da">-k, --with-key=KEY</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a45c5506909c446f69f8c2fa3ed651e25">Uses gsql to decrypt imported encrypted files.</p>
<div class="notice" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_n21d7d173ae434ec3a13a3dd9233917ab"><span class="noticetitle"> NOTICE: </span><div class="noticebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a45ed47d970904872b5ddda963b8622d5">For key characters, such as the single quotation mark (') or double quotation mark (") in shell commands, Linux shell checks whether the input single quotation mark (') or double quotation mark (") matches. If it does not match, Linux shell regards that the user input is unfinished and waits for more input instead of entering the gsql program.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ab4c9ad3ad81941a48dea7a2a22c2014a">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r89fb15a46d794fbdbed7a36fea00229c"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a447491445d1c4dacb6fe5905d27d4355">-L, --log-file=FILENAME</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a36b76342a17c432e9e3b72f0ec49808f">Writes normal output destination and all query output into the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b84235270615368">FILENAME</strong> file.</p>
<div class="caution" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_n819e7fff0eac4f3a8fef4a0c0537ce77"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><ul id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ul1039703419584"><li id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_li5397434185815">When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.</li><li id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_li14460103613588">This parameter retains only the query result in the corresponding file, so that the result can be easily found and parsed by other invokers (for example, automatic O&amp;M scripts). Logs about gsql operation are not retained.</li></ul>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aeb1a3437effb4280a84247463dd5bf2f">An absolute path or relative path that meets the OS path naming convention</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rc77864b46abb4ef8afc9c0274d850eaa"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0cb7609e55b24929ba880ee9d82170e1">-m, --maintenance</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a299b86fe1ced44fb804f0084586e03ef">Allows a cluster to be connected when a two-phase transaction is being restored.</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_nd7346b5f4b2c46db96bbe7ddb0b7188c"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa92d96564af148759d7052aa9873a43c">The parameter is for engineers only. When this parameter is used, gsql can be connected to the standby server to check data consistency between the primary server and standby server.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a6bf55e70d2f541118e91cf450856e4f8">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r0ea33fa4b7cf4cc79254c28eb0e18f63"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_af2e3e5d007b2425981192e1ec23e3269">-n, --no-libedit</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0375d90c2ee24d46ad2369efff52eb2b">Closes the command line editing.</p>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae2245f2f9bda425f9958c021dc24f390">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r8d5d4ab8c26442b99359353c5858a061"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a37e2de9e422e47db88a3deecbb73f969">-o, --output=FILENAME</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae6b72b4d5a37415d946eb7ce4cebd005">Puts all query output into the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b842352706155448">FILENAME</strong> file.</p>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a52e304acd2ed4e7783b231a35ce2d0ee">An absolute path or relative path that meets the OS path naming convention</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r61d8149267fd465a98ba1ac5b9de3e74"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ae6131334b74e46738738009c261f08b9">-q, --quiet</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa62c7620955e4339899725056c1e95e8">Indicates the quiet mode and no additional information will be printed.</p>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3ad189598f5a4c87ae1d439679ef09a4">By default, gsql displays various information.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r43f960d6d72a42049af733167c2d4ecb"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a5491c2abfd064a39a3bbd9514f6add8f">-s, --single-step</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a7d3ee4345ba648e68de5622d2396d7ad">Runs in single-step mode. This indicates that the user is prompted before each command is sent to the server. This parameter can also be used for canceling execution. This parameter can be used to debug scripts.</p>
<div class="caution" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_n93b4b28714e44fb4be58c03debf15b60"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aba8eff51f3fb4cb9b10fad60ce368144">When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a95573334cd0a43cdb0dfa264b8a94dd0">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rc0187285763a4de48f89a8d7d9015539"><td class="cellrowborder" valign="top" width="14.610000000000001%" headers="mcps1.3.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3f0cc0db8d9443ec96153d1275cbe6fa">-S, --single-line</p>
</td>
<td class="cellrowborder" valign="top" width="62.64999999999999%" headers="mcps1.3.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a1119fb0512484f3e9638a72a1fa281d6">Runs in single-row mode where a new line terminates an SQL statement in the same manner as a semicolon does.</p>
</td>
<td class="cellrowborder" valign="top" width="22.74%" headers="mcps1.3.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_affd0603fc5c24bde9ef6d2ab4bde5e75">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t1d787f9ef30b445297beffcd91b50860"></a><a name="en-us_topic_0000001233922179_en-us_topic_0000001145410531_t1d787f9ef30b445297beffcd91b50860"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t1d787f9ef30b445297beffcd91b50860" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters specifying output formats</caption><thead align="left"><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r7a9aafa7b8a44673bc4f3440dc356c1b"><th align="left" class="cellrowborder" valign="top" width="17.52%" id="mcps1.3.4.2.4.1.1"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a9dc98039f34940498970a286de9bc957">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64.25%" id="mcps1.3.4.2.4.1.2"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a12ce50b47b0a407db052557dadfeb293">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.4.2.4.1.3"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a81473a9d83d14d50880c7cb502ec0639">Value Range</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rb02a433c25b8425dbac39ad6efa9b509"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3064aef07a48449e8abdb8a22f1d5af8">-A, --no-align</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_acca287630dd64a15a7ccda5797238290">Switches to unaligned output mode.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0df7de6ed2b74c77917b3fe0b062d84d">The default output mode is aligned.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r84c10ebf4672475cbbf877c4d53682a5"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a29151aff45c4457da434df65e9b70f82">-F, --field-separator=STRING</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0a35bc47b7e840f4ba20effc731d6835">Specifies the field separator. The default is the vertical bar (|).</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2e51898952f7440bb92ecfb965f849fc">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r4ddedd3b0b234a57a140e6b44ded7d68"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ad45cb94acf624ce99ed5b3807eaac57d">-H, --html</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aca26b906cec3442fb6c21a474947a804">Turns on the HTML tabular output.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aafc950c633d24d92b23ac1358f4a80ed">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r9b908dcd2ec84fc490c197ec40576733"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ad07e2aa2d6cf4c7abbcf360fe7f7bb02">-P, --pset=VAR[=ARG]</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a156964e5f7cd4de8b99b7ed387f1545b">Specifies the print option in the \pset format in the command line.</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_nba235eaceab6415392ae2cbd81fa7096"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a1c6730bc8b40437fb4d0f58189385293">The equal sign (=), instead of the space, is used here to separate the name and value. For example, enter <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b84235270684332">-P format=latex</strong> to set the output format to <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b84235270684340">LaTeX</strong>.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a7846fdf14d8f4ca48661dca99190b8a4">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r3370f512ff9f4ca6923884d45cbc8f7d"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0525adc3a02f4431b6370a303193e96c">-R, --record-separator=STRING</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aca08a2c9f6bf44a2afdde2a68152d20b">Specifies the record separators.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2d23fd18d5de46bbbd174c2a73a30ade">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r1697be2bd0614104b7da88526f1b4d9b"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a478f424b532c472e9781987c00c43831">-r</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_adaf7cb2f67434dfc9a8c33159d9b6a47">Enables the function of recording historical operations on the client.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa22c81a3cf024a73be68868f645b40f8">This function is disabled by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r97fe58371d284176b31870b47afb2beb"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_adca09c8526ed4d0bb900f1218c9e9d19">-t, --tuples-only</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a9463d4a1124e4c2ab4cf9f8d9b3c8f87">Prints only tuples.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a63d880c3bb2e4c6fbb567bbfc40f7b6b">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r91f94a34e6174f0cab1b6ff8749ac5bd"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0c196b36eeb446758f1b8bb65071de75">-T, --table-attr=TEXT</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a1b448aa098f349f396c9d864ddd8c810">Specifies options to be placed within the HTML table tag.</p>
<p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_af71221adc6b4463fafca9f547181177c">Use this parameter with the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b8423527068569">-H,--html</strong> parameter to specify the output to the HTML format.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a090b28a82603424391dc83b95c283d54">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rc09ec41d401e41b99a1ad2a7ba0c64aa"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3771110163304eed9e0fe8b02727cafd">-x, --expanded</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3e4db0c73a69443caa5ef56feccd4ac4">Turns on the expanded table formatting mode.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a460f36d0a4c845979b1c6489ebdd7a41">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_rff1e8f93dff345f9afc4184e0ac449e4"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a89259b27ef994269a7429b42ffcd6c19">-z, --field-separator-zero</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2909f9cba55c444da23913ccaf61d9ed">Sets the field separator in the unaligned output mode to be blank.</p>
<p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aeaf8de5f7d174f6d8647c94715ef399a">Use this parameter with the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b8423527069413">-A, --no-align</strong> parameter to switch to unaligned output mode.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a1ab26d2fc6124ba987fb2c95c79f3227">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r85fbd72e16924fd18e5b8f0363ebf736"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ad47570f0b2b84d55ba0b3d4d843666d0">-0, --record-separator-zero</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a8991cca025ed410b8b85054c830e81e6">Sets the record separator in the unaligned output mode to be blank.</p>
<p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a0fb358e760324e3e9beda2b5211ca757">Use this parameter with the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_b1001353439">-A, --no-align</strong> parameter to switch to unaligned output mode.</p>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a30097a5ea204485eb1c92557d2fab184">-</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r601d76f5729a4428a258f8612fcc30c1"><td class="cellrowborder" valign="top" width="17.52%" headers="mcps1.3.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a3f1ab4ca413e4b199b0c884dc1efbfc1">-g</p>
</td>
<td class="cellrowborder" valign="top" width="64.25%" headers="mcps1.3.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2fddc44a4ba84883a955ba42d126b6c7">Displays separators for all SQL statements and specified files.</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ne2e6a2a785d4420482b19714c07717f4"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa90ce7328b1c453980ab7db653c95478">The <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b8423527069845">-g</strong> parameter must be configured with the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b8423527069930">-f</strong> parameter.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a70c17faef61e48c79c753b6caecf3cca">-</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t3d331a5b00504ac19e34e1da02d04d22"></a><a name="en-us_topic_0000001233922179_en-us_topic_0000001145410531_t3d331a5b00504ac19e34e1da02d04d22"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_t3d331a5b00504ac19e34e1da02d04d22" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Connection parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r9c13f44c0e184ccda425105473be7c5d"><th align="left" class="cellrowborder" valign="top" width="22.720000000000002%" id="mcps1.3.5.2.4.1.1"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a2c532337ad6449b6bf6ed81ebd8c43fe">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.28%" id="mcps1.3.5.2.4.1.2"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a83a417f1a24943bab999fff6d92929b4">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.2.4.1.3"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a515c5bceb40c4da1ac90aaeea0cac4b1">Value Range</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r8387353a52b14c3688459a10c09d2157"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a1f15c8853dd34839afe14166f15fa4c1">-h, --host=HOSTNAME</p>
</td>
<td class="cellrowborder" valign="top" width="52.28%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a9bfa566073ae4021991a1342559542e9">Specifies the host name of the machine on which the server is running or the directory for the Unix-domain socket.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aaddf7329c83846b683078e340e95f641">If the host name is omitted, gsql connects to the server of the local host over the Unix domain socket or over TCP/IP to connect to local host without the Unix domain socket.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ree1c012012b645ef94a616653a2a671d"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_adb4e8fa9a915452b8bc0c053c54cd728">-p, --port=PORT</p>
</td>
<td class="cellrowborder" valign="top" width="52.28%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a5b2cbaa5e05c48878e48d3b5442b9dae">Specifies the port number of the database server.</p>
<p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a5b78567984644bac95ab043801b465c0">You can modify the default port number using the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_en-us_topic_0085032771_b8423527069149">-p, --port=PORT</strong> parameter.</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_aa8eb76dc41ec4858b712c6fc6794814c">The default value is <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b1288271601014"><span id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_text6984183216347">8000</span></strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r5f5f16b219df4fbf8d804eee9db73200"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a4ea1d189c15c4bcd90aa152c4ce84dc8">-U, --username=USERNAME</p>
</td>
<td class="cellrowborder" valign="top" width="52.28%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a81d92cd03f1d49709e4dca31e51432f7">Specifies the user that accesses a database.</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_n93db845d17e6454ead018147ffe392de"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ul103034015494"><li id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_li173029024910">If a user is specified to access a database using this parameter, a user password must be provided together for identity verification. You can enter the password interactively or use the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b144607457308">-W</strong> parameter to specify a password.</li><li id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_li2095882174913">To connect to a database, add an escape character before any dollar sign ($) in the user name.</li></ul>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_acedff20c141b40f0bd3dfb400664ddeb">A string. The default user is the current user that operates the system.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_r480e06d3ed3f4f07bf91ac47ede1c8d2"><td class="cellrowborder" valign="top" width="22.720000000000002%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ad8923a20fb8e4ee3adf276bb91edb794">-W, --password=PASSWORD</p>
</td>
<td class="cellrowborder" valign="top" width="52.28%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_ad20fa2db33414e5e9cf5c09866358a5e">Specifies a password when the <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_b8423527069353">-U</strong> parameter is used to connect to a remote database.</p>
<div class="note" id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_nd7f21f4483e94b129a9faf5caeef2ef7"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p785243765613">To connect to a database, add an escape character before any backslash (\) or back quote (`) in the password.</p>
<p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_p71218323118">If this parameter is not specified but database connection requires your password, you will be prompted to enter your password in interactive mode. The maximum length of the password is 999 bytes, which is restricted by the maximum value of the GUC parameter <strong id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_b499883661416">password max length</strong>.</p>
</div></div>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001233922173__en-us_topic_0000001233922179_en-us_topic_0000001145410531_a8fe68126327747a9a45b50a3f773878c">This parameter must meet the password complexity requirement.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_gsql_index.html">gsql</a></div>
</div>
</div>
View Git Blame Copy Permalink