vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/dev/dws_06_0128.html
Lu, Huayi a24ca60074 DWS DEVELOPER 811 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2023-01-19 13:37:49 +00:00

103 lines
18 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001099150942"></a><a name="EN-US_TOPIC_0000001099150942"></a>
<h1 class="topictitle1">ALTER INDEX</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001099150942__s10299e85cbe847c39d0fde3a18effac6"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001099150942__p154343512513"><strong id="EN-US_TOPIC_0000001099150942__b842352706121050">ALTER INDEX</strong> modifies the definition of an existing index.</p>
<p id="EN-US_TOPIC_0000001099150942__p36629087161054">There are several sub-forms:</p>
<ul id="EN-US_TOPIC_0000001099150942__u48fe6dac5c1841e99276feefb60cef1e"><li id="EN-US_TOPIC_0000001099150942__li64843850155140">IF EXISTS<p id="EN-US_TOPIC_0000001099150942__p49912669155149"><a name="EN-US_TOPIC_0000001099150942__li64843850155140"></a><a name="li64843850155140"></a>If the specified index does not exist, a notice instead of an error is sent.</p>
</li><li id="EN-US_TOPIC_0000001099150942__li30912795155157">RENAME TO<p id="EN-US_TOPIC_0000001099150942__p5490394915520"><a name="EN-US_TOPIC_0000001099150942__li30912795155157"></a><a name="li30912795155157"></a>Changes only the name of the index. There is no effect on the stored data. </p>
</li><li id="EN-US_TOPIC_0000001099150942__li2149457155226">SET ( { STORAGE_PARAMETER = value } [, ...] )<p id="EN-US_TOPIC_0000001099150942__p3923349155229"><a name="EN-US_TOPIC_0000001099150942__li2149457155226"></a><a name="li2149457155226"></a>Change one or more index-method-specific storage parameters. Note that the index contents will not be modified immediately by this command. You might need to rebuild the index with <strong id="EN-US_TOPIC_0000001099150942__b84235270693543">REINDEX</strong> to get the desired effects depending on parameters.</p>
</li><li id="EN-US_TOPIC_0000001099150942__li62260850155236">RESET ( { storage_parameter } [, ...] )<p id="EN-US_TOPIC_0000001099150942__p36571309155238"><a name="EN-US_TOPIC_0000001099150942__li62260850155236"></a><a name="li62260850155236"></a>Reset one or more index-method-specific storage parameters to the default value. Similar to the <strong id="EN-US_TOPIC_0000001099150942__en-us_topic_0058966167_b842352706214040">SET</strong> statement, <strong id="EN-US_TOPIC_0000001099150942__en-us_topic_0058966167_b842352706214053">REINDEX</strong> may be used to completely update the index.</p>
</li><li id="EN-US_TOPIC_0000001099150942__li27113821155243">[ MODIFY PARTITION index_partition_name ] UNUSABLE<p id="EN-US_TOPIC_0000001099150942__p8825393155245"><a name="EN-US_TOPIC_0000001099150942__li27113821155243"></a><a name="li27113821155243"></a>Sets the index on a table or index partition to be unavailable.</p>
</li><li id="EN-US_TOPIC_0000001099150942__li43629588155249">REBUILD [ PARTITION index_partition_name ]<p id="EN-US_TOPIC_0000001099150942__p31802353155252"><a name="EN-US_TOPIC_0000001099150942__li43629588155249"></a><a name="li43629588155249"></a>Recreates the index on a table or index partition.</p>
</li><li id="EN-US_TOPIC_0000001099150942__li44487309155255">RENAME PARTITION<p id="EN-US_TOPIC_0000001099150942__p33702077155257"><a name="EN-US_TOPIC_0000001099150942__li44487309155255"></a><a name="li44487309155255"></a>Renames an index partition.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001099150942__s2a0d5557b2db4c8fbcaf8b6c7abdd41b"><h4 class="sectiontitle">Precautions</h4><ul id="EN-US_TOPIC_0000001099150942__ul183599575513"><li id="EN-US_TOPIC_0000001099150942__li20359185795116">Only the owner of an index or a system administrator can run this statement.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001099150942__s6cad206ae9ee4e3c905b7b9d2366fac4"><h4 class="sectiontitle">Syntax</h4><ul id="EN-US_TOPIC_0000001099150942__u84c8ed4f47d24119a6cbfc79079b4ab1"><li id="EN-US_TOPIC_0000001099150942__l1363a2b271214f64b25c8c08c34ac857">Rename a table index.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__s0b5b5ed914f848048100b9c605d11fea"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="n">index_name</span><span class="w"> </span>
<span class="w"> </span><span class="k">RENAME</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="n">new_name</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001099150942__u051feca823704e2899df7988f72296db"><li id="EN-US_TOPIC_0000001099150942__l818148acf2884b7684d8951b6f1443a1">Modify the storage parameter of a table index.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__sf403d925bece44bf9cc0da1dbfa41869"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="n">index_name</span><span class="w"> </span>
<span class="w"> </span><span class="k">SET</span><span class="w"> </span><span class="p">(</span><span class="w"> </span><span class="err">{</span><span class="n">storage_parameter</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">value</span><span class="err">}</span><span class="w"> </span><span class="p">[,</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">);</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001099150942__uf607d7b4079f4020aca2bc663bc63e53"><li id="EN-US_TOPIC_0000001099150942__l7d9403c3ccfc43ed9cdcd78116c69e66">Reset the storage parameter of a table index.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__s31f9576e207b4fd09cb7ec6dfbd4be72"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="n">index_name</span><span class="w"> </span>
<span class="w"> </span><span class="k">RESET</span><span class="w"> </span><span class="p">(</span><span class="w"> </span><span class="n">storage_parameter</span><span class="w"> </span><span class="p">[,</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001099150942__uab5d05475dd540bd9d1b20d8bcfe56da"><li id="EN-US_TOPIC_0000001099150942__l36ea39b11dfd4d5e9bd8f2592ec6c349">Set a table index or an index partition to be unavailable.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__s833765699b324cbab7e1d05bd98afec0"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="n">index_name</span><span class="w"> </span>
<span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">MODIFY</span><span class="w"> </span><span class="n">PARTITION</span><span class="w"> </span><span class="n">index_partition_name</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="n">UNUSABLE</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
<div class="note" id="EN-US_TOPIC_0000001099150942__n66d540cd81e44d20b2efe9e2d8f93532"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001099150942__a3efb19dee84b45a08125c1a5dd52102f">The syntax cannot be used for column-store tables.</p>
</div></div>
</li></ul>
<ul id="EN-US_TOPIC_0000001099150942__u084e07066e604d11a0630508419d3633"><li id="EN-US_TOPIC_0000001099150942__lcdb1bada1502446080ede00a543fe55c">Rebuild a table index or index partition.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__sd11500f84ffc4b4cb0efb386ed33af7f"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="n">index_name</span><span class="w"> </span>
<span class="w"> </span><span class="n">REBUILD</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="n">PARTITION</span><span class="w"> </span><span class="n">index_partition_name</span><span class="w"> </span><span class="p">];</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001099150942__uf9bd95afe2374be19235faa856239774"><li id="EN-US_TOPIC_0000001099150942__l3295d5696dd040f09ccfa7c044c0c9d0">Rename an index partition.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__sacea3a0ca5a94f40b0036c83eb8288d8"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="k">IF</span><span class="w"> </span><span class="k">EXISTS</span><span class="w"> </span><span class="p">]</span><span class="w"> </span><span class="n">index_name</span><span class="w"> </span>
<span class="w"> </span><span class="k">RENAME</span><span class="w"> </span><span class="n">PARTITION</span><span class="w"> </span><span class="n">index_partition_name</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="n">new_index_partition_name</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
<div class="note" id="EN-US_TOPIC_0000001099150942__note1634710268499"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001099150942__p6347122618497"><strong id="EN-US_TOPIC_0000001099150942__b14490331376">PG_OBJECT</strong> does not support the record of the syntax when the last modification time of the index is recorded.</p>
</div></div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001099150942__s52de0c19fcc349629b947d9dfad0c1ea"><h4 class="sectiontitle">Parameter Description</h4><ul id="EN-US_TOPIC_0000001099150942__ueec0d2180da64393b504b0492497408b"><li id="EN-US_TOPIC_0000001099150942__lb5a581cea2e9489b901d83488ea5ac83"><strong id="EN-US_TOPIC_0000001099150942__a321a7220147b4ce299c548770d8072b6">index_name</strong><p id="EN-US_TOPIC_0000001099150942__a0d9ae1ad4d0c421daca43bcf5c26c1e6">Specifies the index name to be modified.</p>
</li><li id="EN-US_TOPIC_0000001099150942__l80ccbdfa6cdd4958b588e31417249ddf"><strong id="EN-US_TOPIC_0000001099150942__a81420552f83542e784f97a6c10cebfa0">new_name</strong><p id="EN-US_TOPIC_0000001099150942__a58ae172da8b94eefbacc6145d6277724">Specifies the new name for the index.</p>
<p id="EN-US_TOPIC_0000001099150942__aa3fd9f78e23d47f9875b02b9450b9ebb">Value range: a string that must comply with the identifier naming rules.</p>
</li><li id="EN-US_TOPIC_0000001099150942__lf39f468f02874ab1bfb87a809ad1eb4a"><strong id="EN-US_TOPIC_0000001099150942__a83f6000ed1964f65b3c055f1308fa79a">storage_parameter</strong><p id="EN-US_TOPIC_0000001099150942__a79b7e4eaed3f472294a59fda2a664e6a">Specifies the name of an index-method-specific parameter.</p>
</li><li id="EN-US_TOPIC_0000001099150942__lfadf25dffdfb49bea40baf43cfa9e23e"><strong id="EN-US_TOPIC_0000001099150942__a9e4717661b8e4fda82d9f625f0a9d8bb">value</strong><p id="EN-US_TOPIC_0000001099150942__a0398495b37474528b65bf8aa00d50a2e">Specifies the new value for an index-method-specific storage parameter. This might be a number or a word depending on the parameter. </p>
</li><li id="EN-US_TOPIC_0000001099150942__l02c2c34e3a2c426880176247c7aa8242"><strong id="EN-US_TOPIC_0000001099150942__adb41cc3e6dbd4047a8457876807bab20">new_index_partition_name</strong><p id="EN-US_TOPIC_0000001099150942__af8a53d9694db46f79747f19153a17693">Specifies the new name of the index partition.</p>
</li><li id="EN-US_TOPIC_0000001099150942__l4307a4aa36e74b5c82729a8584baca28"><strong id="EN-US_TOPIC_0000001099150942__a9f26ad23a6ea4abda78aca8e2a82df4b">index_partition_name</strong><p id="EN-US_TOPIC_0000001099150942__af322fb5c6e78473a99b5561f7bf1dcfb">Specifies the name of the index partition.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001099150942__sf3bd0e6fc9b746e3a1a6a7e6fbd53f24"><h4 class="sectiontitle">Examples</h4><p id="EN-US_TOPIC_0000001099150942__p1068716598379">Rename the <strong id="EN-US_TOPIC_0000001099150942__b20379172019535">ds_ship_mode_t1_index1</strong> index to <strong id="EN-US_TOPIC_0000001099150942__b845572575314">ds_ship_mode_t1_index5</strong>.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__screen1878795012510"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="n">tpcds</span><span class="p">.</span><span class="n">ds_ship_mode_t1_index1</span><span class="w"> </span><span class="k">RENAME</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="n">ds_ship_mode_t1_index5</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001099150942__p1377413333818">Set the <strong id="EN-US_TOPIC_0000001099150942__b15697104318535">ds_ship_mode_t1_index2</strong> index as unusable.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__screen1296012117521"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="n">tpcds</span><span class="p">.</span><span class="n">ds_ship_mode_t1_index2</span><span class="w"> </span><span class="n">UNUSABLE</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001099150942__p1045810103815">Rebuild the <strong id="EN-US_TOPIC_0000001099150942__b163985675311">ds_ship_mode_t1_index2</strong> index.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__screen126603005210"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="n">tpcds</span><span class="p">.</span><span class="n">ds_ship_mode_t1_index2</span><span class="w"> </span><span class="n">REBUILD</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
<p id="EN-US_TOPIC_0000001099150942__p1251251706">Rename a partitioned table index.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001099150942__screen35241126883"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">ALTER</span><span class="w"> </span><span class="k">INDEX</span><span class="w"> </span><span class="n">tpcds</span><span class="p">.</span><span class="n">ds_customer_address_p1_index2</span><span class="w"> </span><span class="k">RENAME</span><span class="w"> </span><span class="n">PARTITION</span><span class="w"> </span><span class="n">CA_ADDRESS_SK_index1</span><span class="w"> </span><span class="k">TO</span><span class="w"> </span><span class="n">CA_ADDRESS_SK_index4</span><span class="p">;</span><span class="w"></span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001099150942__s63875c5c56534d2db6418ba5e306a898"><h4 class="sectiontitle">Links</h4><p id="EN-US_TOPIC_0000001099150942__a9f1920e5363d4187b2f67edfcc608a8d"><a href="dws_06_0165.html">CREATE INDEX</a>, <a href="dws_06_0195.html">DROP INDEX</a>, <a href="dws_06_0218.html">REINDEX</a></p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_06_0118.html">DDL Syntax</a></div>
</div>
</div>
View Git Blame Copy Permalink