内存
介绍与内存相关的参数设置。
这些参数只能在数据库服务重新启动后生效，local_syscache_threshold除外。
memorypool_enable
参数说明：设置是否允许使用内存池。
该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
取值范围：布尔型
- on表示允许使用内存池。
- off表示不允许使用内存池。
默认值：off
memorypool_size
参数说明：设置内存池大小。
该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，128*1024～1073741823，单位为KB。
默认值：512MB
enable_memory_limit
参数说明：启用逻辑内存管理模块。
该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
取值范围：布尔型
- on表示启用逻辑内存管理模块。
- off表示不启用逻辑内存管理模块。
默认值：on
- 由于存在固定开销，即shared_buffers和元数据（大约200MB），若max_process_memory减去固定开销小于2GB，GaussDB强制把enable_memory_limit设置为off。其中元数据是GaussDB内部使用的内存，和部分并发参数，如max_connections，thread_pool_attr，max_prepared_transactions等参数相关。
- 当该值为off时，不对数据库使用的内存做限制，在大并发或者复杂查询时，使用内存过多，可能导致操作系统OOM问题。
max_process_memory
参数说明：设置一个数据库节点可用的最大物理内存。
该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，2097152~2147483647，单位为KB。
默认值：
独立部署：360GB（60核CPU/480G内存）；192GB（32核CPU/256G内存）；96GB（16核CPU/128G内存）；40GB（8核CPU/64G内存）；20GB（4核CPU/32G内存）；10GB（4核CPU/16G内存）
设置建议：
DN上该数值需要根据系统物理内存及单节点部署主DN个数决定的。计算公式如下：（物理内存大小 – vm.min_free_kbytes）* 0.7 / (n+主DN个数)。该参数目的是尽可能保证系统的可靠性，不会因数据库内存膨胀导致节点OOM。这个公式中提到vm.min_free_kbytes，其含义是预留操作系统内存供内核使用，通常用作操作系统内核中通信收发内存分配，至少为5%内存。即，max_process_memory=物理内存*0.665/(n+主DN个数)，其中，当集群规模小于256时，n=1；当集群规模大于256且小于512时，n=2；当集群规模超过512时，n=3。
CN上该数值内存可设置与DN数值一样。
RAM：集群规划时分配给集群的最大使用内存，实际为服务器的物理内存。
当该值设置不合理，即大于服务器物理内存，可能导致操作系统OOM问题。
local_syscache_threshold
参数说明：系统表cache在单个session缓存的大小。
- 如果enable_global_plancache已打开，为保证GPC生效，local_syscache_threshold设置值小于16MB时不会生效，最小为16MB。
- 如果enable_global_syscache和enable_thread_pool打开，该参数描述的是当前线程和绑定到当前线程上的session缓存的总大小。
取值范围：整型，1*1024～512*1024，单位为KB。
默认值：
- 独立部署：16MB
enable_memory_context_control
参数说明：启用检查内存上下文是否超过给定限制的功能。仅适用于DEBUG版本。
该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。
取值范围：布尔型
- on表示启用最大内存上下文限制检查功能。
- off表示关闭最大内存上下文限制检查功能。
默认值：off
uncontrolled_memory_context
参数说明：启用检查内存上下文是否超过给定限制的功能时，设置不受此功能约束。仅适用于DEBUG版本。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
查询时会在参数值的最前面添加标题含义字符串“MemoryContext white list:”"。
取值范围：字符串
默认值：空
shared_buffers
参数说明：设置GaussDB使用的共享内存大小。增加此参数的值会使GaussDB比系统默认设置需要更多的System V共享内存。
该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，16 ~ 1073741823，单位为8KB。
改变BLCKSZ的值会改变最小值。
默认值：
独立部署：
CN：4GB（60核CPU/480G内存）；2GB（32核CPU/256G内存，16核CPU/128G内存）；1GB（8核CPU/64G内存）；512MB（4核CPU/32G内存）；256MB（4核CPU/16G内存）
DN：140GB（60核CPU/480G内存）；76GB（32核CPU/256G内存）；40GB（16核CPU/128G内存）；16GB（8核CPU/64G内存）；8GB（4核CPU/32G内存）；4GB（4核CPU/16G内存）
设置建议：
- 由于GaussDB大部分查询下推，建议DN中此参数设置比CN大。
- 建议设置shared_buffers值为内存的40%以内。
- 如果设置较大的shared_buffers需要同时增加checkpoint_segments的值，因为写入大量新增、修改数据需要消耗更多的时间周期。
- 如果调整shared_buffers参数之后，导致进程重启失败，请参考启动失败的报错信息，采用以下解决方案之一：
- 对应调整操作系统kernel.shmall、kernel.shmmax、kernel.shmmin参数，调整方式请参考《安装指南》的“安装前准备 > 修改操作系统配置 > 配置操作系统其他参数”章节。
- 执行free -g观察操作系统可用内存和swap空间是否足够，如果内存明显不足，请手动停止其他比较占用内存的用户程序。
- 避免设置明显不合理（过大或过小）的shared_buffers值。
bulk_write_ring_size
参数说明：数据并行导入使用的环形缓冲区大小。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，16384 ~ 2147483647，单位为KB。
默认值：2GB
设置建议：建议导入压力大的场景中增加DN中此参数配置。
standby_shared_buffers_fraction
参数说明：备实例所在服务器使用shared_buffers内存缓冲区大小的比例。
该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。
取值范围：双精度浮点类型，0.1~1.0
默认值：1
temp_buffers
参数说明：设置每个数据库会话使用的LOCAL临时缓冲区的大小。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
在每个会话的第一次使用临时表之前可以改变temp_buffers的值，之后的设置将是无效的。
一个会话将按照temp_buffers给出的限制，根据需要分配临时缓冲区。如果在一个并不需要大量临时缓冲区的会话里设置一个大的数值，其开销只是一个缓冲区描述符的大小。当缓冲区被使用，就会额外消耗8192字节。
取值范围：整型，100~1073741823，单位为8KB。
默认值：1MB
max_prepared_transactions
参数说明：设置可以同时处于"预备"状态的事务的最大数目。增加此参数的值会使GaussDB比系统默认设置需要更多的System V共享内存。
当GaussDB部署为主备双机时，在备机上此参数的设置必须要高于或等于主机上的，否则无法在备机上进行查询操作。
该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，0~262143。
默认值：
- 独立部署：
1200（60核CPU/480G内存，32核CPU/256G内存）；800（16核CPU/128G内存）；400（8核CPU/64G内存）；300（4核CPU/32G内存）；200（4核CPU/16G内存）
为避免在准备步骤失败，线程池模式下此参数的值应大于thread_pool_attr中工作线程个数，非线程池模式下此参数的值不能小于max_connections。
work_mem
参数说明：设置内部排序操作和Hash表在开始写入临时磁盘文件之前使用的内存大小。ORDER BY，DISTINCT和merge joins都要用到排序操作。Hash表在散列连接、散列为基础的聚集、散列为基础的IN子查询处理中都要用到。
对于复杂的查询，可能会同时并发运行好几个排序或者散列操作，每个都可以使用此参数所声明的内存量，不足时会使用临时文件。同样，好几个正在运行的会话可能会同时进行排序操作。因此使用的总内存可能是work_mem的好几倍。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，64~2147483647，单位为KB。
默认值：
- 独立部署：
128MB（60核CPU/480G内存，32核CPU/256G内存，16核CPU/128G内存）；64MB（8核CPU/64G内存）；32MB（4核CPU/32G内存）；16MB（4核CPU/16G内存）
设置建议：
依据查询特点和并发来确定，一旦work_mem限定的物理内存不够，算子运算数据将写入临时表空间，带来5-10倍的性能下降，查询响应时间从秒级下降到分钟级。
- 对于串行无并发的复杂查询场景，平均每个查询有5-10关联操作，建议work_mem=50%内存/10。
- 对于串行无并发的简单查询场景，平均每个查询有2-5个关联操作，建议work_mem=50%内存/5。
- 对于并发场景，建议work_mem=串行下的work_mem/物理并发数。
- 对于BitmapScan的哈希表也会受到work_mem的限制，但不会被严格管控下盘。完全Lossify的情况下，哈希表每占用1MB的内存，对应一次BitmapHeapScan的16GB的页面，达到work_mem上限后，会按此比例随数据访问量线性增长。
query_mem
参数说明：设置执行作业所使用的内存。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：0，或大于32MB的整型，默认单位为KB。
默认值：0
- 如果设置的query_mem值大于0，在生成执行计划时，优化器会将作业的估算内存调整为该值。
- 如果设置值为负数或小于32MB，将设置为默认值0，此时优化器不会根据该值调整作业的估算内存。
query_max_mem
参数说明：设置执行作业所能够使用的最大内存。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：0，或大于32M的整型，默认单位为KB。
默认值：0
- 如果设置的query_max_mem值大于0，当作业执行时所使用内存超过该值时，将报错退出。
- 如果设置值为负数或小于32M，将设置为默认值0，此时不会根据该值限制作业的内存使用。
maintenance_work_mem
参数说明：设置在维护性操作（比如VACUUM、CREATE INDEX等）中可使用的最大的内存。该参数的设置会影响VACUUM、VACUUM FULL、CLUSTER、CREATE INDEX的执行效率。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，1024~2147483647，单位为KB。
默认值：
- 独立部署：
CN：1GB（60核CPU/480G内存）；512MB（32核CPU/256G内存）；256MB（16核CPU/128G内存）；128MB（8核CPU/64G内存）；64MB（4核CPU/32G内存）；32MB（4核CPU/16G内存）
DN：2GB（60核CPU/480G内存）；1GB（32核CPU/256G内存）；512MB（16核CPU/128G内存）；256MB（8核CPU/64G内存）；128MB（4核CPU/32G内存）；64MB（4核CPU/16G内存）
设置建议：
- 建议设置此参数的值大于work_mem，可以改进清理和恢复数据库转储的速度。因为在一个数据库会话里，任意时刻只有一个维护性操作可以执行，并且在执行维护性操作时不会有太多的会话。
- 当自动清理线程运行时，autovacuum_max_workers倍数的内存将会被分配，所以此时设置maintenance_work_mem的值应该不小于work_mem。
- 如果进行大数据量的cluster等，可以在session中调大该值。
max_stack_depth
参数说明：设置GaussDB执行堆栈的最大安全深度。需要这个安全界限是因为在服务器里，并非所有程序都检查了堆栈深度，只是在可能递规的过程，比如表达式计算这样的过程里面才进行检查。
该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，100~2147483647，单位为KB。
默认值：
- （ulimit -s的设置）- 640 KB的值大于等于2MB时，此参数的默认值为2MB。
- （ulimit -s的设置）- 640 KB的值小于2MB时，此参数的默认值为（ulimit -s的设置）- 640 KB。
设置原则：
- 数据库需要预留640KB堆栈深度，因此此参数可设置的最大值等于操作系统内核允许的最大值（就是ulimit -s的设置）- 640KB。
- 数据库未运行前设置的该参数值大于（ulimit -s的设置）- 640 KB时会导致数据库启动失败；数据库运行阶段设置该参数值大于（ulimit -s的设置）- 640 KB时该值不生效。
- 若（ulimit -s的设置）-640KB小于此参数取值范围的最小值时会导致数据库启动失败。
- 如果设置此参数的值大于实际的内核限制，则一个正在运行的递归函数可能会导致一个独立的服务器进程崩溃。
- 因为并非所有的操作都能够检测，所以建议用户在此设置一个明确的值。
- 默认值最大为2MB，这个值相对比较小，不容易导致系统崩溃。
bulk_read_ring_size
参数说明：并行导出，使用的环形缓冲区大小。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：整型，256~2147483647，单位为KB。
默认值：16MB
enable_early_free
参数说明：控制是否可以实现算子内存的提前释放。
该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。
取值范围：布尔型
- on表示支持算子内存提前释放。
- off表示不支持算子内存提前释放。
默认值：on
memory_trace_level
参数说明：动态内存使用超过最大动态内存的90%后，记录内存申请信息的管控等级。该参数仅在GUC参数use_workload_manager和enable_memory_limit打开时生效。该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。
取值范围：枚举型
- none：表示不记录内存申请信息。
- level1：动态内存使用超过最大动态内存的90%后，会记录以下信息，并将记录的内存信息保存在$GAUSSLOG/mem_log目录下。
- 全局内存概况。
- instance，session，thread三种类型的所有内存上下文中内存占用前20的内存上下文的内存使用情况。
- 每个内存上下文的totalsize、freesize字段。
- level2：动态内存使用超过最大动态内存的90%后，会记录以下信息，并将记录的内存信息保存在$GAUSSLOG/mem_log目录下。
- 全局内存概况。
- instance，session，thread三种类型的所有内存上下文中内存占用前20的内存上下文的内存使用情况。
- 每个内存上下文的totalsize，freesize字段。
- 每个内存上下文上所有内存申请的详细信息，包含申请内存所在的文件，行号和大小。
默认值：level1
- 该参数设置为level2后，会记录每个内存上下文的内存申请详情（file，line，size字段），会对性能影响较大，需慎重设置。
- 记录的内存快照信息可以通过系统函数gs_get_history_memory_detail(cstring)查询，函数详情请参考《开发指南》的“SQL参考 > 函数和操作符 > 统计信息函数”章节。
- use_workload_manager参数关闭的情况下，如果打开bypass_workload_manager，则该参数也会生效，但是因为bypass_workload_manager是SIGHUP类型，reload方式设置后需要重启数据库才会使得当前功能生效。
- 记录的内存上下文是经过将同一类型所有重名的内存上下文进行汇总之后得到的。
resilience_memory_reject_percent
参数说明：用于控制内存过载逃生的动态内存占用百分比。该参数仅在GUC参数use_workload_manager和enable_memory_limit打开时生效。该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。
取值范围：字符串，长度大于0。
该参数分为recover_memory_percent,、overload_memory_percent 2部分，这2个部分的具体含义如下：
- recover_memory_percent：内存从过载状态恢复正常状态的动态内存使用占最大动态内存的百分比，当动态内存使用小于最大动态内存乘以该值对应的百分比后，停止过载逃生并放开新连接接入，取值为0~100，设置为多少表示百分之多少。
- overload_memory_percent：内存过载时动态内存使用占最大动态内存的百分比，当动态内存使用大于最大动态内存乘以该值对应的百分比后，表示当前内存已经过载，触发过载逃生kill会话并禁止新连接接入，取值为0~100，设置为多少表示百分之多少。
默认值：'0,0'，表示关闭内存过载逃生功能。
示例：
resilience_memory_reject_percent = '70,90'
表示内存使用超过最大内存上限的90%后禁止新连接接入并kill堆积的会话，kill会话过程中内存恢复到最大内存的70%以下时停止kill会话并允许新连接接入。
- 最大动态内存和已使用的动态内存可以通过pv_total_memory_detail视图查询获得，最大动态内存：max_dynamic_memory，已使用的动态内存：dynamic_used_memory。
- 该参数如果设置的百分比过小，则会频繁触发内存过载逃生流程，会使正在执行的会话被强制退出，新连接短时间接入失败，需要根据实际内存使用情况慎重设置。
- use_workload_manager参数关闭的情况下，如果打开bypass_workload_manager，则该参数也会生效，但是因为bypass_workload_manager是SIGHUP类型，reload方式设置后需要重启数据库才会使得当前功能生效。
- recover_memory_percent和overload_memory_percent的值可以同时为0，除此之外，recover_memory_percent的值必须要小于overload_memory_percent，否则会设置不生效。
resilience_escape_user_permissions
参数说明：设置用户权限，以逗号分隔，可以设置多个，设置多个则表示多个特殊权限的用户都支持逃生能力，只设置一个则只针对一个特权用户进行逃生。sysadmin控制sysadmin用户的作业是否会被该逃生功能进行cancel处理；monadmin控制monadmin用户的作业是否会被该逃生功能进行cancel处理；默认为空，表示关闭sysadmin和monadmin用户的逃生能力。当前取值仅支持sysadmin，monadmin或者空字符串。该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。
取值范围：字符串，长度大于0。
- sysadmin：控制sysadmin用户的作业是否会被该逃生功能进行cancel处理。
- monadmin：控制monadmin用户的作业是否会被该逃生功能进行cancel处理。
- ''：关闭sysadmin和monadmin用户的逃生能力。
默认值：''，关闭sysadmin和monadmin用户的逃生能力。
示例：
resilience_escape_user_permissions = 'sysadmin,monadmin'
表示同时开启sysadmin和monadmin用户的逃生功能。
- 该参数可以同时设置多个值，以逗号分隔，例如resilience_escape_user_permissions = 'sysadmin,monadmin'，也可以只设置一个值，例如resilience_escape_user_permissions = 'monadmin'。
- 若该参数多次设置，以最新的设置生效。
- 该参数设置为取值范围中的任意值，普通用户都支持该逃生功能。
- 当用户同时具有sysadmin和monadmin时，resilience_escape_user_permissions必须要同时设置'sysadmin,monadmin'才能触发该用户的逃生功能。
