Miscellaneous Parameters

enable_default_ustore_table

Parameter description: Specifies whether to enable the UStore storage engine by default. If this parameter is set to on, all created tables are UStore tables.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: [off,on]

Default value: off

enable_ustore

Parameter description: Specifies whether to enable the Ustore storage engine. When this parameter is on, the creation of Ustore tables is supported. In particular, note that with Ustore tables, the track_counts and track_activities parameters must be turned on, otherwise it will cause space expansion.

This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: [off,on]

Default value: off

enable_segment

Parameter description: Specifies whether to use segmented page storage by default. When this parameter is on, segmented page storage is used by default. Note that it is automatically set to on during installation under resource pooling to improve ease of use.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: [off,on]

Default value: off

reserve_space_for_nullable_atts

Parameter description: Specifies whether to reserve space for the nullable attribute of an Ustore table. If this parameter is set to on, space is reserved for the nullable attribute of the Ustore table by default.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: [off,on]

Default value: on

ustore_attr

Parameter description: Specifies the UStore test parameters.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

You can set enable_ustore_partial_seqscan (copy selective columns only during sequential scanning in the ustore table), enable_candidate_buf_usage_count (whether dirty pages are evicted and added to the use count weight), and ustats_tracker_naptime (time for reloading the statistics file). umax_search_length_for_prune (number of blocks to be pruned before table extension) and ustore_unit_test (starting the UStore white box test). The setting method is ustore_attr ='enable_ustore_partial_seqscan=on'.

Value range: a string

server_version

Parameter description: Specifies the server version number.

This parameter is a fixed parameter of the INTERNAL type. It can be viewed but cannot be modified. This parameter is inherited from the PostgreSQL kernel, indicating that the current database kernel is compatible with the server_version version corresponding to PostgreSQL. This parameter is reserved to ensure the ecosystem compatibility of the northbound external tool interface (query when the tool is connected). This parameter is not recommended. To query the server version, use the opengauss_version() function.

Value range: a string

Default value: 9.2.4

server_version_num

Parameter description: Specifies the server version number.

This parameter is a fixed parameter of the INTERNAL type. It can be viewed but cannot be modified. This parameter is inherited from the PostgreSQL kernel, indicating that the current database kernel is compatible with the server_version_num version corresponding to PostgreSQL. This parameter is reserved to ensure the ecosystem compatibility of the northbound external tool API. (query when the tool is connected).

Value range: an integer

Default value: 90204

block_size

Parameter description: Specifies the block size of the current database.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Value:8192

Default value: 8192

segment_size

Parameter description: Specifies the segment file size of the current database.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Unit: 8 kB

Default value: 131072, that is, 1 GB

max_index_keys

Parameter description: Specifies the maximum number of index keys supported by the current database.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Default value: 32

integer_datetimes

Parameter description: Specifies whether the date and time are in the 64-bit integer format.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Value range: Boolean

• on indicates that the 64-bit integer format is used.
• off indicates that the 64-bit integer format is not used.

Default value: on

lc_collate

Parameter description: Specifies the locale in which sorting of textual data is done.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Default value: Determined by the configuration set during the MogDB installation and deployment.

lc_ctype

Parameter description: Specifies the locale that determines character classifications. For example, it specifies what a letter and its upper-case equivalent are.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Default value: Determined by the configuration set during the MogDB installation and deployment.

max_identifier_length

Parameter description: Specifies the maximum identifier length.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Value range: an integer

Default value: 63

server_encoding

Parameter description: Specifies the database encoding (character set).

By default, gs_initdb will initialize the setting of this parameter based on the current system environment. You can also run the locale command to check the current configuration environment.

This parameter is an INTERNAL parameter. The value of this parameter cannot be modified.

Default value: determined by the current system environment when the database is created.

enable_upgrade_merge_lock_mode

Parameter description: If this parameter is set to on, the delta merge operation internally increases the lock level, and errors can be prevented when update and delete operations are performed at the same time.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

• If this parameter is set to on, the delta merge operation internally increases the lock level. In this way, when the DELTAMERGE operation is concurrently performed with the UPDATE or DELETE operation, one operation can be performed only after the previous one is complete.
• If this parameter is set to off, and any two of the DELTAMERGE, UPDATE, and DELETE operations are concurrently performed to data in a row in the delta table of the HDFS table, errors will be reported during the later operation, and the operation will stop.

Default value: off

transparent_encrypted_string

Parameter description: Specifies a sample string that is transparently encrypted. Its value is generated by encrypting TRANS_ENCRYPT_SAMPLE_STRING using a database secret key. The ciphertext is used to check whether the DEK obtained during secondary startup is correct. If it is incorrect, database nodes will not be started. This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters. This parameter applies only to the DWS scenario in the current version.

Value range: a string. An empty string indicates that MogDB is a not encrypted.

Default value: empty

NOTE: Do not set this parameter manually. Otherwise, MogDB may become faulty.

transparent_encrypt_kms_url

Parameter description: Specifies the URL for obtaining the database secret key to be transparently encrypted. It must contain only the characters specified in RFC3986, and the maximum length is 2047 bytes. The format is kms://Protocol@KMS host name 1;KMS host name 2:KMS port number/kms, for example, kms://https@linux175:29800/.

This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters. This parameter applies only to the DWS scenario in the current version.

Value range: a string

Default value: empty

transparent_encrypt_kms_region

Parameter description: Specifies the deployment region of MogDB. It must contain only the characters specified in RFC3986, and the maximum length is 2047 bytes. This parameter applies only to the DWS scenario in the current version.

This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: a string

Default value: empty

basebackup_timeout

Parameter description: Specifies the timeout period for connection during which no read/write operations are performed after backup transmission is complete. When the gs_basebackup tool is used for transmission, if a higher compression rate is specified, the timeout may occur after the tablespace transmission is complete. (The transmission data needs to be compressed in the client.)

Value range: an integer ranging from 0 to INT_MAX. The unit is second. 0: indicates that the parameter is disabled.

Default value: 600s

datanode_heartbeat_interval

Parameter description: Specifies the interval at which heartbeat messages are sent between heartbeat threads. You are advised to set this parameter to a value no more than wal_receiver_timeout/2.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: an integer ranging from 1000 to 60000. The unit is ms.

Default value: 1s

max_concurrent_autonomous_transactions

Parameter description: Specifies the maximum number of autonomous transaction connections, that is, the maximum number of concurrent autonomous transactions executed at the same time. If this parameter is set to 0, autonomous transactions cannot be executed.

This parameter is an POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: 0-1024

Default value: 10

enable_seqscan_fusion

Parameter description: Controls whether SeqScan optimization is enabled.

This parameter is an SUSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

• on means enable SeqScan optimization
• off means disable SeqScan optimization

Default value: off

Description: This parameter can only optimize the execution time of the seqscan operator for the EXPLAIN ANALYZE statement.

sql_ignore_strategy

Parameter description: In B-compatible mode, this parameter controls the processing policy of the ignore_error hint when non-null constraints are violated.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

NOTE: For details about the ignore_error hint, see [Hint for Degrading Some Errors to Warnings](../../performance-tuning/2-sql/9-hint-based-tuning.md#Hint for Degrading Some Errors to Warnings).

Value range: enumerated values

• ignore_null: ignores rows that violate non-null constraints.
• overwrite_null: overwrites the null value that violates the constraint to the default value of the target type.

Default value: ignore_null

view_independent

Parameter description: This parameter controls whether the view is decoupled from its dependencies.

This parameter is a SIGHUP parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: [true, false]

• true: Views are decoupled from their dependencies and support updating view dependencies individually.
• false: Behavior is kept forward compatible, i.e., modifying view dependencies will result in an error

Default value: false

emit_illegal_bind_chars

Parameter description: This parameter is used to control whether or not to report errors for illegal characters.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

• on: indicates that errors are reported for illegal characters
• off: indicates no error reporting

Default value: off

acceleration_with_compute_pool

Parameter description: When a query contains OBS, this parameter is used to determine whether the query is accelerated through the compute resource pool. (Due to specification changes, this feature is no longer supported in the current version, so please do not use it)

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

• on: indicates that queries containing OBS or are accelerated through the compute resource pool when the compute resource pool is available, and the decision to accelerate the query through the compute resource pool is based on a cost evaluation.
• off: indicates that any query will not be accelerated through the compute resource pool.

Default value: off

dfs_partition_directory_length

Parameter description: The upper limit on the length of a directory name when constructing a partitioned directory for an HDFS VALUE partitioned table on an HDFS file system.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: 92-7999

Default value: 512

max_resource_package

Parameter description: Accelerates the upper limit on the number of threads per database node that can run tasks simultaneously.

This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: 0~2147483647

Default value: 0

cluster_run_mode

Parameter description: Sets the type of shared storage cluster.

This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: enumeration type

• cluster_primary

• cluster_standby

Default value: cluster_primary

enable_event_trigger_a_mode

Parameter description: Controls whether event triggers are enabled in A-compatible mode.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

Default value: off

enable_tidrangescan

Parameter description: Controls whether the planner uses the tidrangescan plan.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

Default value: on

force_tidrangescan

Parameter description: Controls whether the execution plan forces tidrangescan to be used in parallel for the gs_dump tool.

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

Default value: off

plan_cache_type_validation

Parameter description: Disable pbe result type checking to allow users to change plan cache results in real time.

This parameter is a POSTMASTER parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

Default value: on

enable_cache_function_result

Parameter description: Controls whether the function result caching feature is enabled. For related feature, see Statement Level PLSQL Function Cache Support。

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: Boolean

Default value: off

function_result_cache_max_mem

Parameter description: Controls the maximum size of memory that can be used by the function result cache. For related feature, see Statement Level PLSQL Function Cache Support。

This parameter is a USERSET parameter. Set it based on instructions provided in Table 1 GUC parameters.

Value range: 1024 ~ INT_MAX，unit in kb.

Default value: 16*1024