vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/dev/dws_06_0062.html
Lu, Huayi ef0ada5a59 DWS DEV 20240716 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-11-02 09:07:47 +00:00

947 lines
184 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001460561332"></a><a name="EN-US_TOPIC_0000001460561332"></a>
<h1 class="topictitle1">Other Functions</h1>
<div id="body1553151203304"><div class="section" id="EN-US_TOPIC_0000001460561332__section18849638151213"><h4 class="sectiontitle">pgxc_pool_check()</h4><p id="EN-US_TOPIC_0000001460561332__p284933816120">Description: Checks whether the connection data buffered in the pool is consistent with <strong id="EN-US_TOPIC_0000001460561332__b4441144314374">pgxc_node</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p10849123815123">Return type: <span id="EN-US_TOPIC_0000001460561332__text13738253202213">boolean</span></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section25431436101216"><h4 class="sectiontitle">pgxc_pool_reload()</h4><p id="EN-US_TOPIC_0000001460561332__p12542143671215">Description: Updates the connection information buffered in the pool.</p>
<p id="EN-US_TOPIC_0000001460561332__p1054283601219">Return type: <span id="EN-US_TOPIC_0000001460561332__text113391254172212">boolean</span></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section4294141531220"><h4 class="sectiontitle">pgxc_lock_for_backup()</h4><p id="EN-US_TOPIC_0000001460561332__p12948151122">Description: Locks the cluster before backup. Backup is performed to restore data on new nodes.</p>
<p id="EN-US_TOPIC_0000001460561332__p11294415201215">Return type: <span id="EN-US_TOPIC_0000001460561332__text17885115472214">boolean</span></p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note229451541213"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001460561332__p102941915141216"><strong id="EN-US_TOPIC_0000001460561332__b842352706144724">pgxc_lock_for_backup</strong> locks a cluster before <strong id="EN-US_TOPIC_0000001460561332__b84235270614488">gs_dump</strong> or <strong id="EN-US_TOPIC_0000001460561332__b842352706144813">gs_dumpall</strong> is used to back up the cluster. After a cluster is locked, operations changing the system structure are not allowed. This function does not affect DML statements.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1915281181215"><h4 class="sectiontitle">pg_pool_validate(clear boolean, co_node_name cstring)</h4><p id="EN-US_TOPIC_0000001460561332__p16152201119120">Description: Clears invalid backend threads on a CN. (These backend threads hold invalid pooler connections to standby DNs.)</p>
<p id="EN-US_TOPIC_0000001460561332__p16152311121214">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section19141713151119"><h4 class="sectiontitle">pg_nodes_memory()</h4><p id="EN-US_TOPIC_0000001460561332__p19141513131114">Description: queries the memory usage of all nodes.</p>
<p id="EN-US_TOPIC_0000001460561332__p31451341110">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1036161001113"><h4 class="sectiontitle">table_skewness(text)</h4><p id="EN-US_TOPIC_0000001460561332__p336191010112">Description: queries the percentage of table data among all nodes.</p>
<p id="EN-US_TOPIC_0000001460561332__p63681015115">Parameter: Indicates that the type of the name of the to-be-queried table is text.</p>
<p id="EN-US_TOPIC_0000001460561332__p4368104112">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section165375141118"><h4 class="sectiontitle">table_skewness(table_name text, column_name text[, row_num text])</h4><p id="EN-US_TOPIC_0000001460561332__p12653853112">Description: Queries the proportion of column data distributed on each node based on the hash distribution rule. The results are sorted based on the data volumes of the nodes.</p>
<p id="EN-US_TOPIC_0000001460561332__p56534518118">Parameters: <strong id="EN-US_TOPIC_0000001460561332__b173651599226">table_name</strong> indicates a table name, <strong id="EN-US_TOPIC_0000001460561332__b1537114916225">column_name</strong> indicates a column name, and <strong id="EN-US_TOPIC_0000001460561332__b7372199142214">row_num</strong> indicates that all data in the current column is returned. The default value is <strong id="EN-US_TOPIC_0000001460561332__b1237211912215">0</strong>. A value other than <strong id="EN-US_TOPIC_0000001460561332__b18561151020229">0</strong> indicates the number of data records whose statistics are sampled. (Records are randomly sampled.)</p>
<p id="EN-US_TOPIC_0000001460561332__p18653145101116">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p1565375171118">Example:</p>
<p id="EN-US_TOPIC_0000001460561332__p665310510114">Distribute data by hash based on the <strong id="EN-US_TOPIC_0000001460561332__b14277816547">a</strong> column in the <strong id="EN-US_TOPIC_0000001460561332__b1627801105418">tx</strong> table. Seven records are distributed on DN 1, two records on DN 2, and one record on DN 0.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen137471039618"><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="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">table_skewness</span><span class="p">(</span><span class="s1">'tx'</span><span class="p">,</span><span class="s1">'a'</span><span class="p">);</span>
<span class="w"> </span><span class="n">seqnum</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">ratio</span>
<span class="c1">--------+-----+----------</span>
<span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">7</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">70</span><span class="p">.</span><span class="mi">000</span><span class="o">%</span>
<span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">20</span><span class="p">.</span><span class="mi">000</span><span class="o">%</span>
<span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10</span><span class="p">.</span><span class="mi">000</span><span class="o">%</span>
<span class="p">(</span><span class="mi">3</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section13524359141015"><h4 class="sectiontitle">table_data_skewness(data_row record, locatorType "char")</h4><p id="EN-US_TOPIC_0000001460561332__p552415961016">Description: Calculates the bucket distribution index for the records concatenated using the columns in a specified table.</p>
<p id="EN-US_TOPIC_0000001460561332__p11524145915105">Parameters: <strong id="EN-US_TOPIC_0000001460561332__b0477192814225">data_row</strong> indicates the record concatenated using columns in the specified table. <strong id="EN-US_TOPIC_0000001460561332__b0483152812212">locatorType</strong> indicates the distribution rule. You are advised to set <strong id="EN-US_TOPIC_0000001460561332__b104831128182215">locatorType</strong> to <strong id="EN-US_TOPIC_0000001460561332__b2048482812223">H</strong>, indicating hash distribution.</p>
<p id="EN-US_TOPIC_0000001460561332__p1352495991019">Return type: smallint</p>
<p id="EN-US_TOPIC_0000001460561332__p55241359141018">Example:</p>
<p id="EN-US_TOPIC_0000001460561332__p252411593103">Calculates the bucket distribution index based on the hash distribution rule for the records combined concatenated using column a in the <strong id="EN-US_TOPIC_0000001460561332__b141387314222">tx</strong> table.</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen165248595109"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">select</span><span class="w"> </span><span class="n">a</span><span class="p">,</span><span class="w"> </span><span class="n">table_data_skewness</span><span class="p">(</span><span class="k">row</span><span class="p">(</span><span class="n">a</span><span class="p">),</span><span class="w"> </span><span class="s1">'H'</span><span class="p">)</span><span class="w"> </span><span class="k">from</span><span class="w"> </span><span class="n">tx</span><span class="p">;</span>
<span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">table_data_skewness</span><span class="w"> </span>
<span class="c1">---+---------------------</span>
<span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span>
<span class="w"> </span><span class="mi">7</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span>
<span class="w"> </span><span class="mi">4</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="p">(</span><span class="mi">5</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section14831155541018"><h4 class="sectiontitle">table_distribution(schemaname text, tablename text)</h4><p id="EN-US_TOPIC_0000001460561332__p38317551103">Description: queries the storage space occupied by a specified table on each node.</p>
<p id="EN-US_TOPIC_0000001460561332__p7831855201017">Parameter: Indicates that the types of the schema name and table name for the table to be queried are both text.</p>
<p id="EN-US_TOPIC_0000001460561332__p19831455201018">Return type: record</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note3831155201014"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul16831185514101"><li id="EN-US_TOPIC_0000001460561332__li98315551101">To query for the storage distribution of a specified table by using this function, you must have the <strong id="EN-US_TOPIC_0000001460561332__b2419194710270">SELECT</strong> permission for the table.</li><li id="EN-US_TOPIC_0000001460561332__li6831155571014">The performance of <strong id="EN-US_TOPIC_0000001460561332__b1054342794416">table_distribution</strong> is better than that of <strong id="EN-US_TOPIC_0000001460561332__b41216327441">table_skewness</strong>. Especially in a large cluster with a large amount of data, <strong id="EN-US_TOPIC_0000001460561332__b143743734417">table_distribution</strong> is recommended.</li><li id="EN-US_TOPIC_0000001460561332__li983155511109">When you use <strong id="EN-US_TOPIC_0000001460561332__b115061945134412">table_distribution</strong> and want to view the space usage, you can use <strong id="EN-US_TOPIC_0000001460561332__b851414618259">dnsize</strong> or <strong id="EN-US_TOPIC_0000001460561332__b669255242520">(sum(dnsize) over ())</strong> to view the percentage.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1774134741016"><h4 class="sectiontitle">table_distribution(regclass)</h4><p id="EN-US_TOPIC_0000001460561332__p15739447141015">Description: queries the storage space occupied by a specified table on each node.</p>
<p id="EN-US_TOPIC_0000001460561332__p17739204718100">Parameter: indicates the name or OID of the table to be queried. The table name can be defined by the schema name. Parameter type: regclass</p>
<p id="EN-US_TOPIC_0000001460561332__p673944717105">Return type: record</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note17741124718108"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul17741114717109"><li id="EN-US_TOPIC_0000001460561332__li2074013471107">To query for the storage distribution of a specified table by using this function, you must have the <strong id="EN-US_TOPIC_0000001460561332__b1231699747">SELECT</strong> permission for the table.</li><li id="EN-US_TOPIC_0000001460561332__li574010477107">The performance of <strong id="EN-US_TOPIC_0000001460561332__b1111318054">table_distribution</strong> is better than that of <strong id="EN-US_TOPIC_0000001460561332__b2139706250">table_skewness</strong>. Especially in a large cluster with a large amount of data, <strong id="EN-US_TOPIC_0000001460561332__b1843243349">table_distribution</strong> is recommended.</li><li id="EN-US_TOPIC_0000001460561332__li15741847191018">When you use <strong id="EN-US_TOPIC_0000001460561332__b1710288998">table_distribution</strong> and want to view the space usage, you can use <strong id="EN-US_TOPIC_0000001460561332__b1943236618">dnsize</strong> or <strong id="EN-US_TOPIC_0000001460561332__b1398039308">(sum(dnsize) over ())</strong> to view the percentage.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section122691544111016"><h4 class="sectiontitle">table_distribution()</h4><p id="EN-US_TOPIC_0000001460561332__p13268114411015">Description: queries the storage distribution of all tables in the current database.</p>
<p id="EN-US_TOPIC_0000001460561332__p326814471011">Return type: record</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note122691444191015"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul126916449103"><li id="EN-US_TOPIC_0000001460561332__li20268154413105">This function involves the query for information about all tables in the database. To execute this function, you must have the administrator rights or rights of the preset role <strong id="EN-US_TOPIC_0000001460561332__b162039492232">gs_role_read_all_stats</strong>.</li><li id="EN-US_TOPIC_0000001460561332__li18269154431014">Based on the table_distribution() function, <span id="EN-US_TOPIC_0000001460561332__text769433086">GaussDB(DWS)</span> provides the PGXC_GET_TABLE_SKEWNESS view as an alternative way to query for data skew. You are advised to use this view when the number of tables in the database is less than 10000.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section14414124091012"><h4 class="sectiontitle">gs_table_distribution(schemaname text, tablename text)</h4><p id="EN-US_TOPIC_0000001460561332__p10409134011102">Description: queries the storage space occupied by a specified table on each node.</p>
<p id="EN-US_TOPIC_0000001460561332__p1040920401103">Return type: record</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001460561332__table0413174051017" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Fields returned by the gs_table_distribution(schemaname text, tablename text) function</caption><thead align="left"><tr id="EN-US_TOPIC_0000001460561332__row164091440151017"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.12.4.2.4.1.1"><p id="EN-US_TOPIC_0000001460561332__p16409124041010">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.12.4.2.4.1.2"><p id="EN-US_TOPIC_0000001460561332__p5409134031016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.12.4.2.4.1.3"><p id="EN-US_TOPIC_0000001460561332__p8409740181020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001460561332__row1341104011109"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p20409140181017">schemaname</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p441064012106">name</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.12.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p441094011108">Schema name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row941115401101"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p541134001013">tablename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p941134012103">name</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.12.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1041119406104">Table name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row941214400100"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p241111400104">relkind</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p16411194081018">character</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.12.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p11411740131012">Type.</p>
<ul id="EN-US_TOPIC_0000001460561332__ul3412164091018"><li id="EN-US_TOPIC_0000001460561332__li104121540171011"><strong id="EN-US_TOPIC_0000001460561332__b474679173120">i</strong>: index</li><li id="EN-US_TOPIC_0000001460561332__li8412114091013"><strong id="EN-US_TOPIC_0000001460561332__b19676814153115">r</strong>: table</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row3412114041011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p1641254061011">nodename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p34121407101">name</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.12.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p16412124031012">Node name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1641374013106"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p16412640151010">dnsize</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.12.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1441384091010">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.12.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p24131540161018">Storage space of the table on the node, in bytes.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001460561332__note174141940131019"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul1441484015101"><li id="EN-US_TOPIC_0000001460561332__li44131840191016">To query for the storage distribution of a specified table by using this function, you must have the <strong id="EN-US_TOPIC_0000001460561332__b1621569352">SELECT</strong> permission for the table.</li><li id="EN-US_TOPIC_0000001460561332__li7414104071011">This function is based on the physical file storage space records in the <strong id="EN-US_TOPIC_0000001460561332__b15446794614">PG_RELFILENODE_SIZE</strong> system catalog. Ensure that the GUC parameters <strong id="EN-US_TOPIC_0000001460561332__b9184182319468">use_workload_manager</strong> and <strong id="EN-US_TOPIC_0000001460561332__b7151234134615">enable_perm_space</strong> are enabled.</li><li id="EN-US_TOPIC_0000001460561332__li34141040111010">The performance of the <strong id="EN-US_TOPIC_0000001460561332__b13259141745016">gs_table_distribution</strong> function is lower than that of the <strong id="EN-US_TOPIC_0000001460561332__b1255132715500">table_distribution</strong> function when a single table is queried. But when the entire database is queried, the performance of the <strong id="EN-US_TOPIC_0000001460561332__b88595135014">gs_table_distribution</strong> function is much better. In a large cluster with a large amount of data, you are advised to use the <strong id="EN-US_TOPIC_0000001460561332__b195431729115811">gs_table_distribution</strong> function to query all tables in the database.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1665243513103"><h4 class="sectiontitle">gs_table_distribution()</h4><p id="EN-US_TOPIC_0000001460561332__p1064613518105">Description: quickly queries the storage distribution of all tables in the current database.</p>
<p id="EN-US_TOPIC_0000001460561332__p5646143561016">Return type: record</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001460561332__table18651435201013" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Fields returned by the gs_table_distribution() function</caption><thead align="left"><tr id="EN-US_TOPIC_0000001460561332__row1965013514103"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.13.4.2.4.1.1"><p id="EN-US_TOPIC_0000001460561332__p146467357107">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.13.4.2.4.1.2"><p id="EN-US_TOPIC_0000001460561332__p06461635111015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.13.4.2.4.1.3"><p id="EN-US_TOPIC_0000001460561332__p46471135141015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001460561332__row26501035161013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p146501135191013">schemaname</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p165083517109">name</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.13.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p8650193515102">Schema name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1065073511102"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p7650133511016">tablename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1565063501012">name</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.13.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1065043517105">Table name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row19651135121011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p1465020357102">relkind</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p16650135151018">character</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.13.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1965093517101">Type of the table. <strong id="EN-US_TOPIC_0000001460561332__b2070313317118">i</strong>: index; <strong id="EN-US_TOPIC_0000001460561332__b107429110110">r</strong>: table.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1365133501016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p16651133551017">nodename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p136511235111014">name</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.13.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p136511355100">Node name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1565111359100"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p1065103561019">dnsize</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.13.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p26511935141011">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.13.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p6651535161012">Storage space of the table on the node, in bytes.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001460561332__note166521935101012"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul66521354100"><li id="EN-US_TOPIC_0000001460561332__li106511835151013">To query for the storage distribution of a specified table by using this function, you must have the <strong id="EN-US_TOPIC_0000001460561332__b467934853">SELECT</strong> permission for the table.</li><li id="EN-US_TOPIC_0000001460561332__li10652193517109">This function is based on the physical file storage space records in the <strong id="EN-US_TOPIC_0000001460561332__b1087879404">PG_RELFILENODE_SIZE</strong> system catalog. Ensure that the GUC parameters <strong id="EN-US_TOPIC_0000001460561332__b1602281670">use_workload_manager</strong> and <strong id="EN-US_TOPIC_0000001460561332__b972334563">enable_perm_space</strong> are enabled.</li><li id="EN-US_TOPIC_0000001460561332__li20652935201012">The performance of the <strong id="EN-US_TOPIC_0000001460561332__b19964103295914">gs_table_distribution</strong> function is lower than that of the <strong id="EN-US_TOPIC_0000001460561332__b1296419329590">table_distribution</strong> function when a single table is queried. But when the entire database is queried, the performance of the <strong id="EN-US_TOPIC_0000001460561332__b796493275915">gs_table_distribution</strong> function is much better. In a large cluster with a large amount of data, you are advised to use the <strong id="EN-US_TOPIC_0000001460561332__b199641432175911">gs_table_distribution</strong> function to query all tables in the database.</li><li id="EN-US_TOPIC_0000001460561332__li1875655114208">Based on the <strong id="EN-US_TOPIC_0000001460561332__b17381710133910">gs_table_distribution()</strong> function, <span id="EN-US_TOPIC_0000001460561332__text117568512209">GaussDB(DWS)</span> 8.2.1 and later versions provide the <strong id="EN-US_TOPIC_0000001460561332__b11271172713915">PGXC_WLM_TABLE_DISTRIBUTION_SKEWNESS</strong> view for data skew query. You are advised to use this view when the number of tables in the database is small (less than 10,000).</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section4403914121018"><h4 class="sectiontitle">plan_seed()</h4><p id="EN-US_TOPIC_0000001460561332__p1540311411019">Description: Obtains the seed value of the previous query statement (internal use).</p>
<p id="EN-US_TOPIC_0000001460561332__p144031314131010">Return type: integer</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section4431512151017"><h4 class="sectiontitle">pg_stat_get_env()</h4><p id="EN-US_TOPIC_0000001460561332__p164351211016">Description: Obtains the environment variable information about the current node.</p>
<p id="EN-US_TOPIC_0000001460561332__p543151271014">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section15216128101013"><h4 class="sectiontitle">pg_stat_get_thread()</h4><p id="EN-US_TOPIC_0000001460561332__p142163814107">Description: Provides information about the status of all threads under the current node.</p>
<p id="EN-US_TOPIC_0000001460561332__p14216128201011">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1119415611108"><h4 class="sectiontitle">pgxc_get_os_threads()</h4><p id="EN-US_TOPIC_0000001460561332__p119416613103">Description: Provides information about the status of threads under all normal nodes in a cluster.</p>
<p id="EN-US_TOPIC_0000001460561332__p111946619103">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section2010573121015"><h4 class="sectiontitle">pg_stat_get_sql_count()</h4><p id="EN-US_TOPIC_0000001460561332__p61051634102">Description: Provides statistics on the number of <strong id="EN-US_TOPIC_0000001460561332__b120575717451">SELECT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b1215119154617">UPDATE</strong>/<strong id="EN-US_TOPIC_0000001460561332__b198671731469">INSERT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b96032624614">DELETE</strong>/<strong id="EN-US_TOPIC_0000001460561332__b564918117463">MERGE INTO</strong> statements executed by all users on the current node, response time, and the number of DDL, DML, and DCL statements. </p>
<p id="EN-US_TOPIC_0000001460561332__p1010517341011">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1552019031016"><h4 class="sectiontitle">pgxc_get_sql_count()</h4><p id="EN-US_TOPIC_0000001460561332__p175201609101">Description: Provides statistics on the number of <strong id="EN-US_TOPIC_0000001460561332__b19259114594715">SELECT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b12259445194717">UPDATE</strong>/<strong id="EN-US_TOPIC_0000001460561332__b17260645144718">INSERT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b16261134513476">DELETE</strong>/<strong id="EN-US_TOPIC_0000001460561332__b19261114564716">MERGE INTO</strong> statements executed by all users on all nodes of the current cluster, response time, and the number of DDL, DML, and DCL statements.</p>
<p id="EN-US_TOPIC_0000001460561332__p1952019016105">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section52827521794"><h4 class="sectiontitle">pgxc_get_workload_sql_count()</h4><p id="EN-US_TOPIC_0000001460561332__p12824521299">Description: Provides statistics on the number of <strong id="EN-US_TOPIC_0000001460561332__b14249656124713">SELECT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b102490569471">UPDATE</strong>/<strong id="EN-US_TOPIC_0000001460561332__b5249656204718">INSERT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b724955684713">DELETE</strong> statements executed in all workload Cgroup on all CNs of the current cluster and the number of DDL, DML, and DCL statements.</p>
<p id="EN-US_TOPIC_0000001460561332__p72828524910">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section142464500915"><h4 class="sectiontitle">pgxc_get_workload_sql_elapse_time()</h4><p id="EN-US_TOPIC_0000001460561332__p224645018914">Description: Provides statistics on response time of <strong id="EN-US_TOPIC_0000001460561332__b163719332530">SELECT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b96376339534">UPDATE</strong>/<strong id="EN-US_TOPIC_0000001460561332__b16637933125310">INSERT</strong>/<strong id="EN-US_TOPIC_0000001460561332__b18637103365317">DELETE</strong> statements executed in all workload Cgroup on all CNs of the current cluster.</p>
<p id="EN-US_TOPIC_0000001460561332__p102469508913">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section57051471192"><h4 class="sectiontitle">get_instr_unique_sql()</h4><p id="EN-US_TOPIC_0000001460561332__p17705174713916">Description: Provides information about Unique SQL statistics collected on the current node. If the node is a CN, the system returns the complete information about the Unique SQL statistics collected on the CN. That is, the system collects and summarizes the information about the Unique SQL statistics on other CNs and DNs. If the node is a DN, the Unique SQL statistics on the DN is returned. For details, see the <strong id="EN-US_TOPIC_0000001460561332__b53247402917">GS_INSTR_UNIQUE_SQL</strong> view.</p>
<p id="EN-US_TOPIC_0000001460561332__p670512475919">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section763015442912"><h4 class="sectiontitle">reset_instr_unique_sql(cstring, cstring, INT8)</h4><p id="EN-US_TOPIC_0000001460561332__p1463014445912">Description: Clears collected Unique SQL statistics. The input parameters are described as follows:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul176301744899"><li id="EN-US_TOPIC_0000001460561332__li4630244195"><strong id="EN-US_TOPIC_0000001460561332__b39261410950">GLOBAL</strong>/<strong id="EN-US_TOPIC_0000001460561332__b11181131554">LOCAL</strong>: Data is cleared from all nodes or the current node.</li><li id="EN-US_TOPIC_0000001460561332__li1063074420915"><strong id="EN-US_TOPIC_0000001460561332__b194871224351">ALL</strong>/<strong id="EN-US_TOPIC_0000001460561332__b1072312279518">BY_USERID</strong>/<strong id="EN-US_TOPIC_0000001460561332__b13156113114513">BY_CNID</strong>/<strong id="EN-US_TOPIC_0000001460561332__b62066341753">BY_GUC</strong>: <strong id="EN-US_TOPIC_0000001460561332__b599714615518">ALL</strong> indicates that all data is cleared. <strong id="EN-US_TOPIC_0000001460561332__b169801658659">BY_USERID/BY_CNID</strong> indicates that data is cleared by <strong id="EN-US_TOPIC_0000001460561332__b16145179619">USERID</strong> or <strong id="EN-US_TOPIC_0000001460561332__b1954219868">CNID</strong>. <strong id="EN-US_TOPIC_0000001460561332__b196905281566">BY_GUC</strong> indicates that the clearance operation is caused by the decrease of the value of the GUC parameter <strong id="EN-US_TOPIC_0000001460561332__b1734019439613">instr_unique_sql_count</strong>.</li><li id="EN-US_TOPIC_0000001460561332__li1363010449919">The third parameter corresponds to the second parameter. The parameter is invalid for <strong id="EN-US_TOPIC_0000001460561332__b2344173413718">ALL</strong>/<strong id="EN-US_TOPIC_0000001460561332__b19613143714711">BY_GUC</strong>.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p463094416911">Return type: bool</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section108151240693"><h4 class="sectiontitle">pgxc_get_instr_unique_sql()</h4><p id="EN-US_TOPIC_0000001460561332__p68156401099">Description: Provides complete information about Unique SQL statistics collected on all CNs in a cluster. This function can be executed only on CNs.</p>
<p id="EN-US_TOPIC_0000001460561332__p118151840090">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section2363438392"><h4 class="sectiontitle">get_instr_unique_sql_remote_cns()</h4><p id="EN-US_TOPIC_0000001460561332__p336315381699">Description: Provides complete information about Unique SQL statements collected on all CNs in the cluster, except the CN on which the function is being executed. This function can be executed only on CNs.</p>
<p id="EN-US_TOPIC_0000001460561332__p15363438995">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section8435355917"><h4 class="sectiontitle">pgxc_get_node_env()</h4><p id="EN-US_TOPIC_0000001460561332__p20420359915">Description: Provides the environment variable information about all nodes in a cluster.</p>
<p id="EN-US_TOPIC_0000001460561332__p6421635695">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section14439532492"><h4 class="sectiontitle">gs_switch_relfilenode()</h4><p id="EN-US_TOPIC_0000001460561332__p6439532493">Description: Exchanges meta information of two tables or partitions. (This is only used for the redistribution tool. An error message is displayed when the function is directly used by users).</p>
<p id="EN-US_TOPIC_0000001460561332__p174394328913">Return type: integer</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section4336825297"><h4 class="sectiontitle">copy_error_log_create()</h4><p id="EN-US_TOPIC_0000001460561332__p1833218254917">Description: Creates the error table (<strong id="EN-US_TOPIC_0000001460561332__b5277134318517">public.pgxc_copy_error_log</strong>) required for creating the <strong id="EN-US_TOPIC_0000001460561332__b22791843125117">COPY FROM</strong> error tolerance mechanism.</p>
<p id="EN-US_TOPIC_0000001460561332__p163324251097">Return type: <span id="EN-US_TOPIC_0000001460561332__text1445918252">boolean</span></p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note113341425097"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul4334025592"><li id="EN-US_TOPIC_0000001460561332__li13333202519917">This function attempts to create the <strong id="EN-US_TOPIC_0000001460561332__b128313244570">public.pgxc_copy_error_log</strong> table. For details about the table, see <a href="#EN-US_TOPIC_0000001460561332__table63361925092">Table 3</a>.</li><li id="EN-US_TOPIC_0000001460561332__li23331259916">Create the B-tree index on the <strong id="EN-US_TOPIC_0000001460561332__b9806133665712">relname</strong> column and execute <strong id="EN-US_TOPIC_0000001460561332__b8806143612573">REVOKE ALL on public.pgxc_copy_error_log FROM public</strong> to manage permissions for the error table (the permissions are the same as those of the <strong id="EN-US_TOPIC_0000001460561332__b148061636175711">COPY</strong> statement).</li><li id="EN-US_TOPIC_0000001460561332__li1533312251493"><strong id="EN-US_TOPIC_0000001460561332__b842352706192838">public.pgxc_copy_error_log</strong> is a row-store table. Therefore, this function can be executed and <strong id="EN-US_TOPIC_0000001460561332__b20431437105218">COPY FROM</strong> error tolerance is available only when row-store tables can be created in the cluster. After the GUC parameter <strong id="EN-US_TOPIC_0000001460561332__b16650193815012">enable_hadoop_env</strong> is enabled, row-based tables cannot be created in the cluster. The default value is <strong id="EN-US_TOPIC_0000001460561332__b1574011465506">off</strong>.</li><li id="EN-US_TOPIC_0000001460561332__li1433352512916">Same as the error table and the <strong id="EN-US_TOPIC_0000001460561332__b926604001123546">COPY</strong> statement, the function requires <strong id="EN-US_TOPIC_0000001460561332__b49211628678">sysadmin</strong> or higher permissions.</li><li id="EN-US_TOPIC_0000001460561332__li3334172515919">If the <strong id="EN-US_TOPIC_0000001460561332__b1424295211547">public.pgxc_copy_error_log</strong> table or the <strong id="EN-US_TOPIC_0000001460561332__b7244105275419">copy_error_log_relname_idx</strong> index already exists before the function creates it, the function will report an error and roll back.</li></ul>
</div></div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001460561332__table63361925092"></a><a name="table63361925092"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001460561332__table63361925092" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Error table public.pgxc_copy_error_log</caption><thead align="left"><tr id="EN-US_TOPIC_0000001460561332__row133348251499"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.28.5.2.4.1.1"><p id="EN-US_TOPIC_0000001460561332__p1533419256916">Column</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.28.5.2.4.1.2"><p id="EN-US_TOPIC_0000001460561332__p933411250918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.28.5.2.4.1.3"><p id="EN-US_TOPIC_0000001460561332__p1033411251196">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001460561332__row173351525998"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p113351725297">relname</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p533510251293">varchar</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p183351725897">Table name in the form of <em id="EN-US_TOPIC_0000001460561332__i1630782015259">Schema name</em><strong id="EN-US_TOPIC_0000001460561332__b266202317257">.</strong><em id="EN-US_TOPIC_0000001460561332__i1282582642516">Table name</em></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1433517251692"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p833510251910">begintime</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p16335325496">timestamp with time zone</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p933572514913">Time when a data format error was reported</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row23357251892"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p163351025294">filename</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p99657123432">varchar</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p5335102517911">Name of the source data file where a data format error occurs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row8336102512916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p163359257911">rownum</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1333518251998">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1233619251398">Number of the row where a data format error occurs in a source data file</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1233632514918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p18336325294">rawrecord</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1633662516919">text</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p113361325598">Raw record of a data format error in the source data file To prevent a field from being too long, the length of the field cannot exceed 1024 bytes.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1233617258918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p23365251893">detail</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p13336425290">text</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1233614253914">Error details</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row461720372324"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p11618937113214">columnname</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p176182379327">varchar</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p136181437183216">Name of the column whose data format is incorrect in the data source file. Only 8.2.1.100 and later versions support this function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1261853743215"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p761863733219">errcode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p44731869438">varchar</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p11618737143218">Error code corresponding to the error information. The sqlstate error code is used. Only 8.2.1.100 and later versions support this function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row13618173714323"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p10619163719322">queryid</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.28.5.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p13619133719324">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.28.5.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p19619143733216">ID of the SQL statement for executing the Copy statement. It uniquely identifies an SQL statement. Only 8.2.1.100 and later versions support this function.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section3598191615917"><h4 class="sectiontitle">pv_compute_pool_workload()</h4><p id="EN-US_TOPIC_0000001460561332__p1159820162917">Description: Provides the current load information about computing Node Groups on cloud.</p>
<p id="EN-US_TOPIC_0000001460561332__p1259814166910">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section441911320910"><h4 class="sectiontitle">pg_stat_get_status(tid, num_node_display)</h4><p id="EN-US_TOPIC_0000001460561332__p124191131397">Description: Queries for the blocking and waiting status of the backend threads and auxiliary threads in the current instance. For details about the returned results, see the PG_THREAD_WAIT_STATUS view. The input parameters are described as follows:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul154198131097"><li id="EN-US_TOPIC_0000001460561332__li34190131891"><strong id="EN-US_TOPIC_0000001460561332__b63524113510">tid</strong>: thread ID, which is of the bigint type. If this parameter is null, the waiting statuses of all backend threads and auxiliary threads are returned. Otherwise, only the waiting statuses of threads with the specified IDs are returned.</li><li id="EN-US_TOPIC_0000001460561332__li1141951315915"><strong id="EN-US_TOPIC_0000001460561332__b6908831135218">num_node_display</strong>: integer type. Specifies the maximum number of waiting nodes displayed in the <strong id="EN-US_TOPIC_0000001460561332__b788814254197">wait_status</strong> column for records whose waiting status is <strong id="EN-US_TOPIC_0000001460561332__b3940959171919">wait node</strong>.<ul id="EN-US_TOPIC_0000001460561332__ul641916138914"><li id="EN-US_TOPIC_0000001460561332__li8419213894">If this parameter is left empty or set to a value less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b34014128234">0</strong>, only one waiting node is displayed.</li><li id="EN-US_TOPIC_0000001460561332__li941941311910">If the value is greater than <strong id="EN-US_TOPIC_0000001460561332__b1092451992311">20</strong>, a maximum number of nodes can be displayed is <strong id="EN-US_TOPIC_0000001460561332__b280195312314">20</strong>.</li><li id="EN-US_TOPIC_0000001460561332__li64197131790">If the value is greater than <strong id="EN-US_TOPIC_0000001460561332__b1467381411265">0</strong> and less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b15000181268">20</strong>, the smaller value between <strong id="EN-US_TOPIC_0000001460561332__b5689135092619">num_node_display</strong> and the actual number of waiting nodes is displayed. Use the <strong id="EN-US_TOPIC_0000001460561332__b992217182274">SELECT * from pg_stat_get_status(NULL, 10)</strong> query for example. If the number of waiting nodes is greater than <strong id="EN-US_TOPIC_0000001460561332__b1225142811273">10</strong>, the names of only 10 nodes are displayed randomly. If the number of waiting nodes is less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b19571512913">10</strong>, the names of all waiting nodes are displayed. If the number of waiting nodes is greater than the number of displayed nodes, the displayed node names are randomly selected.</li></ul>
</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p134193131091">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1817417712910"><h4 class="sectiontitle">pgxc_get_thread_wait_status(num_node_display)</h4><p id="EN-US_TOPIC_0000001460561332__p11741271796">Description: Queries for the call hierarchy between threads generated by all SQL statements on each node in a cluster, as well as the block waiting status of each thread. For details about the returned results, see the PGXC_THREAD_WAIT_STATUS view. The type and meaning of the input parameter <strong id="EN-US_TOPIC_0000001460561332__b10594194210310">num_node_display</strong> are the same as those of the <strong id="EN-US_TOPIC_0000001460561332__b929913494310">pg_stat_get_status</strong> function.</p>
<p id="EN-US_TOPIC_0000001460561332__p191741718910">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section10622731290"><h4 class="sectiontitle">pgxc_os_run_info()</h4><p id="EN-US_TOPIC_0000001460561332__p14621153197">Description: Obtains the running status of the operating system on each node in a cluster. For details about the returned results, see "System Catalogs &gt; System Views &gt;PV_OS_RUN_INFO" in the <em id="EN-US_TOPIC_0000001460561332__i275694717420">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p186221312917">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section2534901893"><h4 class="sectiontitle">get_instr_wait_event()</h4><p id="EN-US_TOPIC_0000001460561332__p2534190895">Description: obtains the waiting status and events of the current instance. For details about the returned results, see "System Catalogs &gt; System Views &gt; GS_WAIT_EVENTS" in the <em id="EN-US_TOPIC_0000001460561332__i104784236513">Developer Guide</em>. If the GUC parameter <strong id="EN-US_TOPIC_0000001460561332__b3518201283010">enable_track_wait_event</strong> is <strong id="EN-US_TOPIC_0000001460561332__b18887191713306">off</strong>, this function returns <strong id="EN-US_TOPIC_0000001460561332__b92072456356">0</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p105341001917">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1423385519814"><h4 class="sectiontitle">pgxc_wait_events()</h4><p id="EN-US_TOPIC_0000001460561332__p223145510819">Description: queries statistics about waiting status and events on each node in a cluster. For details about the returned results, see "System Catalogs &gt; System Views &gt; PGXC_WAIT_EVENTS" in the <em id="EN-US_TOPIC_0000001460561332__i810244010411">Developer Guide</em>. If the GUC parameter <strong id="EN-US_TOPIC_0000001460561332__b662259372">enable_track_wait_event</strong> is <strong id="EN-US_TOPIC_0000001460561332__b179661922">off</strong>, this function returns <strong id="EN-US_TOPIC_0000001460561332__b1568536265">0</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p152336556811">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section34119501811"><h4 class="sectiontitle">pgxc_stat_bgwriter()</h4><p id="EN-US_TOPIC_0000001460561332__p44116509813">Description: queries statistics about backend write processes on each node in a cluster. For details about the returned results, see "System Catalogs &gt; System Views &gt; PG_STAT_BGWRITER" in the <em id="EN-US_TOPIC_0000001460561332__i553841125019">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p8411105018815">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section138918474817"><h4 class="sectiontitle">pgxc_stat_replication()</h4><p id="EN-US_TOPIC_0000001460561332__p58804713813">Description: queries information about the log synchronization status on each node in a cluster, such as the location where the logs are sent and received. For details about the returned results, see "System Catalogs &gt; System Views &gt; PG_STAT_REPLICATION" in the <em id="EN-US_TOPIC_0000001460561332__i2493181212534">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p9893475815">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1777354314815"><h4 class="sectiontitle">pgxc_replication_slots()</h4><p id="EN-US_TOPIC_0000001460561332__p577318431781">Description: queries the replication status on each DN in a cluster. For details about the returned results, see "System Catalogs &gt; System Views &gt; PG_REPLICATION_SLOTS" in the <em id="EN-US_TOPIC_0000001460561332__i20516183725516">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p077313439812">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1646453517820"><h4 class="sectiontitle">pgxc_settings()</h4><p id="EN-US_TOPIC_0000001460561332__p646415351588">Description: queries information about runtime parameters on each node in a cluster. For details about the returned results, see "System Catalogs &gt; System Views &gt; PG_SETTINGS" in the <em id="EN-US_TOPIC_0000001460561332__i10142195719555">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p1646410351185">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section856416321882"><h4 class="sectiontitle">pgxc_instance_time()</h4><p id="EN-US_TOPIC_0000001460561332__p356414321487">Description: queries the running time statistics of each node in a cluster and the time consumed in each execution phase. For details about the returned results, see "System Catalogs &gt; System Views &gt; PV_INSTANCE_TIME" in the <em id="EN-US_TOPIC_0000001460561332__i103280455587">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p115647322819">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section205116271985"><h4 class="sectiontitle">pg_stat_get_redo_stat()</h4><p id="EN-US_TOPIC_0000001460561332__p25116277812">Description: queries Xlog redo statistics on the current node. For details about the returned results, see "System Catalogs &gt; System Views &gt; PV_REDO_STAT" in the <em id="EN-US_TOPIC_0000001460561332__i2112440144215">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p75112277820">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section161608241982"><h4 class="sectiontitle">pgxc_redo_stat()</h4><p id="EN-US_TOPIC_0000001460561332__p2160224480">Description: queries the Xlog redo statistics of each node in a cluster. For details about the returned results, see "System Catalogs &gt; System Views &gt; PV_REDO_STAT" in the <em id="EN-US_TOPIC_0000001460561332__i2039914993211">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p181603241082">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section3823520186"><h4 class="sectiontitle">get_local_rel_iostat()</h4><p id="EN-US_TOPIC_0000001460561332__p8823520789">Description: Obtains the disk I/O statistics of the current instance. For details about the returned results, see "System Catalogs &gt; System Views &gt; GS_REL_IOSTAT" in the <em id="EN-US_TOPIC_0000001460561332__i157036138114">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p11823172012813">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section107631691984"><h4 class="sectiontitle">pgxc_rel_iostat()</h4><p id="EN-US_TOPIC_0000001460561332__p976319180">Description: queries the disk I/O statistics on each node in a cluster. For details about the returned result, see "System Catalogs &gt; System Views &gt; GS_REL_IOSTAT" in the <em id="EN-US_TOPIC_0000001460561332__i146029451234">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p67631795817">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1479112883"><h4 class="sectiontitle">get_node_stat_reset_time()</h4><p id="EN-US_TOPIC_0000001460561332__p4791162385">Description: Obtains the time when statistics of the current instance were reset.</p>
<p id="EN-US_TOPIC_0000001460561332__p137911821816">Return type: timestamptz</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section158811598710"><a name="EN-US_TOPIC_0000001460561332__section158811598710"></a><a name="section158811598710"></a><h4 class="sectiontitle">pgxc_node_stat_reset_time()</h4><p id="EN-US_TOPIC_0000001460561332__p19872591717">Description: queries the time when the statistics of each node in a cluster are reset. For details about the returned result, see "System Catalogs &gt; System Views &gt; GS_NODE_STAT_RESET_TIME" in the <em id="EN-US_TOPIC_0000001460561332__i1866584316413">Developer Guide</em>.</p>
<p id="EN-US_TOPIC_0000001460561332__p118816591679">Return type: record</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note14887591274"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><div class="p" id="EN-US_TOPIC_0000001460561332__p6887591575">When an instance is running, its statistics keep rising. In the following cases, the statistical values in the memory will be reset to <strong id="EN-US_TOPIC_0000001460561332__b5536183916429">0</strong>:<ul id="EN-US_TOPIC_0000001460561332__ul38875915710"><li id="EN-US_TOPIC_0000001460561332__li1688459870">The instance is restarted or a cluster switchover occurs.</li><li id="EN-US_TOPIC_0000001460561332__li198875914717">The database is dropped.</li><li id="EN-US_TOPIC_0000001460561332__li1688059677">A reset operation is performed. For example, the statistics counter in the database is reset using the <strong id="EN-US_TOPIC_0000001460561332__b1448552994715">pgstat_recv_resetcounter</strong> function or the Unique SQL statements are cleared using the <strong id="EN-US_TOPIC_0000001460561332__b1068215362536">reset_instr_unique_sql</strong> function.</li></ul>
</div>
<p id="EN-US_TOPIC_0000001460561332__p488559278">If any of the preceding events occurs, <span id="EN-US_TOPIC_0000001460561332__text212614122172">GaussDB(DWS)</span> will record the time when the statistics are reset. You can query the time using the <strong id="EN-US_TOPIC_0000001460561332__b7383153535712">get_node_stat_reset_time</strong> function.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section07501348674"><h4 class="sectiontitle">pgxc_parallel_query(text, text)</h4><p id="EN-US_TOPIC_0000001460561332__p147492481877">Description: Runs a specified SQL query statement on a data instance of a specified type and returns the query result to the current CN. This function is supported in 8.1.2 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p87493489718">The function has two parameters:</p>
<p id="EN-US_TOPIC_0000001460561332__p9749104814718">The first parameter specifies the instances on which the SQL statement is executed. Currently, the valid input parameters are <strong id="EN-US_TOPIC_0000001460561332__b156601126175017">dn</strong>, <strong id="EN-US_TOPIC_0000001460561332__b7593113320501">datanode</strong>, <strong id="EN-US_TOPIC_0000001460561332__b15395163912502">cn</strong>, <strong id="EN-US_TOPIC_0000001460561332__b17668749135018">coordinator</strong>, and <strong id="EN-US_TOPIC_0000001460561332__b4276155735016">all</strong>. Other values will cause function execution errors. <strong id="EN-US_TOPIC_0000001460561332__b288803155112">dn</strong> and <strong id="EN-US_TOPIC_0000001460561332__b3888123195111">datanode</strong> indicate that the statement is executed on all DNs. <strong id="EN-US_TOPIC_0000001460561332__b1848325265110">cn</strong> and <strong id="EN-US_TOPIC_0000001460561332__b4483952135114">coordinator</strong> indicate that the statement is executed on all CNs. <strong id="EN-US_TOPIC_0000001460561332__b165875885217">all</strong> indicates that the statement is executed on all CNs and DNs.</p>
<p id="EN-US_TOPIC_0000001460561332__p107495489719">The second parameter specifies the verification of the objects queried by the SQL statement that is to be sent to a remote node for execution. User tables, distributed tables, and user-defined functions with multiple result sets are not supported.</p>
<p id="EN-US_TOPIC_0000001460561332__p97497481273">Return type: record</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note37506481371"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul775024817719"><li id="EN-US_TOPIC_0000001460561332__li474914481372">This function is only used by developers to efficiently collect the execution information or status of instances in a cluster. You are not advised to use it directly.</li><li id="EN-US_TOPIC_0000001460561332__li17749848271">This function contains multiple result sets, and the return data type is record. Therefore, you need to add the output column name and data type specified by the <strong id="EN-US_TOPIC_0000001460561332__b8210191815314">AS</strong> statement after the function call, as shown in the following:<pre class="screen" id="EN-US_TOPIC_0000001460561332__screen1374913481279">SELECT * FROM pgxc_parallel_query('all', 'select node_name, db_name, thread_name, query_id, tid, lwtid, ptid, tlevel, smpid, wait_status, wait_event from pg_thread_wait_status') AS (node_name text, db_name text, thread_name text, query_id bigint, tid bigint, lwtid integer , ptid integer, tlevel integer , smpid integer, wait_status text, wait_event text);</pre>
</li><li id="EN-US_TOPIC_0000001460561332__li127492489711">The data type of the output result of the SQL statement specified by the second parameter of the function must be the same as the data type specified by the <strong id="EN-US_TOPIC_0000001460561332__b1479922116419">AS</strong> statement. Otherwise, an error may be reported during execution due to type mismatch.</li><li id="EN-US_TOPIC_0000001460561332__li37495481373">The SQL statement specified by the second parameter of the function cannot trigger cross-node query. Otherwise, an error is reported.</li><li id="EN-US_TOPIC_0000001460561332__li1975020483713">The SQL statement specified by the second parameter of the function can only be a <strong id="EN-US_TOPIC_0000001460561332__b529194618215">SELECT</strong>, <strong id="EN-US_TOPIC_0000001460561332__b7243115013214">UPDATE</strong>, <strong id="EN-US_TOPIC_0000001460561332__b496945319216">DELETE</strong>, or <strong id="EN-US_TOPIC_0000001460561332__b19497058422">INSERT </strong>statement.<ul id="EN-US_TOPIC_0000001460561332__ul175018489715"><li id="EN-US_TOPIC_0000001460561332__li1775010481579">The <strong id="EN-US_TOPIC_0000001460561332__b106584351439">returning </strong>statement is not supported.</li><li id="EN-US_TOPIC_0000001460561332__li1475011487718">The user who invokes the function must have the operation permission on the SQL objects.</li><li id="EN-US_TOPIC_0000001460561332__li0750144818714">For <strong id="EN-US_TOPIC_0000001460561332__b1959912146512">INSERT </strong>statements, <strong id="EN-US_TOPIC_0000001460561332__b7565162311516">INSERT OVERWRITE</strong>, <strong id="EN-US_TOPIC_0000001460561332__b66231261955">UPSERT</strong>, and <strong id="EN-US_TOPIC_0000001460561332__b9802530555">INSERT INTO</strong> are not supported.</li><li id="EN-US_TOPIC_0000001460561332__li1475018488717">The <strong id="EN-US_TOPIC_0000001460561332__b935412441723">UPDATE</strong>, <strong id="EN-US_TOPIC_0000001460561332__b1012220484212">DELETE</strong>, and <strong id="EN-US_TOPIC_0000001460561332__b189931351426">INSERT </strong>statements can be executed only by the initial user in in-place upgrade mode or by the administrator in redistribution mode. The number of records modified by the statements on each instance must be the same. Otherwise, an error will be reported during statement execution. The function outputs a column of values of the bigint type. These values indicate the number of records operated by the statement on each instance.<pre class="screen" id="EN-US_TOPIC_0000001460561332__screen675015481979">SELECT * FROM pgxc_parallel_query('cn', 'UPDATE pg_partition SET relpages = 0') AS (updated bigint);</pre>
</li></ul>
</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section114087421272"><h4 class="sectiontitle">create_wdr_snapshot()</h4><p id="EN-US_TOPIC_0000001460561332__p840817427710">Description: Creates a performance data snapshot.</p>
<p id="EN-US_TOPIC_0000001460561332__p114083424711">Return type: text</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note440816420716"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul13408142376"><li id="EN-US_TOPIC_0000001460561332__li164085421678">Only the database administrator <strong id="EN-US_TOPIC_0000001460561332__b1187911487583">SYSADMIN</strong> can execute this function.</li><li id="EN-US_TOPIC_0000001460561332__li17408194210714">This function can be executed only on CNs. If it is executed on DNs, the following message will be returned: "WDR snapshot can only be created on coordinator."</li><li id="EN-US_TOPIC_0000001460561332__li1640815421479">Before executing this function, ensure that the value of <strong id="EN-US_TOPIC_0000001460561332__b74087391827">enable_wdr_snapshot</strong> is <strong id="EN-US_TOPIC_0000001460561332__b550410579216">on</strong>. If its value is <strong id="EN-US_TOPIC_0000001460561332__b19354223313">off</strong>, the following message will be returned for this function: "WDR snapshot request cannot be executed, because GUC parameter 'enable_wdr_snapshot' is off."</li><li id="EN-US_TOPIC_0000001460561332__li174081442371">If the snapshot thread is not started for some reason, for example, the node is restarted, the following message will be returned for this function: "WDR snapshot request cannot be accepted, please retry later."</li><li id="EN-US_TOPIC_0000001460561332__li740818421273">If this function fails to be executed, the following message will be returned: "Cannot respond to WDR snapshot request."</li><li id="EN-US_TOPIC_0000001460561332__li140864214716">If this function is successfully executed, the following message will be returned: "WDR snapshot request has been submitted." This message indicates that the snapshot creation request has been sent to the background snapshot thread, but does not mean that the snapshot has been successfully created.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section9559183714713"><h4 class="sectiontitle">kill_snapshot(scope cstring)</h4><p id="EN-US_TOPIC_0000001460561332__p455883716712">Description: kills the background snapshot thread. This function sends a command to the background snapshot thread and waits for the thread to stop.</p>
<p id="EN-US_TOPIC_0000001460561332__p135582037874">The input parameter <strong id="EN-US_TOPIC_0000001460561332__b1077910311420">scope</strong> indicates the operation scope. Its value can be <strong id="EN-US_TOPIC_0000001460561332__b19772161218220">local</strong> or <strong id="EN-US_TOPIC_0000001460561332__b86371498224">global</strong>.</p>
<ul id="EN-US_TOPIC_0000001460561332__ul135592037376"><li id="EN-US_TOPIC_0000001460561332__li16558123712720">Value <strong id="EN-US_TOPIC_0000001460561332__b1540132612213">local</strong> indicates killing the snapshot thread on the current CN.</li><li id="EN-US_TOPIC_0000001460561332__li14558537778">Value <strong id="EN-US_TOPIC_0000001460561332__b10118438248">global</strong> indicates killing the snapshot thread on the current CN as well as those on all the other CNs in the cluster.</li><li id="EN-US_TOPIC_0000001460561332__li85581337873">If any other value is passed, error message "Scope is invalid, use "local" or "global"." is displayed.</li><li id="EN-US_TOPIC_0000001460561332__li25598371675">The input parameter can be left empty, in which case the default value <strong id="EN-US_TOPIC_0000001460561332__b8712104033017">local</strong> will be used.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p10559103719720">Return type: none</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note855993719712"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul155596377717"><li id="EN-US_TOPIC_0000001460561332__li355963714717">Only the database administrator <strong id="EN-US_TOPIC_0000001460561332__b1931472043219">SYSADMIN</strong> can execute this function.</li><li id="EN-US_TOPIC_0000001460561332__li055915371715">This function can be executed only on CNs. If it is executed on DNs, the following message will be returned: "kill_snapshot can only be executed on coordinator."</li><li id="EN-US_TOPIC_0000001460561332__li255913715716">Executing this function sends a kill signal to the background snapshot thread and waits for it to finish. If the snapshot thread is not killed within 100s, the error message "Kill snapshot thread failed" is displayed.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section2851109373"><h4 class="sectiontitle">generate_wdr_report(begin_snap_id bigint, end_snap_id bigint, report_type cstring, report_scope cstring, node_name cstring)</h4><p id="EN-US_TOPIC_0000001460561332__p17765102012719">Description: Creates a load analysis report.</p>
<p id="EN-US_TOPIC_0000001460561332__p68498916720">The input parameters are described as follows:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul2849189576"><li id="EN-US_TOPIC_0000001460561332__li2849391074"><strong id="EN-US_TOPIC_0000001460561332__b1529233512361">begin_snap_id</strong> and <strong id="EN-US_TOPIC_0000001460561332__b423574493615">end_snap_id</strong>: IDs of the start and end snapshots, respectively. The IDs are of the bigint type. The value of <strong id="EN-US_TOPIC_0000001460561332__b3823312394">begin_snap_id</strong> must be less than that of <strong id="EN-US_TOPIC_0000001460561332__b1896311584015">end_snap_id</strong>, and the time for the start and end snapshots cannot overlap. You can check whether the snapshot time overlaps by querying <strong id="EN-US_TOPIC_0000001460561332__b16627143717529">select s1.end_ts &lt; s2.start_ts from (select * from dbms_om.snapshot where snapshot_id=$begin_snap_id) as s1, (select * from dbms_om.snapshot where snapshot_id=$end_snap_id) as s2</strong> in the <strong id="EN-US_TOPIC_0000001460561332__b1285134935218">dbms_om.snapshot</strong> table. If <strong id="EN-US_TOPIC_0000001460561332__b1054850145310">true</strong> is returned, the snapshot time does not overlap. Otherwise, the snapshot time overlaps.</li><li id="EN-US_TOPIC_0000001460561332__li138499910714"><strong id="EN-US_TOPIC_0000001460561332__b79882425411">report_type</strong>: report type. The value is a cstring and can be <strong id="EN-US_TOPIC_0000001460561332__b204341589553">summary</strong>, <strong id="EN-US_TOPIC_0000001460561332__b1593821465518">detail</strong>, or <strong id="EN-US_TOPIC_0000001460561332__b10252132310559">all</strong>.</li><li id="EN-US_TOPIC_0000001460561332__li1584912917711"><strong id="EN-US_TOPIC_0000001460561332__b12156234195516">report_scope</strong>: report scope. The value is a cstring and can be <strong id="EN-US_TOPIC_0000001460561332__b15118956155519">cluster</strong> or <strong id="EN-US_TOPIC_0000001460561332__b199119216563">node</strong>.</li><li id="EN-US_TOPIC_0000001460561332__li198491093719"><strong id="EN-US_TOPIC_0000001460561332__b627011465610">node_name</strong>: node name. The value is a cstring. If <strong id="EN-US_TOPIC_0000001460561332__b1246172616579">report_scope</strong> is <strong id="EN-US_TOPIC_0000001460561332__b583873018579">node</strong>, the value of this parameter must be <strong id="EN-US_TOPIC_0000001460561332__b2016815459574">pg_catalog</strong>, which indicates the CN or DN name in the <strong id="EN-US_TOPIC_0000001460561332__b205847334516">node_name</strong> column of the <strong id="EN-US_TOPIC_0000001460561332__b45391844845">pgxc_node</strong> table.</li></ul>
<div class="p" id="EN-US_TOPIC_0000001460561332__p3851791373">Return type: text<div class="note" id="EN-US_TOPIC_0000001460561332__note17851591274"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul48511092711"><li id="EN-US_TOPIC_0000001460561332__li985013915717">Only the database administrator <strong id="EN-US_TOPIC_0000001460561332__b13697111211616">SYSADMIN</strong> can execute this function.</li><li id="EN-US_TOPIC_0000001460561332__li158506912716">This function can be executed only on CNs. If it is executed on DNs, the following message will be returned: "WDR report can only be created on coordinator."</li><li id="EN-US_TOPIC_0000001460561332__li1185129278">If the report is created successfully, message "Report %s has been generated" will be returned.</li><li id="EN-US_TOPIC_0000001460561332__li98512916717">The statistics cannot be reset between the time the start snapshot is taken and the time the end snapshot is taken. Otherwise, error message "Instance reset time is different" will be displayed. For details about the events that cause a statistics reset, see the <a href="#EN-US_TOPIC_0000001460561332__section158811598710">pgxc_node_stat_reset_time</a> function.</li></ul>
</div></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section149755675"><h4 class="sectiontitle">wdr_xdb_query(db_name text, snapshot_id bigint, view_name text)</h4><p id="EN-US_TOPIC_0000001460561332__p1895195778">Description: Queries a specified view in a specified database. The query results of some views vary depending on databases. For example, the <strong id="EN-US_TOPIC_0000001460561332__b363411177815">global_table_stat</strong> view is used to query the statistics of a table. The results of querying this view vary because tables in different databases are different. The <strong id="EN-US_TOPIC_0000001460561332__b14954195511102">wdr_xdb_query</strong> function can access the database specified by <strong id="EN-US_TOPIC_0000001460561332__b13690155141111">db_name</strong> in the current connection and query the view specified by <strong id="EN-US_TOPIC_0000001460561332__b797851610119">view_name</strong> in the database. The input parameters are described as follows:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul11979516716"><li id="EN-US_TOPIC_0000001460561332__li3951953717"><strong id="EN-US_TOPIC_0000001460561332__b5771928191110">db_name</strong>: specifies the name of a database. The value is of the text type.</li><li id="EN-US_TOPIC_0000001460561332__li79613516710"><strong id="EN-US_TOPIC_0000001460561332__b1746054591114">snapshot_id</strong>: specifies the snapshot ID. The value is of the bigint type. For details, see "Performance View Snapshot".</li><li id="EN-US_TOPIC_0000001460561332__li597552715"><strong id="EN-US_TOPIC_0000001460561332__b1527163221319">view_name</strong>: specifies the name of a view. The value is of the text type. The view name must be in the following whitelist:<ul id="EN-US_TOPIC_0000001460561332__ul11971657713"><li id="EN-US_TOPIC_0000001460561332__li19960520717">global_table_stat</li><li id="EN-US_TOPIC_0000001460561332__li2096451479">global_table_change_stat</li><li id="EN-US_TOPIC_0000001460561332__li59614513719">global_column_table_io_stat</li><li id="EN-US_TOPIC_0000001460561332__li5971251676">global_row_table_io_stat<p id="EN-US_TOPIC_0000001460561332__p796751575"><a name="EN-US_TOPIC_0000001460561332__li5971251676"></a><a name="li5971251676"></a>The return value type is record. The first column is <strong id="EN-US_TOPIC_0000001460561332__b1111421911142">snapshot_id bigint</strong>, and the second column is <strong id="EN-US_TOPIC_0000001460561332__b159637239140">db_name text</strong>. The names, types, and sequences of other columns are the same as those of the views specified by <strong id="EN-US_TOPIC_0000001460561332__b960312398145">view_name</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p4550115721914">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen208975419206"><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">select</span><span class="w"> </span><span class="n">snapshot_id</span><span class="p">,</span><span class="w"> </span><span class="n">db_name</span><span class="p">,</span><span class="w"> </span><span class="n">schemaname</span><span class="p">,</span><span class="w"> </span><span class="n">relname</span><span class="p">,</span><span class="w"> </span><span class="n">distribute_mode</span><span class="p">,</span><span class="w"> </span><span class="n">seq_scan</span><span class="w"> </span><span class="p">,</span><span class="n">seq_tuple_read</span><span class="w"> </span><span class="p">,</span><span class="n">index_scan</span><span class="w"> </span><span class="p">,</span><span class="n">index_tuple_read</span><span class="w"> </span><span class="p">,</span><span class="n">tuple_inserted</span>
<span class="p">,</span><span class="n">tuple_updated</span><span class="w"> </span><span class="p">,</span><span class="n">tuple_deleted</span><span class="w"> </span><span class="p">,</span><span class="n">tuple_hot_updated</span><span class="w"> </span><span class="p">,</span><span class="n">live_tuples</span><span class="w"> </span><span class="p">,</span><span class="n">dead_tuples</span><span class="w"> </span><span class="k">from</span><span class="w"> </span><span class="n">wdr_xdb_query</span><span class="p">(</span><span class="s1">'postgres'</span><span class="p">::</span><span class="nb">text</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="s1">'global_table_stat'</span><span class="p">::</span><span class="nb">text</span><span class="p">)</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="n">i</span><span class="p">(</span><span class="n">snapshot_id</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">db_name</span><span class="w"> </span><span class="nb">text</span><span class="p">,</span><span class="w"> </span><span class="n">schemaname</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">relname</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">distribute_mode</span><span class="w"> </span><span class="nb">char</span><span class="p">,</span><span class="w"> </span><span class="n">seq_scan</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">seq_tuple_read</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">index_scan</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">index_tuple_read</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">tuple_inserted</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">tuple_updated</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">tuplee_deleted</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">tuple_hot_updated</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">live_tuples</span><span class="w"> </span><span class="nb">bigint</span><span class="p">,</span><span class="w"> </span><span class="n">dead_tuples</span><span class="w"> </span><span class="nb">bigint</span><span class="p">);</span>
</pre></div></td></tr></table></div>
</div>
<div class="note" id="EN-US_TOPIC_0000001460561332__note18971555714"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul18971955715"><li id="EN-US_TOPIC_0000001460561332__li1997251677">This function is supported only in 8.1.2 or later.</li><li id="EN-US_TOPIC_0000001460561332__li1697351276">Only the database administrator <strong id="EN-US_TOPIC_0000001460561332__b1895557872">SYSADMIN</strong> can execute this function.</li><li id="EN-US_TOPIC_0000001460561332__li1897951712">This function can be used to query only the views in the whitelist. If you use this function to query other views, the error message <strong id="EN-US_TOPIC_0000001460561332__b19904285165">Input view name is invalid.</strong> will be displayed.</li></ul>
</div></div>
</li></ul>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section577143555910"><h4 class="sectiontitle">vac_fileclear_relation(oid)</h4><p id="EN-US_TOPIC_0000001460561332__p777133555914">Description: Forcibly clears VACUUM rewritten files in a specified column-store table to reclaim space.</p>
<p id="EN-US_TOPIC_0000001460561332__p67711135135915">Parameter: OID of a column-store table.</p>
<p id="EN-US_TOPIC_0000001460561332__p107718350591">Return type: integer</p>
<div class="note" id="EN-US_TOPIC_0000001460561332__note1777163595914"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001460561332__ul1477173585912"><li id="EN-US_TOPIC_0000001460561332__li1277163513597">Before using this function, set <strong id="EN-US_TOPIC_0000001460561332__b165332050105110">colvacuum_threshold_scale_factor</strong> and ensure that the files are cleared and space reclaimed only after the VACUUM process has rewritten the files of the specified column-store table. </li><li id="EN-US_TOPIC_0000001460561332__li1077163505916">This function exclusively locks a specified column-store table.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section2399332165920"><h4 class="sectiontitle">vac_fileclear_all_relation()</h4><p id="EN-US_TOPIC_0000001460561332__p15399143295915">Description: Forcibly clears VACUUM rewritten files in all specified column-store tables to reclaim space.</p>
<p id="EN-US_TOPIC_0000001460561332__p11399183218598">Return type: record</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section181913301599"><h4 class="sectiontitle">get_col_file_info(table_name)</h4><p id="EN-US_TOPIC_0000001460561332__p1319043013598">Description: Queries the number of empty CU files and the total number of CU files in a specified column-store table. This function is supported only in cluster 8.2.0 and later versions.</p>
<p id="EN-US_TOPIC_0000001460561332__p101901030175918">Parameter: Name of a column-store table.</p>
<p id="EN-US_TOPIC_0000001460561332__p31908304594">Return type: int</p>
<p id="EN-US_TOPIC_0000001460561332__p4190930115914">Fields in the returned value:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul9190163065912"><li id="EN-US_TOPIC_0000001460561332__li1819019303599"><strong id="EN-US_TOPIC_0000001460561332__b196120371991">total_file_num int</strong>: total number of CU files. The value ranges from <strong id="EN-US_TOPIC_0000001460561332__b152905504914">-1</strong> to <strong id="EN-US_TOPIC_0000001460561332__b2021415541093">INT_MAX</strong>. <strong id="EN-US_TOPIC_0000001460561332__b12428131914105">-1</strong> indicates a failure, which could be caused by unsupported table types. The values in the range <strong id="EN-US_TOPIC_0000001460561332__b1229515526117">0</strong> to <strong id="EN-US_TOPIC_0000001460561332__b206001255101111">INT_MAX</strong> indicates the total number of files.</li><li id="EN-US_TOPIC_0000001460561332__li19190143018592"><strong id="EN-US_TOPIC_0000001460561332__b13171161311154">empty_file_num int</strong>: number of empty CU files. The value ranges from <strong id="EN-US_TOPIC_0000001460561332__b458923114153">-1</strong> to <strong id="EN-US_TOPIC_0000001460561332__b11701535191512">INT_MAX</strong>. <strong id="EN-US_TOPIC_0000001460561332__b25712111167">-1</strong> indicates a failure, which could be caused by unsupported table types. The values in the range <strong id="EN-US_TOPIC_0000001460561332__b142137233167">0</strong> to <strong id="EN-US_TOPIC_0000001460561332__b173241327131619">INT_MAX</strong> indicates the total number of empty files.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p1619083015915">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen1719153065919"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">call</span><span class="w"> </span><span class="n">get_col_file_info</span><span class="p">(</span><span class="s1">'t4'</span><span class="p">);</span>
<span class="w"> </span><span class="n">total_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">empty_file_num</span>
<span class="c1">----------------+----------------</span>
<span class="w"> </span><span class="mi">10</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">7</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section10826324195914"><h4 class="sectiontitle">get_all_col_file_info()</h4><p id="EN-US_TOPIC_0000001460561332__p208252024125914">Description: Queries the number of empty CU files and the total number of CU files in all column-store tables. This function is supported only in cluster 8.2.0 and later versions.</p>
<p id="EN-US_TOPIC_0000001460561332__p1482516249593">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p1682572465911">Fields in the returned value:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul0826624155918"><li id="EN-US_TOPIC_0000001460561332__li2826132414596"><strong id="EN-US_TOPIC_0000001460561332__b16629410171717">space_name text</strong>: schema to which the column-store tables belong</li><li id="EN-US_TOPIC_0000001460561332__li8826122417599"><strong id="EN-US_TOPIC_0000001460561332__b047625210177">table_name text</strong>: name of a column-store table</li><li id="EN-US_TOPIC_0000001460561332__li28263248591"><strong id="EN-US_TOPIC_0000001460561332__b13138878198">total_file_num int</strong>: total number of CU files. The value ranges from <strong id="EN-US_TOPIC_0000001460561332__b121391977197">-1</strong> to <strong id="EN-US_TOPIC_0000001460561332__b1414057181916">INT_MAX</strong>. <strong id="EN-US_TOPIC_0000001460561332__b414110791918">-1</strong> indicates a failure, which could be caused by unsupported table types. The values in the range <strong id="EN-US_TOPIC_0000001460561332__b814211731917">0</strong> to <strong id="EN-US_TOPIC_0000001460561332__b21429718196">INT_MAX</strong> indicates the total number of files.</li><li id="EN-US_TOPIC_0000001460561332__li3826202412594"><strong id="EN-US_TOPIC_0000001460561332__b993332587">empty_file_num int</strong>: number of empty CU files. The value ranges from <strong id="EN-US_TOPIC_0000001460561332__b1891324916">-1</strong> to <strong id="EN-US_TOPIC_0000001460561332__b240246891">INT_MAX</strong>. <strong id="EN-US_TOPIC_0000001460561332__b242864337">-1</strong> indicates a failure, which could be caused by unsupported table types. The values in the range <strong id="EN-US_TOPIC_0000001460561332__b1362287801">0</strong> to <strong id="EN-US_TOPIC_0000001460561332__b1941070547">INT_MAX</strong> indicates the total number of empty files.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p17826102411590">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen58264241593"><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="k">call</span><span class="w"> </span><span class="n">get_all_col_file_info</span><span class="p">();</span>
<span class="w"> </span><span class="n">space_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">table_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">empty_file_num</span>
<span class="c1">------------+------------+----------------+----------------</span>
<span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t4</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">7</span>
<span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="p">(</span><span class="mi">3</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section82051913115917"><h4 class="sectiontitle">get_volatile_pg_class()</h4><p id="EN-US_TOPIC_0000001460561332__p13204013145918">Description: Obtains the <strong id="EN-US_TOPIC_0000001460561332__b3818098431">pg_class</strong> metadata related to all volatile temporary tables in the current session. This parameter is supported by version 8.2.0 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p4204513155914">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p17204131313599">Fields in the returned value:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul1220551305912"><li id="EN-US_TOPIC_0000001460561332__li1220515137595"><strong id="EN-US_TOPIC_0000001460561332__b51520164412">oid</strong>: OID of the volatile temporary table.</li><li id="EN-US_TOPIC_0000001460561332__li9205151345910">Other fields: same as the fields (excluding hidden fields) in the <strong id="EN-US_TOPIC_0000001460561332__b98783398444">pg_class system</strong> catalog.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section19526298595"><h4 class="sectiontitle">get_volatile_pg_class(relname text)</h4><p id="EN-US_TOPIC_0000001460561332__p352615912591">Description: Obtains the <strong id="EN-US_TOPIC_0000001460561332__b1586718064510">pg_class</strong> metadata related to a specified volatile temporary table in the current session. This parameter is supported by version 8.2.0 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p125264985914">Parameter: name of the volatile temporary table in the current session.</p>
<p id="EN-US_TOPIC_0000001460561332__p25261294590">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p12526594598">Fields in the returned value:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul1852613910596"><li id="EN-US_TOPIC_0000001460561332__li75261791595"><strong id="EN-US_TOPIC_0000001460561332__b1322833937">oid</strong>: OID of the volatile temporary table.</li><li id="EN-US_TOPIC_0000001460561332__li752659135913">Other fields: same as the fields (excluding hidden fields) in the <strong id="EN-US_TOPIC_0000001460561332__b593910151468">pg_class system</strong> catalog.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p1952617917593">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen15269945915"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_volatile_pg_class</span><span class="p">(</span><span class="s1">'tx1'</span><span class="p">);</span>
<span class="w"> </span><span class="n">oid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relname</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relnamespace</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reltype</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reloftype</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relowner</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relam</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relfilenode</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reltablespace</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relpages</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reltuples</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relallvisible</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reltoastrelid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reltoastidxid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reldeltarelid</span><span class="w"> </span><span class="o">|</span>
<span class="w"> </span><span class="n">reldeltaidx</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relcudescrelid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relcudescidx</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhasindex</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relisshared</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relpersistence</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relkind</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relnatts</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relchecks</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhasoids</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhaspkey</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhasrules</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhastriggers</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhassub</span>
<span class="k">class</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relcmprs</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relhasclusterkey</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relrowmovement</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">parttype</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relfrozenxid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relacl</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">reloptions</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relreplident</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">relfrozenxid64</span>
<span class="c1">-------+---------+--------------+---------+-----------+----------+-------+-------------+---------------+----------+-----------+---------------+---------------+---------------+---------------+</span>
<span class="c1">-------------+----------------+--------------+-------------+-------------+----------------+---------+----------+-----------+------------+------------+-------------+----------------+----------</span>
<span class="c1">------+----------+------------------+----------------+----------+--------------+--------+----------------------------------+--------------+----------------</span>
<span class="w"> </span><span class="mi">16772</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tx1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">16770</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">16774</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">16772</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1665</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">16775</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span>
<span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">v</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">r</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span>
<span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">n</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">11815</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="err">{</span><span class="n">orientation</span><span class="o">=</span><span class="k">row</span><span class="p">,</span><span class="n">compression</span><span class="o">=</span><span class="k">no</span><span class="err">}</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">d</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">11815</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section89097537586"><h4 class="sectiontitle">get_volatile_pg_attribute()</h4><p id="EN-US_TOPIC_0000001460561332__p1890865320585">Description: Obtains the <strong id="EN-US_TOPIC_0000001460561332__b197865285468">pg_attribute</strong> metadata related to all volatile temporary tables in the current session. This parameter is supported by version 8.2.0 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p18908135395815">Return type: record</p>
<div class="p" id="EN-US_TOPIC_0000001460561332__p3909185310589">Fields in the returned value:<ul id="EN-US_TOPIC_0000001460561332__ul39081753125813"><li id="EN-US_TOPIC_0000001460561332__li4908115311585"><strong id="EN-US_TOPIC_0000001460561332__b197004718590">oid</strong>: OID of the column.</li><li id="EN-US_TOPIC_0000001460561332__li890865305818">Other fields: same as the fields (excluding hidden fields) in the <strong id="EN-US_TOPIC_0000001460561332__b8373216165910">pg_attribute</strong> catalog.</li></ul>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1240101775811"><h4 class="sectiontitle">get_volatile_pg_attribute(relname text, attrname text)</h4><p id="EN-US_TOPIC_0000001460561332__p182391171580">Description: Obtains the <strong id="EN-US_TOPIC_0000001460561332__b157688315482">pg_attribute</strong> metadata related to a specified volatile temporary table in the current session. This parameter is supported by version 8.2.0 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p123961718587">Parameter:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul1223981712584"><li id="EN-US_TOPIC_0000001460561332__li123991715582"><strong id="EN-US_TOPIC_0000001460561332__b17800123384817">relname</strong>: table name (must be in the current session).</li><li id="EN-US_TOPIC_0000001460561332__li8239317125820"><strong id="EN-US_TOPIC_0000001460561332__b7727735174815">attrname</strong>: column name.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p11239717195814">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p162391917185813">Fields in the returned value:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul112397176580"><li id="EN-US_TOPIC_0000001460561332__li19239111725818"><strong id="EN-US_TOPIC_0000001460561332__b458812298595">oid</strong>: OID of the column.</li><li id="EN-US_TOPIC_0000001460561332__li13239181720584">Other fields: same as the fields (excluding hidden fields) in the <strong id="EN-US_TOPIC_0000001460561332__b1276193113595">pg_attribute</strong> catalog.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p2239111711585">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen162394176581"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_volatile_pg_attribute</span><span class="p">(</span><span class="s1">'tx1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'b'</span><span class="p">);</span>
<span class="w"> </span><span class="n">attrelid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attname</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">atttypid</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attstattarget</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attlen</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attnum</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attndims</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attcacheoff</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">atttypmod</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attbyval</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attstorage</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attalign</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attnotnull</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">atthasdef</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attisdropped</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attislocal</span><span class="w"> </span><span class="o">|</span>
<span class="w"> </span><span class="n">attcmprmode</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attinhcount</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attcollation</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attacl</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attoptions</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attfdwoptions</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attinitdefval</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">attkvtype</span>
<span class="c1">----------+---------+----------+---------------+--------+--------+----------+-------------+-----------+----------+------------+----------+------------+-----------+--------------+------------+</span>
<span class="c1">-------------+-------------+--------------+--------+------------+---------------+---------------+-----------</span>
<span class="w"> </span><span class="mi">16772</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">b</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">25</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">i</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="o">|</span>
<span class="w"> </span><span class="mi">127</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">100</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1613041035811"><h4 class="sectiontitle">pg_get_publication_tables(pubname text)</h4><p id="EN-US_TOPIC_0000001460561332__p512611105582">Description: Returns the relid list of tables to be published based on the publication name. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p1012631025811">Parameter: <strong id="EN-US_TOPIC_0000001460561332__b71751312939">pubname</strong></p>
<p id="EN-US_TOPIC_0000001460561332__p3126210155814">Return type: set of OID</p>
<p id="EN-US_TOPIC_0000001460561332__p16126141085820">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen161301310135814"><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="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">pg_get_publication_tables</span><span class="p">(</span><span class="s1">'mypub'</span><span class="p">);</span>
<span class="w"> </span><span class="n">relid</span><span class="w"> </span>
<span class="c1">-------</span>
<span class="w"> </span><span class="mi">16757</span>
<span class="w"> </span><span class="mi">16776</span>
<span class="p">(</span><span class="mi">2</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section178569587"><h4 class="sectiontitle">pg_relation_is_publishable(relname regclass)</h4><p id="EN-US_TOPIC_0000001460561332__p1777168583">Description: Checks whether a table can be published. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p16773635813">Parameter: <strong id="EN-US_TOPIC_0000001460561332__b14516755551">relname</strong></p>
<p id="EN-US_TOPIC_0000001460561332__p277166588">Return type: Boolean</p>
<p id="EN-US_TOPIC_0000001460561332__p77717614583">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen107819612583"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">pg_relation_is_publishable</span><span class="p">(</span><span class="s1">'t1'</span><span class="p">);</span>
<span class="w"> </span><span class="n">pg_relation_is_publishable</span><span class="w"> </span>
<span class="c1">----------------------------</span>
<span class="w"> </span><span class="n">t</span>
<span class="p">(</span><span class="mi">1</span><span class="w"> </span><span class="k">row</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section3484175417575"><h4 class="sectiontitle">get_col_cu_info(schema_name text, table_name text, row_count int8, dirty_percent int8)</h4><p id="EN-US_TOPIC_0000001460561332__p248355455716">Description: Queries the CU information of a column-store table. The CU information of each partition is collected separately. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p9483165412572">Parameters: schema name (mandatory), table name (mandatory), threshold for the number of rows in a small CU (optional, 200 by default, ranging from 1 to 60000, and percentage threshold for deleting dirty CUs (optional, 70 by default, ranging from 1 to 100)</p>
<p id="EN-US_TOPIC_0000001460561332__p204831541575">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p748325415573">Fields in the returned value:</p>
<p id="EN-US_TOPIC_0000001460561332__p0483125415714"><strong id="EN-US_TOPIC_0000001460561332__b12630424587">node_name</strong>: DN name.</p>
<p id="EN-US_TOPIC_0000001460561332__p11483175445712"><strong id="EN-US_TOPIC_0000001460561332__b129360331817">part_name</strong>: partition name. This column is empty for a common table.</p>
<p id="EN-US_TOPIC_0000001460561332__p648315411575"><strong id="EN-US_TOPIC_0000001460561332__b19581050385">zero_size_cu_count</strong>: number of CUs whose <strong id="EN-US_TOPIC_0000001460561332__b1743855714813">cuSize</strong> is <strong id="EN-US_TOPIC_0000001460561332__b0222175914815">0</strong> and number of rows is less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b104703815914">row_count</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p648325419572"><strong id="EN-US_TOPIC_0000001460561332__b19519837996">small_cu_count</strong>: number of CUs whose <strong id="EN-US_TOPIC_0000001460561332__b1489810551694">cuSize</strong> is <strong id="EN-US_TOPIC_0000001460561332__b172613281016">ALIGNOF_CUSIZE(8192)</strong> and number of rows is less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b2825101431017">row_count</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p15170165116812"><strong id="EN-US_TOPIC_0000001460561332__b62611942165018">dirty_cu_count</strong>: number of CUs whose deadtupe percentage exceeds <strong id="EN-US_TOPIC_0000001460561332__b677311152518">dirty_percent</strong> due to deletion.</p>
<p id="EN-US_TOPIC_0000001460561332__p15483154205710"><strong id="EN-US_TOPIC_0000001460561332__b148478610116">total_cu_count</strong>: total number of CUs.</p>
<p id="EN-US_TOPIC_0000001460561332__p1848345495720"><strong id="EN-US_TOPIC_0000001460561332__b1533414471909">small_cu_size</strong>: total size of 8 KB CUs.</p>
<p id="EN-US_TOPIC_0000001460561332__p1948317542571"><strong id="EN-US_TOPIC_0000001460561332__b33411651141110">total_cu_size</strong>: total CU size.</p>
<p id="EN-US_TOPIC_0000001460561332__p15483105413573">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen4484115445713"><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>
<span class="normal">14</span>
<span class="normal">15</span></pre></div></td><td class="code"><div><pre><span></span><span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_col_cu_info</span><span class="p">(</span><span class="s1">'public'</span><span class="p">,</span><span class="s1">'hs_part'</span><span class="p">);</span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">part_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">zero_size_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">small_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">dirty_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">small_cu_size</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_cu_size</span>
<span class="c1">-----------+-----------+--------------------+----------------+----------------+----------------+---------------+---------------</span>
<span class="w"> </span><span class="n">dn_1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">p1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">dn_1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">p2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">dn_1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">p3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span>
<span class="p">(</span><span class="mi">3</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
<span class="w"> </span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_col_cu_info</span><span class="p">(</span><span class="s1">'public'</span><span class="p">,</span><span class="s1">'hs_part'</span><span class="p">,</span><span class="w"> </span><span class="mi">200</span><span class="p">,</span><span class="w"> </span><span class="mi">90</span><span class="p">);</span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">part_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">zero_size_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">small_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">dirty_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">small_cu_size</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_cu_size</span>
<span class="c1">-----------+-----------+--------------------+----------------+----------------+----------------+---------------+---------------</span>
<span class="w"> </span><span class="n">dn_1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">p1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">dn_1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">p2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">dn_1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">p3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="n">bytes</span>
<span class="p">(</span><span class="mi">3</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section116411945155715"><h4 class="sectiontitle">get_col_file_vacuum_info(schema_name text, table_name text, force_get_rewritten_file_num bool)</h4><p id="EN-US_TOPIC_0000001460561332__p20640184516571">Description: Queries the vacuum information of a column-store table. The vacuum information of each partition is collected separately. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p1164094513575">Parameters: schema name (mandatory), table name (mandatory), and whether to forcibly obtain the precise number of files that can be cleared (mandatory, <strong id="EN-US_TOPIC_0000001460561332__b4247132195116">false</strong> by default)</p>
<p id="EN-US_TOPIC_0000001460561332__p3640145155711">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p18640114510578">Fields in the returned value:</p>
<p id="EN-US_TOPIC_0000001460561332__p1764104518574"><strong id="EN-US_TOPIC_0000001460561332__b26229191318">node_name</strong>: DN name.</p>
<p id="EN-US_TOPIC_0000001460561332__p20641144565712"><strong id="EN-US_TOPIC_0000001460561332__b4927183171313">part_name</strong>: partition name. This column is empty for a common table.</p>
<p id="EN-US_TOPIC_0000001460561332__p564124518577"><strong id="EN-US_TOPIC_0000001460561332__b179171892134">total_file_num</strong>: total number of CU files.</p>
<p id="EN-US_TOPIC_0000001460561332__p3641164585718"><strong id="EN-US_TOPIC_0000001460561332__b20850151681316">rewritable_file_num</strong>: number of files that can be rewritten but have not been rewritten.</p>
<p id="EN-US_TOPIC_0000001460561332__p136418456576"><strong id="EN-US_TOPIC_0000001460561332__b13316195171511">rewritten_file_num</strong>: number of files that have been rewritten but have not been cleared. The value is obtained from data in the memory. If the memory data is lost due to reasons such as restart, you can set <strong id="EN-US_TOPIC_0000001460561332__b1131616512153">force_get_rewritten_file_num=true</strong> to forcibly obtain the accurate number of files that can be cleared.</p>
<p id="EN-US_TOPIC_0000001460561332__p20641164575711"><strong id="EN-US_TOPIC_0000001460561332__b168161153189">empty_file_num</strong>: number of cleared files.</p>
<p id="EN-US_TOPIC_0000001460561332__p86411345135716">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen9641845115715"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_col_file_vacuum_info</span><span class="p">(</span><span class="s1">'public'</span><span class="p">,</span><span class="s1">'pa'</span><span class="p">,</span><span class="k">false</span><span class="p">);</span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">part_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">rewritable_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">rewritten_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">empty_file_num</span>
<span class="c1">-----------+-----------+----------------+---------------------+--------------------+----------------</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="p">(</span><span class="mi">6</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1665043214136"><h4 class="sectiontitle">get_col_file_vacuum_info(schema_name text, table_name text, colvacuum_threshold_scale_factor int)</h4><p id="EN-US_TOPIC_0000001460561332__p1765016321136">Description: Queries the vacuum information of a column-store table. The vacuum information of each partition is collected separately. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p10650133213131">Parameters: schema name (mandatory), table name (mandatory), and <strong id="EN-US_TOPIC_0000001460561332__b1803412894103810">colvacuum_threshold_scale_factor</strong> (mandatory. The value range is 0 to 100, indicating the ratio of dead tuples.)</p>
<p id="EN-US_TOPIC_0000001460561332__p116501932151310">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p1765063219138">Return value:</p>
<p id="EN-US_TOPIC_0000001460561332__p2065023291313"><strong id="EN-US_TOPIC_0000001460561332__b851004506">node_name</strong>: DN name.</p>
<p id="EN-US_TOPIC_0000001460561332__p1650183217138"><strong id="EN-US_TOPIC_0000001460561332__b986451579">part_name</strong>: partition name. This column is empty for a common table.</p>
<p id="EN-US_TOPIC_0000001460561332__p865093201313"><strong id="EN-US_TOPIC_0000001460561332__b380593222">total_file_num</strong>: total number of CU files.</p>
<p id="EN-US_TOPIC_0000001460561332__p13650632121314"><strong id="EN-US_TOPIC_0000001460561332__b1602619004">rewritable_file_num</strong>: number of files that can be rewritten but have not been rewritten.</p>
<p id="EN-US_TOPIC_0000001460561332__p165053218137"><strong id="EN-US_TOPIC_0000001460561332__b1044403172">rewritten_file_num</strong>: number of files that have been rewritten but have not been cleared. The value is obtained from data in the memory. If the memory data is lost due to reasons such as restart, you can set <strong id="EN-US_TOPIC_0000001460561332__b1287940414">force_get_rewritten_file_num=true</strong> to forcibly obtain the accurate number of files that can be cleared.</p>
<p id="EN-US_TOPIC_0000001460561332__p126506324132"><strong id="EN-US_TOPIC_0000001460561332__b976717024">empty_file_num</strong>: number of cleared files.</p>
<p id="EN-US_TOPIC_0000001460561332__p1765017328135">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen11650432181310"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_col_file_vacuum_info</span><span class="p">(</span><span class="s1">'public'</span><span class="p">,</span><span class="s1">'pa'</span><span class="p">,</span><span class="mi">10</span><span class="p">);</span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">part_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">rewritable_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">rewritten_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">empty_file_num</span>
<span class="c1">-----------+-----------+----------------+---------------------+--------------------+----------------</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">pa2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span>
<span class="p">(</span><span class="mi">6</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section510403011556"><h4 class="sectiontitle">get_all_col_cu_info(row_count int8)</h4><p id="EN-US_TOPIC_0000001460561332__p1910353012556">Description: Queries the CU information of all column-store tables in the database. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p3103530185520">Parameter: threshold for the number of rows in a small CU (optional, <strong id="EN-US_TOPIC_0000001460561332__b03716215194">200</strong> by default, and ranging from <strong id="EN-US_TOPIC_0000001460561332__b204931214111919">1</strong> to <strong id="EN-US_TOPIC_0000001460561332__b250911541912">60000</strong>)</p>
<p id="EN-US_TOPIC_0000001460561332__p9103730145520">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p1610343015555">Fields in the returned value:</p>
<p id="EN-US_TOPIC_0000001460561332__p19104113019550"><strong id="EN-US_TOPIC_0000001460561332__b679173317194">node_name</strong>: DN name.</p>
<p id="EN-US_TOPIC_0000001460561332__p17104123075517"><strong id="EN-US_TOPIC_0000001460561332__b13416153514194">schema_name</strong>: schema name.</p>
<p id="EN-US_TOPIC_0000001460561332__p4104123017552"><strong id="EN-US_TOPIC_0000001460561332__b5348114661911">table_name</strong>: table name.</p>
<p id="EN-US_TOPIC_0000001460561332__p2104330175515"><strong id="EN-US_TOPIC_0000001460561332__b767015019197">zero_size_cu_count</strong>: number of CUs whose <strong id="EN-US_TOPIC_0000001460561332__b6670750201917">cuSize</strong> is <strong id="EN-US_TOPIC_0000001460561332__b166701350191914">0</strong> and number of rows is less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b13670950121918">row_count</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p31046304550"><strong id="EN-US_TOPIC_0000001460561332__b1456105313195">small_cu_count</strong>: number of CUs whose <strong id="EN-US_TOPIC_0000001460561332__b257653121912">cuSize</strong> is <strong id="EN-US_TOPIC_0000001460561332__b1957853101914">ALIGNOF_CUSIZE(8192)</strong> and number of rows is less than or equal to <strong id="EN-US_TOPIC_0000001460561332__b1357125311919">row_count</strong>.</p>
<p id="EN-US_TOPIC_0000001460561332__p121041230185515"><strong id="EN-US_TOPIC_0000001460561332__b121246555194">total_cu_count</strong>: total number of CUs.</p>
<p id="EN-US_TOPIC_0000001460561332__p1410463035514"><strong id="EN-US_TOPIC_0000001460561332__b3472165715194">small_cu_size</strong>: total size of 8 KB CUs.</p>
<p id="EN-US_TOPIC_0000001460561332__p7104530155516"><strong id="EN-US_TOPIC_0000001460561332__b5685242203">total_cu_size</strong>: total CU size.</p>
<p id="EN-US_TOPIC_0000001460561332__p20104153075513">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen161041930175517"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_all_col_cu_info</span><span class="p">(</span><span class="mi">200</span><span class="p">);</span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">schema_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">table_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">zero_size_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">small_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_cu_count</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">small_cu_size</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_cu_size</span>
<span class="c1">-----------+-------------+----------------------+--------------------+----------------+----------------+---------------+---------------</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_48076</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_48077</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_48076</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_48077</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_48076</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_48077</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">8192</span><span class="w"> </span><span class="n">bytes</span>
<span class="p">(</span><span class="mi">6</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section143692216551"><h4 class="sectiontitle">get_all_col_file_vacuum_info(force_get_rewritten_file_num bool)</h4><p id="EN-US_TOPIC_0000001460561332__p4435722185517">Description: Queries the vacuum information of all column-store tables in the database. This function is supported by clusters of version 8.2.0.100 or later.</p>
<p id="EN-US_TOPIC_0000001460561332__p74351022115520">Parameter: whether to forcibly obtain the accurate number of files that can be cleared (mandatory. It can be <strong id="EN-US_TOPIC_0000001460561332__b87571232135112">true</strong> or <strong id="EN-US_TOPIC_0000001460561332__b3758832125119">false </strong>.)</p>
<p id="EN-US_TOPIC_0000001460561332__p144350227557">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p12436122212556">Fields in the returned value:</p>
<p id="EN-US_TOPIC_0000001460561332__p17436102285514"><strong id="EN-US_TOPIC_0000001460561332__b1601221132111">node_name</strong>: DN name.</p>
<p id="EN-US_TOPIC_0000001460561332__p3436152215515"><strong id="EN-US_TOPIC_0000001460561332__b1646362202110">schema_name</strong>: schema name.</p>
<p id="EN-US_TOPIC_0000001460561332__p1443620224555"><strong id="EN-US_TOPIC_0000001460561332__b070720238216">table_name</strong>: table name.</p>
<p id="EN-US_TOPIC_0000001460561332__p1436132219551"><strong id="EN-US_TOPIC_0000001460561332__b14832182432112">total_file_num</strong>: total number of CU files.</p>
<p id="EN-US_TOPIC_0000001460561332__p643612229559"><strong id="EN-US_TOPIC_0000001460561332__b171112610212">rewritable_file_num</strong>: number of files that can be rewritten but have not been rewritten.</p>
<p id="EN-US_TOPIC_0000001460561332__p4436172215557"><strong id="EN-US_TOPIC_0000001460561332__b1955442812215">rewritten_file_num</strong>: number of files that have been rewritten but have not been cleared. The value is obtained from data in the memory. If the memory data is lost due to reasons such as restart, you can set <strong id="EN-US_TOPIC_0000001460561332__b555502814214">force_get_rewritten_file_num=true</strong> to forcibly obtain the accurate number of files that can be cleared.</p>
<p id="EN-US_TOPIC_0000001460561332__p104361722185519"><strong id="EN-US_TOPIC_0000001460561332__b1216919390215">empty_file_num</strong>: number of cleared files.</p>
<p id="EN-US_TOPIC_0000001460561332__p24361322115518">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen184361222125520"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_all_col_file_vacuum_info</span><span class="p">(</span><span class="k">false</span><span class="p">);</span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">schema_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">table_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">total_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">rewritable_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">rewritten_file_num</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">empty_file_num</span>
<span class="c1">-----------+-------------+----------------------+----------------+---------------------+--------------------+----------------</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_57373</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="n">datanode1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_57374</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_57373</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="n">datanode2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_57374</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_57373</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
<span class="w"> </span><span class="n">datanode3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">udi_57374</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">0</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">1</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section135501315172310"><h4 class="sectiontitle">show_tsc_info()</h4><p id="EN-US_TOPIC_0000001460561332__p6829181052616">Description: Queries the TimeStamp-Counter (TSC) information obtained from the current database node. This function is supported by version 8.2.1 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p1582961022610">Return type: record</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001460561332__t89eb89c511f0476ca556b7cf9e573f47" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter</caption><thead align="left"><tr id="EN-US_TOPIC_0000001460561332__rcf90d39f911849bd9aa045ca72a9bed8"><th align="left" class="cellrowborder" valign="top" width="20.549999999999997%" id="mcps1.3.66.4.2.4.1.1"><p id="EN-US_TOPIC_0000001460561332__ab3c132e8a4164e8186d5db40c86d5231">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.6%" id="mcps1.3.66.4.2.4.1.2"><p id="EN-US_TOPIC_0000001460561332__aa93e8881526a47899c5de033b1112e1a">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.85%" id="mcps1.3.66.4.2.4.1.3"><p id="EN-US_TOPIC_0000001460561332__ae442ed967d5e4145a6a447d7c5b5b706">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001460561332__r122e4ae3b8984c8899b4e540a790f857"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__a6d243ea074304c6ea584645242774d09">node_name</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__ac3d9a3a10dd2416bbf1dca6dc880672f">text</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__acd0ea85380764f999ff4fe93e7f7f112">Node name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__r4ca79cb7dee04e5ea17234210dbbb35a"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__a8cc0e73f8d1f4a49bc94a476e340e8d7">tsc_mult</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__adf1deea6d3954781b3b24265e88d8c16">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__a10479abccda84b6db7d6cc81ebd4af4a">TSC conversion multiplier</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__rcb5421b05dba4323bf5ec73923a4df76"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__aaf30e8c53d404d41aef70b038b553aa8">tsc_shift</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__ae50e602ab61a42a18da34fbe7be3fee0">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__a884732086e894ceebb010ead8702079a">TSC conversion shifts</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__r0f47360d31ed4469915b1125e890d096"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__aa20df4e0af1040269c9bd06eb79a8546">tsc_frequency</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__aeb1291d5a22647c587ffbb9f4f1c28a7">float8</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__a8bdd179592cb4b248c5b6def5090edbc">TSC frequency.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1735211531516"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p15352165319110">tsc_use_freqency</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1635219536120">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p23525531812">Indicates whether to use the TSC frequency for time conversion.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1339310317215"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p339318311214">tsc_ready</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p439312312211">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p3393193226">Indicates whether the TSC frequency can be used for time conversion</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row119907592216"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p9990125910213">tsc_scalar_error_info</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p799011593210">text</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p109901459822">Error information about obtaining TSC conversion information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row2143194535"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.66.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p61431441038">tsc_freq_error_info</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.66.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1614315420311">text</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.66.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p3143349316">Error information about obtaining TSC frequency information</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="EN-US_TOPIC_0000001460561332__p2591959173119">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen7595810133813"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">show_tsc_info</span><span class="p">();</span><span class="w"> </span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_mult</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_shift</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_frequency</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_use_frequency</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_ready</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_scalar_error_info</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_freq_error_info</span>
<span class="c1">--------------+----------+-----------+---------------+-------------------+-----------+-------------------------------+---------------------</span>
<span class="w"> </span><span class="n">coordinator1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2400</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">TSC</span><span class="w"> </span><span class="n">scalar</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="k">not</span><span class="w"> </span><span class="n">initialized</span><span class="w"> </span><span class="o">|</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section16513137153817"><h4 class="sectiontitle">get_tsc_info()</h4><p id="EN-US_TOPIC_0000001460561332__p15798104818332">Description: Re-obtains the TimeStamp-Counter (TSC) information of the current database node. This function is supported by version 8.2.1 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p15799164811338">Return type: record</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001460561332__table62391018762" frame="border" border="1" rules="all"><caption><b>Table 5 </b>show_tsc_info() return columns</caption><thead align="left"><tr id="EN-US_TOPIC_0000001460561332__row1239111812613"><th align="left" class="cellrowborder" valign="top" width="20.549999999999997%" id="mcps1.3.67.4.2.4.1.1"><p id="EN-US_TOPIC_0000001460561332__p8240161815611">Column</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.6%" id="mcps1.3.67.4.2.4.1.2"><p id="EN-US_TOPIC_0000001460561332__p32407189618">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.85%" id="mcps1.3.67.4.2.4.1.3"><p id="EN-US_TOPIC_0000001460561332__p19240618562">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001460561332__row18240218865"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p024020185619">node_name</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p192401180615">text</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1224020181067">Node name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row32401318669"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p152401918569">tsc_mult</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1424014181068">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p172400182060">TSC conversion multiplier</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1024011184610"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p2240718162">tsc_shift</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p6240818966">bigint</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p142411218568">TSC conversion shifts</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row52411418969"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p924112181460">tsc_frequency</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p152411518567">float8</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p024161811611">TSC frequency</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row8241218566"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p22411618763">tsc_use_freqency</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p132411181612">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p1424119183614">Indicates whether to use the TSC frequency for time conversion.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row324116186615"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p92412018264">tsc_ready</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p32412018162">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p424113182065">Indicates whether the TSC frequency can be used for time conversion</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row1524151810613"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p1024217181168">tsc_scalar_error_info</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p92427182617">text</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p22421818062">Error information about obtaining TSC conversion information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001460561332__row32423181565"><td class="cellrowborder" valign="top" width="20.549999999999997%" headers="mcps1.3.67.4.2.4.1.1 "><p id="EN-US_TOPIC_0000001460561332__p62426187616">tsc_freq_error_info</p>
</td>
<td class="cellrowborder" valign="top" width="12.6%" headers="mcps1.3.67.4.2.4.1.2 "><p id="EN-US_TOPIC_0000001460561332__p1724212181664">text</p>
</td>
<td class="cellrowborder" valign="top" width="66.85%" headers="mcps1.3.67.4.2.4.1.3 "><p id="EN-US_TOPIC_0000001460561332__p192422018862">Error information about obtaining TSC frequency information</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<p id="EN-US_TOPIC_0000001460561332__p779974803313">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen824819588384"><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></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">get_tsc_info</span><span class="p">();</span><span class="w"> </span>
<span class="w"> </span><span class="n">node_name</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_mult</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_shift</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_frequency</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_use_frequency</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_ready</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_scalar_error_info</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">tsc_freq_error_info</span>
<span class="c1">--------------+----------+-----------+---------------+-------------------+-----------+-------------------------------+---------------------</span>
<span class="w"> </span><span class="n">coordinator1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">2400</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">t</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">TSC</span><span class="w"> </span><span class="n">scalar</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="k">not</span><span class="w"> </span><span class="n">initialized</span><span class="w"> </span><span class="o">|</span>
</pre></div></td></tr></table></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001460561332__section1147813520409"><h4 class="sectiontitle">test_tsc_info(time float8, loops int)</h4><p id="EN-US_TOPIC_0000001460561332__p192637467361">Description: Tests the accuracy of the time converted using the TimeStamp-Counter (TSC) on the current node. This function is supported by version 8.2.1 or later clusters.</p>
<p id="EN-US_TOPIC_0000001460561332__p11327165811387">The input parameters are described as follows:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul1818124695017"><li id="EN-US_TOPIC_0000001460561332__li718116469508"><strong id="EN-US_TOPIC_0000001460561332__b106211642262">time</strong>: indicates the test time difference (unit: s). The test duration must be less than or equal to 60s.</li><li id="EN-US_TOPIC_0000001460561332__li13309548185020"><strong id="EN-US_TOPIC_0000001460561332__b5454205117618">loops</strong>: indicates the number of tests. The value ranges from 1 to 10.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p32639467366">Return type: record</p>
<p id="EN-US_TOPIC_0000001460561332__p7263846193619">Fields in the returned value:</p>
<ul id="EN-US_TOPIC_0000001460561332__ul135591450195017"><li id="EN-US_TOPIC_0000001460561332__li1155975075014"><strong id="EN-US_TOPIC_0000001460561332__b1590148472">id</strong>: number of cycles.</li><li id="EN-US_TOPIC_0000001460561332__li1610285320506"><strong id="EN-US_TOPIC_0000001460561332__b1414918229713">real_time_diff</strong>: time difference obtained using <strong id="EN-US_TOPIC_0000001460561332__b61076913813">gettimeofday</strong> (unit: us).</li><li id="EN-US_TOPIC_0000001460561332__li19713551508"><strong id="EN-US_TOPIC_0000001460561332__b139568240716">est_time_scalar</strong>: time difference (unit: μs) converted using TSC conversion information.</li><li id="EN-US_TOPIC_0000001460561332__li14331457155011"><strong id="EN-US_TOPIC_0000001460561332__b17844132913716">est_time_frequency</strong>: time difference (unit: μs) converted using the TSC frequency.</li></ul>
<p id="EN-US_TOPIC_0000001460561332__p249413331417">Example:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001460561332__screen11201030174015"><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>
<span class="normal">14</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">FROM</span><span class="w"> </span><span class="n">test_tsc_info</span><span class="p">(</span><span class="mi">0</span><span class="p">.</span><span class="mi">01</span><span class="p">,</span><span class="mi">10</span><span class="p">);</span>
<span class="w"> </span><span class="n">id</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">real_time_diff</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">est_time_scalar</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="n">est_time_frequency</span>
<span class="c1">----+----------------+-----------------+--------------------</span>
<span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10057</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10056</span><span class="p">.</span><span class="mi">9</span>
<span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10057</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10057</span><span class="p">.</span><span class="mi">4816666667</span>
<span class="w"> </span><span class="mi">3</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10056</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10055</span><span class="p">.</span><span class="mi">2841666667</span>
<span class="w"> </span><span class="mi">4</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="p">.</span><span class="mi">4908333333</span>
<span class="w"> </span><span class="mi">5</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10055</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="p">.</span><span class="mi">2875</span>
<span class="w"> </span><span class="mi">6</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10055</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="p">.</span><span class="mi">7483333333</span>
<span class="w"> </span><span class="mi">7</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10055</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="p">.</span><span class="mi">4725</span>
<span class="w"> </span><span class="mi">8</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10054</span><span class="p">.</span><span class="mi">0766666667</span>
<span class="w"> </span><span class="mi">9</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10058</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10058</span><span class="p">.</span><span class="mi">1016666667</span>
<span class="w"> </span><span class="mi">10</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10057</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="mi">10056</span><span class="p">.</span><span class="mi">3733333333</span>
<span class="p">(</span><span class="mi">10</span><span class="w"> </span><span class="k">rows</span><span class="p">)</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_06_0052.html">System Administration Functions</a></div>
</div>
</div>
View Git Blame Copy Permalink