vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/tool/dws_gsql_005.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

122 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001234200681"></a><a name="EN-US_TOPIC_0000001234200681"></a>
<h1 class="topictitle1">Online Help</h1>
<div id="body0000001153490499"><div class="section" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_s2df17c2b02ae4afba26c5b17f30332fc"><h4 class="sectiontitle">Procedure</h4><ul id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_uadc06018a19a46069e1c76b8a297aba2"><li id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_l3b3d287dcf71454bb689dd8175444f20">When a database is being connected, run the following commands to obtain the help information:<pre class="screen" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_s0cd65e38147e4077949d320489e2c5c2"><strong id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_aa6774351f8cb460bacdaa5d7d099379a">gsql --help</strong></pre>
<p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a3fc809ac90424790879f913f8ccd9a0c">The following information is displayed:</p>
<pre class="screen" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_s53646cbfde614bc59392015986af93d6">......
Usage:
gsql [OPTION]... [DBNAME [USERNAME]]
General options:
-c, --command=COMMAND run only single command (SQL or internal) and exit
-d, --dbname=DBNAME database name to connect to (default: "postgres")
-f, --file=FILENAME execute commands from file, then exit
......</pre>
</li><li id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_lca1895ec26b74db8b3f443907fb28f68">After the database is connected, run the following commands to obtain the help information:<pre class="screen" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_s0cc8e3c0a90946ea9564abd2ce4af1fe"><strong id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_ab5d9296309cf4d669e3011faa2ec2d02">help</strong></pre>
<p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a374422391ffd42bb90013c8cb8d97f62">The following information is displayed:</p>
<pre class="screen" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_se89d93634c4d4023a61c81beb4d34f82">You are using gsql, the command-line interface to gaussdb.
Type: \copyright for distribution terms
\h for help with SQL commands
\? for help with gsql commands
\g or terminate with semicolon to execute query
\q to quit</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_sec43a15d95bb4ceb8b6c8235a07add67"><h4 class="sectiontitle">Task Example</h4><ol id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_of1e840dbdd464de0bf670e5e12cf85ed"><li id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_l86953a090aa44aceb1e018fde114a2c8"><span>View the <strong id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_b84235270682656">gsql</strong> help information. For details about the commands, see <a href="#EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_te978a326b9df437dbb26940e8354859b">Table 1</a>.</span><p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_te978a326b9df437dbb26940e8354859b"></a><a name="en-us_topic_0000001233922251_en-us_topic_0000001145490533_te978a326b9df437dbb26940e8354859b"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_te978a326b9df437dbb26940e8354859b" frame="border" border="1" rules="all"><caption><b>Table 1 </b>gsql online help</caption><thead align="left"><tr id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_rd1ee2de7690c407faa03a5fb7ecd61c9"><th align="left" class="cellrowborder" valign="top" width="30.86%" id="mcps1.3.2.2.1.2.1.2.3.1.1"><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a6994321189c64ccf95543439be566cf5">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="69.14%" id="mcps1.3.2.2.1.2.1.2.3.1.2"><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a8485890a5cf14e1dbeaa3816943af716">Example</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_rf682451e545044198fea639d4b720661"><td class="cellrowborder" valign="top" width="30.86%" headers="mcps1.3.2.2.1.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a2c5eddaa7e0e4d55a0b3f4914081887a">View copyright information.</p>
</td>
<td class="cellrowborder" valign="top" width="69.14%" headers="mcps1.3.2.2.1.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a23271419e81f42a7bf346688b54c8147">\copyright</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_r70d19c87bbba48e38cfac6bb155a9370"><td class="cellrowborder" valign="top" width="30.86%" headers="mcps1.3.2.2.1.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_aa16a1478b02a49a6bf89d9d54d5f9ab3">View the help information about SQL statements supported by <span id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_text159981051568">GaussDB(DWS)</span>.</p>
</td>
<td class="cellrowborder" valign="top" width="69.14%" headers="mcps1.3.2.2.1.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a1831ff550a0b4554884e13e474d5ff9c">View the help information about SQL statements supported by <span id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_text1713034315611">GaussDB(DWS)</span>.</p>
<p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a9c283661a6eb4dc8a8ad95c9426a45b2">For example, view all SQL statements supported by <span id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_text1124274755617">GaussDB(DWS)</span>.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_s897e36b3505945f498cf83a56424ac6d"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">\</span><span class="n">h</span>
<span class="n">Available</span><span class="w"> </span><span class="n">help</span><span class="p">:</span>
<span class="w"> </span><span class="k">ABORT</span><span class="w"> </span>
<span class="w"> </span><span class="k">ALTER</span><span class="w"> </span><span class="n">DATABAE</span>
<span class="w"> </span><span class="k">ALTER</span><span class="w"> </span><span class="k">DATA</span><span class="w"> </span><span class="k">SOURCE</span><span class="w"> </span>
<span class="p">...</span><span class="w"> </span><span class="p">...</span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a698cff98a5dd4d87a48131b52b3218c9">For example, view parameters of the <strong id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_b13566509181">CREATE DATABASE</strong> command:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_sca480ac728a84953914940289e5d631c"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">\</span><span class="n">help</span><span class="w"> </span><span class="k">CREATE</span><span class="w"> </span><span class="k">DATABASE</span>
<span class="n">Command</span><span class="p">:</span><span class="w"> </span><span class="k">CREATE</span><span class="w"> </span><span class="k">DATABASE</span>
<span class="n">Description</span><span class="p">:</span><span class="w"> </span><span class="k">create</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="k">database</span>
<span class="n">Syntax</span><span class="p">:</span>
<span class="k">CREATE</span><span class="w"> </span><span class="k">DATABASE</span><span class="w"> </span><span class="n">database_name</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">WITH</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="err">{</span><span class="p">[</span><span class="w"> </span><span class="k">OWNER</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="n">user_name</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">TEMPLATE</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="k">template</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">ENCODING</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="k">encoding</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="n">LC_COLLATE</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="n">lc_collate</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="n">LC_CTYPE</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="n">lc_ctype</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="n">DBCOMPATIBILITY</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="n">compatibility_type</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="n">TABLESPACE</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="n">tablespace_name</span><span class="w"> </span><span class="p">]</span><span class="o">|</span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">CONNECTION</span><span class="w"> </span><span class="k">LIMIT</span><span class="w"> </span><span class="p">[</span><span class="o">=</span><span class="p">]</span><span class="w"> </span><span class="n">connlimit</span><span class="w"> </span><span class="p">]</span><span class="err">}</span><span class="p">[...]</span><span class="w"> </span><span class="p">];</span>
</pre></div></td></tr></table></div>
</div>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_r9f603defdbd443c79268264fc7c042a3"><td class="cellrowborder" valign="top" width="30.86%" headers="mcps1.3.2.2.1.2.1.2.3.1.1 "><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_a0ac2b3f4a59f4708a58bee06bd295387">View help information about gsql commands.</p>
</td>
<td class="cellrowborder" valign="top" width="69.14%" headers="mcps1.3.2.2.1.2.1.2.3.1.2 "><p id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_afcfd10b07c664d0aa91fab03bc5203a9">For example, view commands supported by <strong id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_b842352706161543">gsql</strong>.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001234200681__en-us_topic_0000001233922251_en-us_topic_0000001145490533_s2a32ae914bb94bc0a754d1674da69675"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><span class="err">\</span><span class="o">?</span>
<span class="k">General</span>
<span class="w"> </span><span class="err">\</span><span class="n">copyright</span><span class="w"> </span><span class="k">show</span><span class="w"> </span><span class="n">PostgreSQL</span><span class="w"> </span><span class="k">usage</span><span class="w"> </span><span class="k">and</span><span class="w"> </span><span class="n">distribution</span><span class="w"> </span><span class="n">terms</span>
<span class="w"> </span><span class="err">\</span><span class="k">g</span><span class="w"> </span><span class="p">[</span><span class="n">FILE</span><span class="p">]</span><span class="w"> </span><span class="k">or</span><span class="w"> </span><span class="p">;</span><span class="w"> </span><span class="k">execute</span><span class="w"> </span><span class="n">query</span><span class="w"> </span><span class="p">(</span><span class="k">and</span><span class="w"> </span><span class="n">send</span><span class="w"> </span><span class="n">results</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">file</span><span class="w"> </span><span class="k">or</span><span class="w"> </span><span class="o">|</span><span class="n">pipe</span><span class="p">)</span>
<span class="w"> </span><span class="err">\</span><span class="n">h</span><span class="p">(</span><span class="err">\</span><span class="n">help</span><span class="p">)</span><span class="w"> </span><span class="p">[</span><span class="n">NAME</span><span class="p">]</span><span class="w"> </span><span class="n">help</span><span class="w"> </span><span class="k">on</span><span class="w"> </span><span class="n">syntax</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="k">SQL</span><span class="w"> </span><span class="n">commands</span><span class="p">,</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="k">all</span><span class="w"> </span><span class="n">commands</span>
<span class="w"> </span><span class="err">\</span><span class="n">q</span><span class="w"> </span><span class="n">quit</span><span class="w"> </span><span class="n">gsql</span>
<span class="p">...</span><span class="w"> </span><span class="p">...</span>
</pre></div></td></tr></table></div>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</p></li></ol>
</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