vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dws/dev/dws_04_0922.html
Lu, Huayi e6fa411af0 DWS DEV 830.201 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-05-16 07:24:04 +00:00

239 lines
64 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="EN-US_TOPIC_0000001233563121"></a><a name="EN-US_TOPIC_0000001233563121"></a>
<h1 class="topictitle1">Resource Management</h1>
<div id="body8662426"><p id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_p618513518710">If database resource usage is not controlled, concurrent tasks easily preempt resources. As a result, the OS will be overloaded and cannot respond to user tasks; or even crash and cannot provide any services to users. The <span id="EN-US_TOPIC_0000001233563121__text763749">GaussDB(DWS)</span> workload management function balances the database workload based on available resources to avoid database overloading.</p>
<div class="section" id="EN-US_TOPIC_0000001233563121__sc1692143c357427cbeadd6160010fd40"><a name="EN-US_TOPIC_0000001233563121__sc1692143c357427cbeadd6160010fd40"></a><a name="sc1692143c357427cbeadd6160010fd40"></a><h4 class="sectiontitle">use_workload_manager</h4><p id="EN-US_TOPIC_0000001233563121__a316504de19154266a6636c8d1b50369d"><strong id="EN-US_TOPIC_0000001233563121__b652788289142544">Parameter description</strong>: Specifies whether to enable the resource management function. This parameter must be applied on both CNs and DNs.</p>
<p id="EN-US_TOPIC_0000001233563121__p4716143414116"><strong id="EN-US_TOPIC_0000001233563121__b17311519203317">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__a6a4fa4df92ad45b481bac62a94474e39"><strong id="EN-US_TOPIC_0000001233563121__b118151824103315">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__u45d51c5a02724590866ccf03b1023e22"><li id="EN-US_TOPIC_0000001233563121__lf888c078ac404b47b69c195cf7048405"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b842352706152821_1">on</strong> indicates the resource management function is enabled.</li><li id="EN-US_TOPIC_0000001233563121__l3291c2651e5c4f019212d19cb7b693fd"><strong id="EN-US_TOPIC_0000001233563121__b181436343419">off</strong> indicates the resource management function is disabled.<div class="note" id="EN-US_TOPIC_0000001233563121__note2091118244406"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001233563121__ul1602153014301"><li id="EN-US_TOPIC_0000001233563121__li1602113013013">If method 2 in <a href="dws_04_0885.html#EN-US_TOPIC_0000001233563311__s8adb68393b48467a948956afaaaf8589">Setting GUC Parameters</a> is used to change the parameter value, the new value takes effect only for the threads that are started after the change. In addition, the new value does not take effect for new jobs that are executed by backend threads and reused threads. You can make the new value take effect for these threads by using <strong id="EN-US_TOPIC_0000001233563121__b10447103211135">kill session</strong> or restarting the node.</li><li id="EN-US_TOPIC_0000001233563121__li976571011338">After the value of <strong id="EN-US_TOPIC_0000001233563121__b43513563410">use_workload_manager</strong> changes from <strong id="EN-US_TOPIC_0000001233563121__b14136181811341">off</strong> to <strong id="EN-US_TOPIC_0000001233563121__b10122202118346">on</strong>, the resource management view becomes available, and you can query the storage resource usage collected in the <strong id="EN-US_TOPIC_0000001233563121__b106581334135218">off</strong> state. If there are slight errors and the storage resource usage needs to be corrected, run the following command. If data is inserted into the table during the command execution, the statistics may be inaccurate.<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001233563121__screen543292811347"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="n">gs_wlm_readjust_user_space</span><span class="p">(</span><span class="mi">0</span><span class="p">);</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div></div>
</li></ul>
<p id="EN-US_TOPIC_0000001233563121__a87e5c5017855416bb743faf01c512c3f"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b12149173155843_2">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b84235270613017">on</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s46a1cb63ed974be883cbbcf68a7278c2"><h4 class="sectiontitle">enable_perm_space</h4><p id="EN-US_TOPIC_0000001233563121__a7437a2f18290429db6b71ff0677709c1"><strong id="EN-US_TOPIC_0000001233563121__b1462576847142759">Parameter description</strong>: Specifies whether to enable the perm space function. This parameter must be applied on both CNs and DNs.</p>
<p id="EN-US_TOPIC_0000001233563121__p36931045131313"><strong id="EN-US_TOPIC_0000001233563121__b1011411208389">Type</strong>: POSTMASTER</p>
<p id="EN-US_TOPIC_0000001233563121__a960fb8db6a7241ad8fea3a9d09cbda4f"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_b1102664415112">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ua6462fa046b0460e938954882d611afa"><li id="EN-US_TOPIC_0000001233563121__l9bdf184d5ca84737be389d6ce9f74d1d"><strong id="EN-US_TOPIC_0000001233563121__b359847995">on</strong> indicates the perm space function is enabled.</li><li id="EN-US_TOPIC_0000001233563121__l6be8caa82c8647c09b2edce3e14dbcf7"><strong id="EN-US_TOPIC_0000001233563121__b4433887534714">off</strong> indicates the perm space function is disabled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_p246103015112"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967679_b2933732">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_b842352706154337">on</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section2515929121516"><h4 class="sectiontitle">space_once_adjust_num</h4><p id="EN-US_TOPIC_0000001233563121__p163971630131516"><strong id="EN-US_TOPIC_0000001233563121__b517513172019">Parameter description</strong>: In the space control and space statistics functions, specifies the threshold of the number of files processed each time during slow building and fine-grained calibration. This parameter is supported by version 8.1.3 or later clusters.</p>
<p id="EN-US_TOPIC_0000001233563121__p239714307155"><strong id="EN-US_TOPIC_0000001233563121__b168481330192819">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p439710309152"><strong id="EN-US_TOPIC_0000001233563121__b14491635162817">Value range</strong>: an integer ranging from 1 to INT_MAX</p>
<ul id="EN-US_TOPIC_0000001233563121__ul143242045223"><li id="EN-US_TOPIC_0000001233563121__li138487912216">The value <strong id="EN-US_TOPIC_0000001233563121__b17969359183511">0</strong> indicates that the slow build and fine-grained calibration functions are disabled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p203972301156"><strong id="EN-US_TOPIC_0000001233563121__b1750415402284">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b17510174018285">300</strong></p>
<div class="note" id="EN-US_TOPIC_0000001233563121__note754920241335"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001233563121__p1549122413313">The file quantity threshold affects database resources. You are advised to set the threshold to a proper value.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section26561757132014"><h4 class="sectiontitle">space_readjust_schedule</h4><p id="EN-US_TOPIC_0000001233563121__p56561657192011"><strong id="EN-US_TOPIC_0000001233563121__b585214290295">Parameter description</strong>: In the space control and space statistics functions, specifies the space error threshold for triggering automatic calibration. This parameter is supported by version 8.1.3 or later clusters.</p>
<p id="EN-US_TOPIC_0000001233563121__p136561957172013"><strong id="EN-US_TOPIC_0000001233563121__b360819418587">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p5656155713206"><strong id="EN-US_TOPIC_0000001233563121__b1415174417582">Value range</strong>: string</p>
<ul id="EN-US_TOPIC_0000001233563121__ul197030396232"><li id="EN-US_TOPIC_0000001233563121__li9703183918233"><strong id="EN-US_TOPIC_0000001233563121__b2012172135915">off </strong>indicates that the automatic calibration function is disabled.</li><li id="EN-US_TOPIC_0000001233563121__li184713482237"><strong id="EN-US_TOPIC_0000001233563121__b1281912920593">auto </strong>indicates that the automatic calibration function is enabled and the error threshold for triggering automatic calibration is <strong id="EN-US_TOPIC_0000001233563121__b571813588012">1 GB</strong>.</li><li id="EN-US_TOPIC_0000001233563121__li197031439182315"><strong id="EN-US_TOPIC_0000001233563121__b1649217141629">auto (<em id="EN-US_TOPIC_0000001233563121__i2820519421">space size</em> + K/M/G)</strong> indicates that the automatic calibration is enabled and the error threshold for triggering automatic calibration is <em id="EN-US_TOPIC_0000001233563121__i11311915247">xxx</em> KB/MB/GB (user-defined). For example, <strong id="EN-US_TOPIC_0000001233563121__b19315194917413">auto(200M)</strong> indicates that the automatic calibration is enabled and the error threshold for triggering automatic calibration is <strong id="EN-US_TOPIC_0000001233563121__b270810115512">200 MB</strong>.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p86561457102013"><strong id="EN-US_TOPIC_0000001233563121__b3610141756">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b36111941511">auto</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s7a13b0da34a74fe886bdf7671e62019b"><h4 class="sectiontitle">max_active_statements</h4><p id="EN-US_TOPIC_0000001233563121__addc805286ca74ef9a2554b470c4fae80"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b84235270617340">Parameter description</strong>: Specifies the maximum global concurrency. This parameter applies to one CN.</p>
<p id="EN-US_TOPIC_0000001233563121__a447d771bfc8d4fe4aaf11bd98cf5fed4">The database administrator changes the value of this parameter based on system resources (for example, CPU, I/O, and memory resources) so that the system fully supports the concurrency tasks and avoids too many concurrency tasks resulting in system crash.</p>
<p id="EN-US_TOPIC_0000001233563121__p16407102791018"><strong id="EN-US_TOPIC_0000001233563121__b1787012212383">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__a074267e4991b476ebb38e7061f47c80f"><strong id="EN-US_TOPIC_0000001233563121__b1333016122363">Value range</strong>: an integer ranging from –1 to INT_MAX. The values <strong id="EN-US_TOPIC_0000001233563121__b8361163317211">–1</strong> and <strong id="EN-US_TOPIC_0000001233563121__b33896379211">0</strong> indicate that the number of concurrent requests is not limited.</p>
<p id="EN-US_TOPIC_0000001233563121__a3e180989283945129914c1800c110445"><strong id="EN-US_TOPIC_0000001233563121__b109654376103">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b1852764121011">60</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__sab51422c793f40ad8958c193761edaf9"><h4 class="sectiontitle">parctl_min_cost</h4><p id="EN-US_TOPIC_0000001233563121__a15fd2f5990cc4c9c8015b21c819cfd25"><strong id="EN-US_TOPIC_0000001233563121__b7381110163815">Parameter description</strong>: Specifies the minimum estimated cost of a complex job under static resource management. Threshold for dividing simple jobs and complex jobs. A job whose estimated cost is less than the value of this parameter is a simple job, and a job whose estimated cost is larger than or equal to the value of this parameter is a complex job.</p>
<p id="EN-US_TOPIC_0000001233563121__p157803941017"><strong id="EN-US_TOPIC_0000001233563121__b1352510222389">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__aade5fd4a9a6b4ef3ba9306281eefb5a3"><strong id="EN-US_TOPIC_0000001233563121__b180196129434714">Value range</strong>: an integer ranging from –1 to INT_MAX</p>
<ul id="EN-US_TOPIC_0000001233563121__ul88941839114812"><li id="EN-US_TOPIC_0000001233563121__li9894183913480">If <strong id="EN-US_TOPIC_0000001233563121__b1279469394">parctl_min_cost</strong> is <strong id="EN-US_TOPIC_0000001233563121__b1925365043919">-1</strong>, all jobs are simple jobs.</li><li id="EN-US_TOPIC_0000001233563121__li15811942103013">Jobs whose estimated cost is less than 10 are simple jobs.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__ad3ea3b4b3e664405aa381a3078a4debc"><strong id="EN-US_TOPIC_0000001233563121__b83871373311">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b3387137203116">100000</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s8159a12f556d464abbf1acffe467b548"><h4 class="sectiontitle">cgroup_name</h4><p id="EN-US_TOPIC_0000001233563121__a6d50fdbf988d447dbf68bf86dbc6fa5b"><strong id="EN-US_TOPIC_0000001233563121__a522d727b6be540ffb963a801b2f48052">Parameter description</strong>: Specifies the name of the Cgroup in use. It can be used to change the priorities of jobs in the queue of a Cgroup.</p>
<p id="EN-US_TOPIC_0000001233563121__p119020197324">If you set <strong id="EN-US_TOPIC_0000001233563121__b842352706175935">cgroup_name</strong> and then <strong id="EN-US_TOPIC_0000001233563121__b842352706175940">session_respool</strong>, the Cgroups associated with <strong id="EN-US_TOPIC_0000001233563121__b8423527061803">session_respool</strong> take effect. If you reverse the order, Cgroups associated with <strong id="EN-US_TOPIC_0000001233563121__b84235270618042">cgroup_name</strong> take effect.</p>
<p id="EN-US_TOPIC_0000001233563121__p75569413347">If the Workload Cgroup level is specified during the <strong id="EN-US_TOPIC_0000001233563121__b1631274119139">cgroup_name</strong> change, the database does not check the Cgroup level. The level ranges from 1 to 10.</p>
<p id="EN-US_TOPIC_0000001233563121__p141021638141912"><strong id="EN-US_TOPIC_0000001233563121__b206805233385">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p63212713170">You are not advised to set <strong id="EN-US_TOPIC_0000001233563121__b842352706181635">cgroup_name</strong> and <strong id="EN-US_TOPIC_0000001233563121__b842352706181640">session_respool</strong> at the same time.</p>
<p id="EN-US_TOPIC_0000001233563121__afb9148a5a4a54b2592c8b2610df13767"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b688672095621">Value range</strong>: a string</p>
<p id="EN-US_TOPIC_0000001233563121__a960082ccca4246e0a475c33188966896"><strong id="EN-US_TOPIC_0000001233563121__b16948152754819">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b18452203324810">DefaultClass:Medium</strong></p>
<div class="note" id="EN-US_TOPIC_0000001233563121__note1953653910322"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001233563121__p366615446327"><strong id="EN-US_TOPIC_0000001233563121__b429654704815">DefaultClass:Medium</strong> indicates the <strong id="EN-US_TOPIC_0000001233563121__b1048713795016">Medium</strong> Cgroup belonging to the <strong id="EN-US_TOPIC_0000001233563121__b173481122135011">Timeshare</strong> Cgroup under the <strong id="EN-US_TOPIC_0000001233563121__b1824672714505">DefaultClass</strong> Cgroup.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s9224d1039e814e98adaf4ad27b6f75a8"><h4 class="sectiontitle">cpu_collect_timer</h4><p id="EN-US_TOPIC_0000001233563121__aa6156749df6b4c92b932c96a799159f1"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b84235270617952">Parameter description</strong>: Specifies how frequently CPU data is collected during statement execution on DNs.</p>
<p id="EN-US_TOPIC_0000001233563121__a3fdc9e4f16ad491d803cf5410e50e0f7">The database administrator changes the value of this parameter based on system resources (for example, CPU, I/O, and memory resources) so that the system fully supports the concurrency tasks and avoids too many concurrency tasks resulting in system crash.</p>
<p id="EN-US_TOPIC_0000001233563121__p197702445910"><strong id="EN-US_TOPIC_0000001233563121__b13991724143816">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__aba34754d9bce4b06bf6659dc7a0710c9"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967791_b23455951">Value range</strong>: an integer ranging from 1 to INT_MAX. The unit is second.</p>
<p id="EN-US_TOPIC_0000001233563121__a35237e01b6844cff85b60c4854b62d6f"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967582_b40689991104939_2">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967582_b84235270617812_1">30</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s565c7e2c8cb34d4db165766b74a73683"><h4 class="sectiontitle">enable_cgroup_switch</h4><p id="EN-US_TOPIC_0000001233563121__a5eca9c9caeac4b98a5ae1bdee735cf0a"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b842352706172123_1">Parameter description</strong>: Specifies whether the database automatically switches to the <strong id="EN-US_TOPIC_0000001233563121__b842352706192357">TopWD</strong> group when executing statements by group type.</p>
<p id="EN-US_TOPIC_0000001233563121__p241918691910"><strong id="EN-US_TOPIC_0000001233563121__b18921162543816">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__a0a1bc12cb50947aaab525684d57deda3"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_abdb6603792074f608afcc026778454fb">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__u508ca40006484f93ac6601714ce81f84"><li id="EN-US_TOPIC_0000001233563121__l24467bedd0504ff08a43c85df18138ba"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b842352706172123_3">on</strong>: The database automatically switches to the <strong id="EN-US_TOPIC_0000001233563121__b842352706192435">TopWD</strong> group when executing statements by group type.</li><li id="EN-US_TOPIC_0000001233563121__labe48b71421d46bfbf1665865f5169cf"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b842352706172123_5">off</strong>: The database does not automatically switch to the <strong id="EN-US_TOPIC_0000001233563121__b84235270619276">TopWD</strong> group when executing statements by group type.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__a2fc3159e811a498cbc4238818a718375"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b5971851117846_2">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b84235270613313">off</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s99d436e056b446d19c841da7b23faae8"><h4 class="sectiontitle">memory_tracking_mode</h4><p id="EN-US_TOPIC_0000001233563121__a67919fed03e44562bea8db4b97c2e70e"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b842352706172610">Parameter description</strong>: Specifies the memory information recording mode.</p>
<p id="EN-US_TOPIC_0000001233563121__p1746473641810"><strong id="EN-US_TOPIC_0000001233563121__b1852632613389">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__a66ad8055b3f04c22bda844ba1e2493cc"><strong id="EN-US_TOPIC_0000001233563121__b25782132328">Value range</strong>:</p>
<ul id="EN-US_TOPIC_0000001233563121__ul29059994172249"><li id="EN-US_TOPIC_0000001233563121__li16695073172249"><strong id="EN-US_TOPIC_0000001233563121__b842352706105333">none</strong>: Memory statistics is not collected.</li><li id="EN-US_TOPIC_0000001233563121__li5710012517239"><strong id="EN-US_TOPIC_0000001233563121__b842352706105432">normal:</strong> Only memory statistics is collected in real time and no file is generated.</li><li id="EN-US_TOPIC_0000001233563121__li56020122172333"><strong id="EN-US_TOPIC_0000001233563121__b842352706105529">executor:</strong> The statistics file is generated, containing the context information about all allocated memory used by the execution layer.</li><li id="EN-US_TOPIC_0000001233563121__li61119980172352"><strong id="EN-US_TOPIC_0000001233563121__b842352706112725">fullexec</strong>: The generated file includes the information about all memory contexts requested by the execution layer.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__a368ea04ff5554e6293efd92bdd49074c"><strong id="EN-US_TOPIC_0000001233563121__b10048826103114">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b110848183317">none</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s3f3dd81692d64ce08fa1a352e9ebb56f"><h4 class="sectiontitle">memory_detail_tracking</h4><p id="EN-US_TOPIC_0000001233563121__a72d25f2d0320437c992a285dcb72ce7f"><strong id="EN-US_TOPIC_0000001233563121__b1678060675144418">Parameter description</strong>: Specifies the sequence number of the memory background information distributed in the needed thread and <strong id="EN-US_TOPIC_0000001233563121__b842352706192855">plannodeid</strong> of the query where the current thread is located.</p>
<p id="EN-US_TOPIC_0000001233563121__p1245071620182"><strong id="EN-US_TOPIC_0000001233563121__b61126275389">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__af350ee0eedbe4e05b3454c4d69ce0b7c"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b37796097_1">Value range</strong>: a string</p>
<p id="EN-US_TOPIC_0000001233563121__a39299a499b1e41288f2d9ea1fdc82e42"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_b421586113118">Default value</strong>: empty</p>
<div class="notice" id="EN-US_TOPIC_0000001233563121__n83cc48fd8396484199f83f9de17a7247"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="EN-US_TOPIC_0000001233563121__a0c78987d9e3a4018abbf4890e1f7804d">It is recommended that you retain the default value for this parameter.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s9530ecdd2b0d4a98b67b66e32bf8e5d0"><a name="EN-US_TOPIC_0000001233563121__s9530ecdd2b0d4a98b67b66e32bf8e5d0"></a><a name="s9530ecdd2b0d4a98b67b66e32bf8e5d0"></a><h4 class="sectiontitle">enable_resource_track</h4><p id="EN-US_TOPIC_0000001233563121__ae718ea1b2bf14c248e8eb722b646360d"><strong id="EN-US_TOPIC_0000001233563121__b1681868811144355">Parameter description</strong>: Specifies whether the real-time resource monitoring function is enabled. This parameter must be applied on both CNs and DNs.</p>
<p id="EN-US_TOPIC_0000001233563121__p16411142618918"><strong id="EN-US_TOPIC_0000001233563121__b1511714282389">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__aa360558c12b34fa28006d7763756d1da"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b24458229162831_6">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__u3ff70c8d7adb42d0a45d5b54d7b482d6"><li id="EN-US_TOPIC_0000001233563121__l502f22098a3546a38fb609437f27473d"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b842352706152821_5">on</strong> indicates the resource monitoring function is enabled.</li><li id="EN-US_TOPIC_0000001233563121__l0b48936acbbe4f13a19e6dd43f120bd5"><strong id="EN-US_TOPIC_0000001233563121__b104214192034714">off</strong> indicates the resource monitoring function is disabled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__a32291243ba3049eba8785fab5e24526b"><strong id="EN-US_TOPIC_0000001233563121__b1101529633172346">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b421067350172346">on</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s5f116e109a2944e3854abcc56772eaa1"><a name="EN-US_TOPIC_0000001233563121__s5f116e109a2944e3854abcc56772eaa1"></a><a name="s5f116e109a2944e3854abcc56772eaa1"></a><h4 class="sectiontitle">enable_resource_record</h4><p id="EN-US_TOPIC_0000001233563121__p1091904413"><strong id="EN-US_TOPIC_0000001233563121__b832542111412">Parameter description</strong>: Specifies whether resource monitoring records are archived. When this parameter is enabled, records that have been executed are archived to the corresponding <strong id="EN-US_TOPIC_0000001233563121__b18855101419466">INFO</strong> views (<a href="dws_04_0704.html">GS_WLM_SESSION_INFO</a> and <a href="dws_04_0701.html">GS_WLM_OPERAROR_INFO</a>). This parameter must be applied on both CNs and DNs.</p>
<p id="EN-US_TOPIC_0000001233563121__p1179712121695"><strong id="EN-US_TOPIC_0000001233563121__b51611129203815">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__a2a0deb112b624e15a23774120200a46e"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777791_en-us_topic_0058967586_b24458229162831_8">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__u1632ed197ebf48c5a6bc26e750b6c0ce"><li id="EN-US_TOPIC_0000001233563121__l084582a6e1e3496dbdc97769d266b4b7"><strong id="EN-US_TOPIC_0000001233563121__b96415896734714">on</strong> indicates that the resource monitoring records are archived.</li><li id="EN-US_TOPIC_0000001233563121__le34a6e152c0344d6bfc4e472e72efdeb"><strong id="EN-US_TOPIC_0000001233563121__b58509289134714">off</strong> indicates that the resource monitoring records are not archived.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__ab67a24a37b7243788a434311c708ccd4"><strong id="EN-US_TOPIC_0000001233563121__b5368154018462">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b3375640144611">on</strong></p>
<div class="note" id="EN-US_TOPIC_0000001233563121__note1760311247421"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001233563121__p6604102414215">The default value of this parameter is <strong id="EN-US_TOPIC_0000001233563121__b063894311319">on</strong> for a new cluster. In upgrade scenarios, the default value of this parameter is the same as that of the source version.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section7181949101319"><a name="EN-US_TOPIC_0000001233563121__section7181949101319"></a><a name="section7181949101319"></a><h4 class="sectiontitle">enable_track_record_subsql</h4><p id="EN-US_TOPIC_0000001233563121__p15875120144310"><strong id="EN-US_TOPIC_0000001233563121__b15742173575018">Parameter description</strong>: Specifies whether to enable the function of recording and archiving sub-statements. When this function is enabled, sub-statements in stored procedures and anonymous blocks are recorded and archived to the corresponding <strong id="EN-US_TOPIC_0000001233563121__b9679126165311">INFO</strong> table (<a href="dws_04_0566.html">GS_WLM_SESSION_INFO</a>). This parameter is a session-level parameter. It can be configured and take effect in the session connected to the CN and affects only the statements in the session. It can also be configured on both the CN and DN and take effect globally.</p>
<p id="EN-US_TOPIC_0000001233563121__p287516202432"><strong id="EN-US_TOPIC_0000001233563121__b1231009502">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p487542010431"><strong id="EN-US_TOPIC_0000001233563121__b476123165420">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ul1487613201432"><li id="EN-US_TOPIC_0000001233563121__li1876620184311"><strong id="EN-US_TOPIC_0000001233563121__b1621417343549">on</strong> indicates that the sub-statement resource monitoring records are archived.</li><li id="EN-US_TOPIC_0000001233563121__li1087615201436"><strong id="EN-US_TOPIC_0000001233563121__b1353311135516">off</strong> indicates that the sub-statement resource monitoring records are not archived.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p20495182481410"><strong id="EN-US_TOPIC_0000001233563121__b1907152110555">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b109081721165516">off</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section827402723813"><a name="EN-US_TOPIC_0000001233563121__section827402723813"></a><a name="section827402723813"></a><h4 class="sectiontitle">enable_user_metric_persistent</h4><p id="EN-US_TOPIC_0000001233563121__p11270427183812"><strong id="EN-US_TOPIC_0000001233563121__b12224252164710">Parameter description</strong>: Specifies whether the user historical resource monitoring dumping function is enabled. When this function is enabled, data in the <a href="dws_04_0790.html">PG_TOTAL_USER_RESOURCE_INFO</a> view is periodically sampled and saved to the <a href="dws_04_0567.html">GS_WLM_USER_RESOURCE_HISTORY</a> system catalog, and data in the <a href="dws_04_0977.html">GS_RESPOOL_RESOURCE_INFO</a> view is periodically sampled and saved to the <a href="dws_04_0975.html">GS_RESPOOL_RESOURCE_HISTORY</a> system catalog.</p>
<p id="EN-US_TOPIC_0000001233563121__p1127122142015"><strong id="EN-US_TOPIC_0000001233563121__b10901163033810">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p122719274381"><strong id="EN-US_TOPIC_0000001233563121__b62701527133814">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ul8271162773818"><li id="EN-US_TOPIC_0000001233563121__li027142783810"><strong id="EN-US_TOPIC_0000001233563121__b1719240197">on</strong> indicates that the user historical resource monitoring dumping function is enabled.</li><li id="EN-US_TOPIC_0000001233563121__li1127132753810"><strong id="EN-US_TOPIC_0000001233563121__b1574314220261">off</strong> indicates that the user historical resource monitoring dumping function is disabled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p1227192763813"><strong id="EN-US_TOPIC_0000001233563121__b252762322615">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b19539142312264">on</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section16298163313384"><h4 class="sectiontitle">user_metric_retention_time</h4><p id="EN-US_TOPIC_0000001233563121__p3294193323812"><strong id="EN-US_TOPIC_0000001233563121__b535910298266">Parameter description</strong>: Specifies the retention time of the user historical resource monitoring data. This parameter is valid only when <strong id="EN-US_TOPIC_0000001233563121__b1115554414451">enable_user_metric_persistent</strong> is set to <strong id="EN-US_TOPIC_0000001233563121__b0588051131915">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p9741742201712"><strong id="EN-US_TOPIC_0000001233563121__b852711362126">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p12295183323817"><strong id="EN-US_TOPIC_0000001233563121__b3410547290">Value range</strong>: an integer ranging from 0 to 3650. The unit is day.</p>
<ul id="EN-US_TOPIC_0000001233563121__ul162957333386"><li id="EN-US_TOPIC_0000001233563121__li1729533393816">If this parameter is set to <strong id="EN-US_TOPIC_0000001233563121__b695532443012">0</strong>, user historical resource monitoring data is permanently stored.</li><li id="EN-US_TOPIC_0000001233563121__li42950332387">If the value is greater than <strong id="EN-US_TOPIC_0000001233563121__b92762472309">0</strong>, user historical resource monitoring data is stored for the specified number of days.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p102959336388"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0058967657_b26917141">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b842352706204923">7</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section18113133910385"><a name="EN-US_TOPIC_0000001233563121__section18113133910385"></a><a name="section18113133910385"></a><h4 class="sectiontitle">enable_instance_metric_persistent</h4><p id="EN-US_TOPIC_0000001233563121__p111103911388"><strong id="EN-US_TOPIC_0000001233563121__b6373122616317">Parameter description</strong>: Specifies whether the instance resource monitoring dumping function is enabled. When this function is enabled, the instance monitoring data is saved to the system catalog <a href="dws_04_0564.html">GS_WLM_INSTANCE_HISTORY</a>.</p>
<p id="EN-US_TOPIC_0000001233563121__p15909933122014"><strong id="EN-US_TOPIC_0000001233563121__b17956123303813">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p9112133915386"><strong id="EN-US_TOPIC_0000001233563121__b2112139103816">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ul11112113912389"><li id="EN-US_TOPIC_0000001233563121__li101126395382"><strong id="EN-US_TOPIC_0000001233563121__b914382123">on</strong> indicates that the instance resource monitoring dumping function is enabled.</li><li id="EN-US_TOPIC_0000001233563121__li111283915386"><strong id="EN-US_TOPIC_0000001233563121__b612611410332">off</strong>: Specifies that the instance resource monitoring dumping function is disabled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p12112239173820"><strong id="EN-US_TOPIC_0000001233563121__b75814610348">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b069765347">on</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section314449385"><h4 class="sectiontitle">instance_metric_retention_time</h4><p id="EN-US_TOPIC_0000001233563121__p00124414383"><strong id="EN-US_TOPIC_0000001233563121__b1853993015344">Parameter description</strong>: Specifies the retention time of the instance historical resource monitoring data. This parameter is valid only when <a href="#EN-US_TOPIC_0000001233563121__section18113133910385">enable_instance_metric_persistent</a> is set to <strong id="EN-US_TOPIC_0000001233563121__b1386970676">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p1834911203172"><strong id="EN-US_TOPIC_0000001233563121__b378725910123">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p31144411387"><strong id="EN-US_TOPIC_0000001233563121__b7851939132">Value range</strong>: an integer ranging from 0 to 3650. The unit is day.</p>
<ul id="EN-US_TOPIC_0000001233563121__ul4114423811"><li id="EN-US_TOPIC_0000001233563121__li41344143820">If this parameter is set to <strong id="EN-US_TOPIC_0000001233563121__b12112125643519">0</strong>, instance historical resource monitoring data is permanently stored.</li><li id="EN-US_TOPIC_0000001233563121__li7118449381">If the value is greater than <strong id="EN-US_TOPIC_0000001233563121__b138631453133614">0</strong>, the instance historical resource monitoring data is stored for the specified number of days.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p3194419386"><strong id="EN-US_TOPIC_0000001233563121__b533563563">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b796814665">7</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section153571329142612"><a name="EN-US_TOPIC_0000001233563121__section153571329142612"></a><a name="section153571329142612"></a><h4 class="sectiontitle">resource_track_level</h4><p id="EN-US_TOPIC_0000001233563121__p735952912615"><strong id="EN-US_TOPIC_0000001233563121__b2135979628">Parameter description</strong>: Specifies the resource monitoring level of the current session. This parameter is valid only when <a href="#EN-US_TOPIC_0000001233563121__s9530ecdd2b0d4a98b67b66e32bf8e5d0">enable_resource_track</a> is set to <strong id="EN-US_TOPIC_0000001233563121__b74951311588">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p117112313179"><strong id="EN-US_TOPIC_0000001233563121__b1421443511383">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p7363172910268"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777487_a54344496219b4074ad956d5febb62b4c">Value range</strong>: enumerated values</p>
<ul id="EN-US_TOPIC_0000001233563121__ul15363122916268"><li id="EN-US_TOPIC_0000001233563121__li1436322917264"><strong id="EN-US_TOPIC_0000001233563121__b41866398234714">none</strong>: Resources are not monitored.</li><li id="EN-US_TOPIC_0000001233563121__li1666725091914"><strong id="EN-US_TOPIC_0000001233563121__b5647222324">query</strong>: Enables query-level resource monitoring. If this function is enabled, the plan information (similar to the output information of EXPLAIN) of SQL statements will be recorded in top SQL statements.</li><li id="EN-US_TOPIC_0000001233563121__li73310451216"><strong id="EN-US_TOPIC_0000001233563121__b1577665715312">perf</strong>: Enables the perf-level resource monitoring. If this function is enabled, the plan information (similar to the output information of EXPLAIN ANALYZE) that contains the actual execution time and the number of execution rows will be recorded in the top SQL.</li><li id="EN-US_TOPIC_0000001233563121__li17365182911264"><strong id="EN-US_TOPIC_0000001233563121__b5168191310520">operator</strong>: enables the operator-level resource monitoring. If this function is enabled, not only the information including the actual execution time and number of execution rows is recorded in the top SQL statement, but also the operator-level execution information is updated to the top SQL statement.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p436982932619"><strong id="EN-US_TOPIC_0000001233563121__b842352706153219">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b842352706153224">query</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section1089022732713"><a name="EN-US_TOPIC_0000001233563121__section1089022732713"></a><a name="section1089022732713"></a><h4 class="sectiontitle">resource_track_cost</h4><p id="EN-US_TOPIC_0000001233563121__p10896172717275"><strong id="EN-US_TOPIC_0000001233563121__b14896152782710">Parameter description</strong>: Specifies the minimum execution cost for resource monitoring on statements in the current session. This parameter is valid only when <a href="#EN-US_TOPIC_0000001233563121__s9530ecdd2b0d4a98b67b66e32bf8e5d0">enable_resource_track</a> is set to <strong id="EN-US_TOPIC_0000001233563121__b192611269815">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p14848174121618"><strong id="EN-US_TOPIC_0000001233563121__b1482133513382">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p4901127122712"><strong id="EN-US_TOPIC_0000001233563121__b1161683134">Value range</strong>: an integer ranging from –1 to INT_MAX</p>
<ul id="EN-US_TOPIC_0000001233563121__ul118701111164912"><li id="EN-US_TOPIC_0000001233563121__li16870811194919"><strong id="EN-US_TOPIC_0000001233563121__b498193110483">–1</strong> indicates that resource monitoring is disabled.</li><li id="EN-US_TOPIC_0000001233563121__li95612483106">A value greater than or equal to <strong id="EN-US_TOPIC_0000001233563121__b1476354145012">0</strong> indicates that statements whose execution cost exceeds this value will be monitored.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p11911192752714"><strong id="EN-US_TOPIC_0000001233563121__b1820213476599">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b22022470591">0</strong></p>
<div class="note" id="EN-US_TOPIC_0000001233563121__note129932011337"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001233563121__p179930118337">The default value of this parameter is <strong id="EN-US_TOPIC_0000001233563121__b1827533371712">0</strong> for a new cluster. In upgrade scenarios, the default value of this parameter is the same as that of the source version.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section347574425112"><a name="EN-US_TOPIC_0000001233563121__section347574425112"></a><a name="section347574425112"></a><h4 class="sectiontitle">resource_track_duration</h4><p id="EN-US_TOPIC_0000001233563121__p1479644125111"><strong id="EN-US_TOPIC_0000001233563121__b152714715574">Parameter description</strong>: Specifies the minimum statement execution time that determines whether information about jobs of a statement recorded in the real-time view (see <a href="dws_04_0397.html#EN-US_TOPIC_0000001233681601__table16116143418462">Table 1</a>) will be dumped to a historical view after the statement is executed. Job information will be dumped from the real-time view (with the suffix <strong id="EN-US_TOPIC_0000001233563121__b42981326135716">statistics</strong>) to a historical view (with the suffix <strong id="EN-US_TOPIC_0000001233563121__b183001261575">history</strong>) if the statement execution time is no less than this value. This parameter is valid only when <a href="#EN-US_TOPIC_0000001233563121__s9530ecdd2b0d4a98b67b66e32bf8e5d0">enable_resource_track</a> is set to <strong id="EN-US_TOPIC_0000001233563121__b45017114716">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p1569071491619"><strong id="EN-US_TOPIC_0000001233563121__b15574600396">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p84841144145112"><strong id="EN-US_TOPIC_0000001233563121__b63362351318">Value range</strong>: an integer ranging from 0 to INT_MAX. The unit is second (s).</p>
<ul id="EN-US_TOPIC_0000001233563121__ul817641714915"><li id="EN-US_TOPIC_0000001233563121__li617601754918"><strong id="EN-US_TOPIC_0000001233563121__b842352706194922">0</strong> indicates that information about all statements recorded in the real-time resource monitoring view (see <a href="dws_04_0397.html#EN-US_TOPIC_0000001233681601__table16116143418462">Table 1</a>) will be archived into historical views.</li><li id="EN-US_TOPIC_0000001233563121__li12176417164910">If the value is greater than <strong id="EN-US_TOPIC_0000001233563121__b17583134610111">0</strong>, information about statements recorded in the real-time resource monitoring view (see <a href="dws_04_0397.html#EN-US_TOPIC_0000001233681601__table16116143418462">Table 1</a>), whose execution time exceeds this value will be archived into historical views.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p3489114412516"><strong id="EN-US_TOPIC_0000001233563121__b842352706185119">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059778244_b15310055141954">60s</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section104016114237"><h4 class="sectiontitle">dynamic_memory_quota</h4><p id="EN-US_TOPIC_0000001233563121__p14418175713620"><strong id="EN-US_TOPIC_0000001233563121__b041719571368">Parameter description</strong>: Specifies the memory quota in adaptive load scenarios, that is, the proportion of maximum available memory to total system memory.</p>
<p id="EN-US_TOPIC_0000001233563121__p159991748202013"><strong id="EN-US_TOPIC_0000001233563121__b1574317111397">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p6446211172319"><strong id="EN-US_TOPIC_0000001233563121__b13451161192319">Value range</strong>: an integer ranging from 1 to 100</p>
<p id="EN-US_TOPIC_0000001233563121__p1585722371119"><strong id="EN-US_TOPIC_0000001233563121__b55291462334714">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b213900953134714">80</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section174761723101217"><h4 class="sectiontitle">disable_memory_protect</h4><p id="EN-US_TOPIC_0000001233563121__p8480142318127"><strong id="EN-US_TOPIC_0000001233563121__b548232351218">Parameter description:</strong> Stops memory protection. To query system views when system memory is insufficient, set this parameter to <strong id="EN-US_TOPIC_0000001233563121__b196820715134714">on</strong> to stop memory protection. This parameter is used only to diagnose and debug the system when system memory is insufficient. Set it to <strong id="EN-US_TOPIC_0000001233563121__b184955762934714">off</strong> in other scenarios.</p>
<p id="EN-US_TOPIC_0000001233563121__p27124510150"><strong id="EN-US_TOPIC_0000001233563121__b115746263918">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p18492172391214"><strong id="EN-US_TOPIC_0000001233563121__b1873236240">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ul18295447181311"><li id="EN-US_TOPIC_0000001233563121__li1429784791313"><strong id="EN-US_TOPIC_0000001233563121__b26312387934714">on</strong> indicates that memory protection stops.</li><li id="EN-US_TOPIC_0000001233563121__li12305747131314"><strong id="EN-US_TOPIC_0000001233563121__b151718890734714">off</strong> indicates that memory is protected.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p2049718238123"><strong id="EN-US_TOPIC_0000001233563121__b118577291">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b1746153539">off</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section631565955912"><h4 class="sectiontitle">query_band</h4><p id="EN-US_TOPIC_0000001233563121__p831816598591"><strong id="EN-US_TOPIC_0000001233563121__b03183591590">Parameter description</strong>: Specifies the job type of the current session.</p>
<p id="EN-US_TOPIC_0000001233563121__p1159102281513"><strong id="EN-US_TOPIC_0000001233563121__b1234913113914">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p18321155915599"><strong id="EN-US_TOPIC_0000001233563121__b952006326">Value range</strong>: a string</p>
<p id="EN-US_TOPIC_0000001233563121__p1232185914598"><strong id="EN-US_TOPIC_0000001233563121__b4976537817215">Default value</strong>: empty</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section15334124411419"><h4 class="sectiontitle">enable_dynamic_workload</h4><p id="EN-US_TOPIC_0000001233563121__p113372044141412"><strong id="EN-US_TOPIC_0000001233563121__b2056176810">Parameter description</strong>: Specifies whether to enable the dynamic workload management function.</p>
<p id="EN-US_TOPIC_0000001233563121__p19268144813616"><strong id="EN-US_TOPIC_0000001233563121__b498711519394">Type</strong>: POSTMASTER</p>
<p id="EN-US_TOPIC_0000001233563121__p1334010443148"><strong id="EN-US_TOPIC_0000001233563121__b1466795780">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ul19341134431413"><li id="EN-US_TOPIC_0000001233563121__li183421544101416"><strong id="EN-US_TOPIC_0000001233563121__b842352706193247">on</strong> indicates the dynamic workload management function is enabled.</li><li id="EN-US_TOPIC_0000001233563121__li8343184412143"><strong id="EN-US_TOPIC_0000001233563121__b667647147">off</strong> indicates the dynamic workload management function is disabled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p19345444141417"><strong id="EN-US_TOPIC_0000001233563121__b1544954218411">Default value:</strong> <strong id="EN-US_TOPIC_0000001233563121__b344944218419">on</strong></p>
<div class="notice" id="EN-US_TOPIC_0000001233563121__note1157234191015"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><ul id="EN-US_TOPIC_0000001233563121__ul11572044103"><li id="EN-US_TOPIC_0000001233563121__li2572164111014">If memory adaptation is enabled, you do not need to use <strong id="EN-US_TOPIC_0000001233563121__b116644279586">work_mem</strong> to optimize the operator memory usage after collecting statistics. The system will generate a plan for each statement based on the current load, estimating the memory used by each operator and by the entire statement. In a concurrency scenario, statements are queued based on the system load and their memory usage.</li><li id="EN-US_TOPIC_0000001233563121__li205729412103">The optimizer cannot accurately estimate the number of rows and will probably underestimate or overestimate memory usage. If the memory usage is underestimated, the allocated memory will be automatically increased during statement running. If the memory usage is overestimated, system resources will not be fully used, and the number of statements waiting in a queue will increase, which probably results in low performance. To improve performance, identify the statements whose estimated memory usage is much greater than the DN peak memory and adjust the value of <strong id="EN-US_TOPIC_0000001233563121__b1865131310568">query_max_mem</strong>. For details, see <a href="dws_04_0453.html">Adjusting Key Parameters During SQL Tuning</a>.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__s49ffefbc1d7e4261a3b9b6bde1e9a147"><h4 class="sectiontitle">bbox_dump_count</h4><p id="EN-US_TOPIC_0000001233563121__ad31ef0c87e1744859be6dbfec2e978c0"><strong id="EN-US_TOPIC_0000001233563121__b92572581368">Parameter description</strong>: Specifies the maximum number of core files that are generated by <span id="EN-US_TOPIC_0000001233563121__text425719581561">GaussDB(DWS)</span> and can be stored in the path specified by <strong id="EN-US_TOPIC_0000001233563121__b23981313672">bbox_dump_path</strong>. If the number of core files exceeds this value, old core files will be deleted. This parameter is valid only if <strong id="EN-US_TOPIC_0000001233563121__b19565330473">enable_bbox_dump</strong> is set to <strong id="EN-US_TOPIC_0000001233563121__b12566530572">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p74798402510"><strong id="EN-US_TOPIC_0000001233563121__b18943938183913">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__a44e616b37b524be99d1e4e1cf8d29578"><strong id="EN-US_TOPIC_0000001233563121__b15123128115616">Value range</strong>: an integer ranging from 1 to 20</p>
<p id="EN-US_TOPIC_0000001233563121__add923227fd1148f9a00db57996e3c3ff"><strong id="EN-US_TOPIC_0000001233563121__b1413578664144214">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b578690575144214">8</strong></p>
<div class="note" id="EN-US_TOPIC_0000001233563121__ncdaf889bc5bd4b0e9b36c618b7241881"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0000001233563121__a1526da0b291442fa916ba5b03aedd1cc">When core files are generated during concurrent SQL statement execution, the number of files may be larger than the value of <strong id="EN-US_TOPIC_0000001233563121__b2005970014144133">bbox_dump_count</strong>.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section1148143712203"><h4 class="sectiontitle">io_limits</h4><p id="EN-US_TOPIC_0000001233563121__p12501837102015"><strong id="EN-US_TOPIC_0000001233563121__b10888359144812">Parameter description</strong>: This parameter has been discarded in version 8.1.2 and is reserved for compatibility with earlier versions. This parameter is invalid in the current version.</p>
<p id="EN-US_TOPIC_0000001233563121__p11335216520"><strong id="EN-US_TOPIC_0000001233563121__b5683154023910">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p2353169278"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059777487_en-us_topic_0058967566_b6696864">Value range</strong>: an integer ranging from 0 to 1073741823</p>
<p id="EN-US_TOPIC_0000001233563121__p18641037102016"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059778487_a023402ff020d43919b2d4639671ceb32">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059778487_en-us_topic_0058967649_b842352706195030">0</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section0751123912227"><h4 class="sectiontitle">io_priority</h4><p id="EN-US_TOPIC_0000001233563121__p652216533225"><strong id="EN-US_TOPIC_0000001233563121__b1890855918487">Parameter description</strong>: This parameter has been discarded in version 8.1.2 and is reserved for compatibility with earlier versions. This parameter is invalid in the current version.</p>
<p id="EN-US_TOPIC_0000001233563121__p19172056519"><strong id="EN-US_TOPIC_0000001233563121__b1124334173913">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p075714396226"><strong id="EN-US_TOPIC_0000001233563121__b1788961085">Value range</strong>: enumerated values</p>
<ul id="EN-US_TOPIC_0000001233563121__ul584258251503"><li id="EN-US_TOPIC_0000001233563121__li1136775412577">None</li><li id="EN-US_TOPIC_0000001233563121__li327400081503">Low</li><li id="EN-US_TOPIC_0000001233563121__li266002731506">Medium</li><li id="EN-US_TOPIC_0000001233563121__li587127221508">High</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p1675915397225"><strong id="EN-US_TOPIC_0000001233563121__b12034753911539">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b152401163719">None</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section2673131522715"><h4 class="sectiontitle">session_respool</h4><p id="EN-US_TOPIC_0000001233563121__p067531572720"><strong id="EN-US_TOPIC_0000001233563121__b842352706194554">Parameter description</strong>: Specifies the resource pool associated with the current session.</p>
<p id="EN-US_TOPIC_0000001233563121__p76261753133513"><strong id="EN-US_TOPIC_0000001233563121__b478114411391">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p165805713355">If you set <strong id="EN-US_TOPIC_0000001233563121__b1139967788">cgroup_name</strong> and then <strong id="EN-US_TOPIC_0000001233563121__b1585292309">session_respool</strong>, the Cgroups associated with <strong id="EN-US_TOPIC_0000001233563121__b1715301737">session_respool</strong> take effect. If you reverse the order, Cgroups associated with <strong id="EN-US_TOPIC_0000001233563121__b1301104177">cgroup_name</strong> take effect.</p>
<p id="EN-US_TOPIC_0000001233563121__p5591757183516">If the Workload Cgroup level is specified during the <strong id="EN-US_TOPIC_0000001233563121__b1951919771">cgroup_name</strong> change, the database does not check the Cgroup level. The level ranges from 1 to 10.</p>
<p id="EN-US_TOPIC_0000001233563121__p7223154111811">You are not advised to set <strong id="EN-US_TOPIC_0000001233563121__b695571661">cgroup_name</strong> and <strong id="EN-US_TOPIC_0000001233563121__b1227567196">session_respool</strong> at the same time.</p>
<p id="EN-US_TOPIC_0000001233563121__p168061522714"><strong id="EN-US_TOPIC_0000001233563121__b842352706194349">Value range</strong>: a string. This parameter can be set to the resource pool configured through <strong id="EN-US_TOPIC_0000001233563121__b842352706194528">create resource pool</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p968301582711"><strong id="EN-US_TOPIC_0000001233563121__b590982696">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b668800993">invalid_pool</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section106864402366"><h4 class="sectiontitle">enable_transaction_parctl</h4><p id="EN-US_TOPIC_0000001233563121__p1968613403367"><strong id="EN-US_TOPIC_0000001233563121__b10392155641511">Parameter description</strong>: whether to control transaction block statements and stored procedure statements.</p>
<p id="EN-US_TOPIC_0000001233563121__p135009518411"><strong id="EN-US_TOPIC_0000001233563121__b2052904283914">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p56861040103620"><strong id="EN-US_TOPIC_0000001233563121__b1277359722">Value range</strong>: Boolean</p>
<ul id="EN-US_TOPIC_0000001233563121__ul16861640113613"><li id="EN-US_TOPIC_0000001233563121__li12686040183613"><strong id="EN-US_TOPIC_0000001233563121__b110355215161">on</strong>: Transaction block statements and stored procedure statements are controlled.</li><li id="EN-US_TOPIC_0000001233563121__li19686174013617"><strong id="EN-US_TOPIC_0000001233563121__b1344353011171">off</strong>: Transaction block statements and stored procedure statements are not controlled.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p168764003610"><strong id="EN-US_TOPIC_0000001233563121__b2009566586">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b1681031957">on</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section27306369458"><a name="EN-US_TOPIC_0000001233563121__section27306369458"></a><a name="section27306369458"></a><h4 class="sectiontitle">session_history_memory</h4><p id="EN-US_TOPIC_0000001233563121__p10730143684512"><strong id="EN-US_TOPIC_0000001233563121__b81703241277">Parameter description</strong>: Specifies the memory size of a historical query view.</p>
<p id="EN-US_TOPIC_0000001233563121__p99441634935"><strong id="EN-US_TOPIC_0000001233563121__b12848124318395">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p273193613458"><strong id="EN-US_TOPIC_0000001233563121__b19310173314297">Value range</strong>: an integer ranging from 10240 to 50% of <strong id="EN-US_TOPIC_0000001233563121__b381033616290">max_process_memory</strong>. The unit is KB.</p>
<p id="EN-US_TOPIC_0000001233563121__p1373114364453"><strong id="EN-US_TOPIC_0000001233563121__b1228652820814">Default value:</strong> <strong id="EN-US_TOPIC_0000001233563121__b1328712282819">100 MB</strong></p>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section2570135114116"><h4 class="sectiontitle">topsql_retention_time</h4><p id="EN-US_TOPIC_0000001233563121__p0613161384"><strong id="EN-US_TOPIC_0000001233563121__b61401423114716">Parameter description</strong>: Specifies the retention period of historical Top SQL data in the <strong id="EN-US_TOPIC_0000001233563121__b6592135012479">gs_wlm_session_info</strong> and <strong id="EN-US_TOPIC_0000001233563121__b20547105474716">gs_wlm_operator_info</strong> tables.</p>
<p id="EN-US_TOPIC_0000001233563121__p252917217319"><strong id="EN-US_TOPIC_0000001233563121__b1327894433918">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p176131643817"><strong id="EN-US_TOPIC_0000001233563121__b111145313377">Value range</strong>: an integer ranging from 0 to 3650. The unit is day.</p>
<ul id="EN-US_TOPIC_0000001233563121__ul24731743104213"><li id="EN-US_TOPIC_0000001233563121__li047315438424">If it is set to <strong id="EN-US_TOPIC_0000001233563121__b139411713133218">0</strong>, the data is stored permanently.</li><li id="EN-US_TOPIC_0000001233563121__li1473104310427">If the value is greater than <strong id="EN-US_TOPIC_0000001233563121__b1834015160386">0</strong>, the data is stored for the specified number of days.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p13691613386"><strong id="EN-US_TOPIC_0000001233563121__b13915259151516">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b842352706165429">30</strong></p>
<div class="caution" id="EN-US_TOPIC_0000001233563121__note2020576431"><span class="cautiontitle"><img src="public_sys-resources/caution_3.0-en-us.png"> </span><div class="cautionbody"><ul id="EN-US_TOPIC_0000001233563121__ul418120519020"><li id="EN-US_TOPIC_0000001233563121__li10181151704">Before setting this GUC parameter to enable the data retention function, delete data from the <strong id="EN-US_TOPIC_0000001233563121__b11806917978388">gs_wlm_session_info</strong> and <strong id="EN-US_TOPIC_0000001233563121__b9160562058388">gs_wlm_operator_info</strong> tables.</li><li id="EN-US_TOPIC_0000001233563121__li51811651302">The default value of this parameter is <strong id="EN-US_TOPIC_0000001233563121__b13980247718388">30</strong> for a new cluster. In upgrade scenarios, the default value of this parameter is the same as that of the source version.</li></ul>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section1835116504363"><h4 class="sectiontitle">transaction_pending_time</h4><p id="EN-US_TOPIC_0000001233563121__p335185043614"><strong id="EN-US_TOPIC_0000001233563121__b965356141816">Parameter description</strong>: maximum queuing time of transaction block statements and stored procedure statements if <strong id="EN-US_TOPIC_0000001233563121__b8106111214191">enable_transaction_parctl</strong> is set to <strong id="EN-US_TOPIC_0000001233563121__b25061918161919">on</strong>.</p>
<p id="EN-US_TOPIC_0000001233563121__p12603151319214"><strong id="EN-US_TOPIC_0000001233563121__b1439412454391">Type</strong>: USERSET</p>
<p id="EN-US_TOPIC_0000001233563121__p335111501361"><strong id="EN-US_TOPIC_0000001233563121__b1289665073815">Value range</strong>: an integer ranging from –1 to INT_MAX. The unit is second (s).</p>
<ul id="EN-US_TOPIC_0000001233563121__ul13351150103610"><li id="EN-US_TOPIC_0000001233563121__li1335116502368"><strong id="EN-US_TOPIC_0000001233563121__b119721869208">–1</strong> or <strong id="EN-US_TOPIC_0000001233563121__b3276613192010">0</strong>: No queuing timeout is specified for transaction block statements and stored procedure statements. The statements can be executed when resources are available.</li><li id="EN-US_TOPIC_0000001233563121__li163511950193616">Value greater than <strong id="EN-US_TOPIC_0000001233563121__b97628503212">0</strong>: If transaction block statements and stored procedure statements have been queued for a time longer than the specified value, they are forcibly executed regardless of the current resource situation.</li></ul>
<p id="EN-US_TOPIC_0000001233563121__p183511250113616"><strong id="EN-US_TOPIC_0000001233563121__b1591594870">Default value</strong>: <strong id="EN-US_TOPIC_0000001233563121__b2115842368">0</strong></p>
<div class="notice" id="EN-US_TOPIC_0000001233563121__ne7dee8ee88ce4d6299b8651b0fa820d1"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="EN-US_TOPIC_0000001233563121__p429891617354">This parameter is valid only for internal statements of stored procedures and transaction blocks. That is, this parameter takes effect only for the statements whose <strong id="EN-US_TOPIC_0000001233563121__b967924916202">enqueue</strong> value (for details, see <a href="dws_04_0749.html">PG_SESSION_WLMSTAT</a>) is <strong id="EN-US_TOPIC_0000001233563121__b102210162116">Transaction</strong> or <strong id="EN-US_TOPIC_0000001233563121__b17188114112119">StoredProc</strong>.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0000001233563121__section3917839115"><a name="EN-US_TOPIC_0000001233563121__section3917839115"></a><a name="section3917839115"></a><h4 class="sectiontitle">wlm_sql_allow_list</h4><p id="EN-US_TOPIC_0000001233563121__p11917153151119"><strong id="EN-US_TOPIC_0000001233563121__b116921625176">Parameter description</strong>: Specifies whitelisted SQL statements for resource management. Whitelisted SQL statements are not monitored by resource management.</p>
<p id="EN-US_TOPIC_0000001233563121__p391715312119"><strong id="EN-US_TOPIC_0000001233563121__b541917222208">Type</strong>: SIGHUP</p>
<p id="EN-US_TOPIC_0000001233563121__p159171731117"><strong id="EN-US_TOPIC_0000001233563121__en-us_topic_0059778871_en-us_topic_0058967732_b842352706112225">Value range</strong>: a string</p>
<p id="EN-US_TOPIC_0000001233563121__p1391863111111"><strong id="EN-US_TOPIC_0000001233563121__b19149202516179">Default value</strong>: empty</p>
<div class="notice" id="EN-US_TOPIC_0000001233563121__note49182314117"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><ul id="EN-US_TOPIC_0000001233563121__ul1426521191610"><li id="EN-US_TOPIC_0000001233563121__li1726142118164">One or more whitelisted SQL statements can be specified in <strong id="EN-US_TOPIC_0000001233563121__b1649182991718">wlm_sql_allow_list</strong>. If multiple SQL statements are to be whitelisted, use semicolons (;) to separate them.</li><li id="EN-US_TOPIC_0000001233563121__li122752116166">The system determines whether SQL statements are monitored based on the prefix match. The SQL statements are case insensitive. For example, if <strong id="EN-US_TOPIC_0000001233563121__b189983319173">wlm_sql_allow_list</strong> is set to <strong id="EN-US_TOPIC_0000001233563121__b1110593321715">'SELECT'</strong>, all <strong id="EN-US_TOPIC_0000001233563121__b1310673321712">SELECT</strong> statements are not monitored by the resource management module.</li><li id="EN-US_TOPIC_0000001233563121__li16872734174116">The system identifies spaces at the beginning of the parameter value. For example, <strong id="EN-US_TOPIC_0000001233563121__b819075117405">'SELECT'</strong> and <strong id="EN-US_TOPIC_0000001233563121__b17437109174119">' SELECT'</strong> have different representations. <strong id="EN-US_TOPIC_0000001233563121__b468553984120">' SELECT'</strong> filters only the <strong id="EN-US_TOPIC_0000001233563121__b28145479419">SELECT</strong> statements with spaces at the beginning.</li><li id="EN-US_TOPIC_0000001233563121__li172712113168">The system has some whitelisted SQL statements by default, which cannot be modified. You can query the default whitelisted SQL statements and the SQL statements that have been successfully added to the whitelist by GUC through the system view <strong id="EN-US_TOPIC_0000001233563121__b1793820378172">gs_wlm_sql_allow</strong>.</li><li id="EN-US_TOPIC_0000001233563121__li466922215340">New SQL statements cannot be appended to the whitelisted SQL statements specified by <strong id="EN-US_TOPIC_0000001233563121__b1036494361712">wlm_sql_allow_list</strong> but can be set only through overwriting. To add an SQL statement, query the original GUC value, add the new statement to the end of the original value, separate the statements with a semicolon (;), and set the GUC value again.</li></ul>
</div></div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_04_0883.html">GUC Parameters</a></div>
</div>
</div>
View Git Blame Copy Permalink