Tenant parameter list description - ApsaraDB for OceanBase

This topic describes the tenant parameters.

Tenant parameter list

Parameter	Description
connect_timeout	Connection timeout, in seconds.
ob_check_sys_variable	If enabled, system variables will be updated when the schema version changes.
writing_throttling_maximum_duration	The time required to allocate the remaining MemStore memory after the write speed limit is triggered.
div_precision_increment	Increment of the precision of the result of a division by the precision of the dividend. MySQL-compatible feature.
ob_sql_work_area_percentage	The tenant memory percentage limit for SQL execution.
tx_isolation	Transaction isolation level.
wait_timeout	The number of seconds the server waits for activity before closing a noninteractive connection. At thread start, the session wait_timeout value is initialized from either the global wait_timeout value or the global interactive_timeout value, depending on the client type (as defined by the CLIENT_INTERACTIVE connection option in mysql_real_connect ()). See also interactive_timeout.
auto_increment_increment	Auto-increment step. Only used for MySQL client login.
foreign_key_checks	Whether to check foreign key constraints.
autocommit	Whether to submit automatically.
read_only	Whether the tenant is in read-only mode. Affects all common users under the tenant, but does not affect root users.
ob_trx_timeout	Transaction timeout, in microseconds.
net_read_timeout	The number of seconds to wait for additional data from the connection before terminating the read. When the server is reading from a client, net_read_timeout is the timeout value that controls when to terminate.
ob_enable_index_direct_select	Whether to allow users to query the index table directly.
ob_enable_trace_log	Whether to use trace logs.
ob_trx_lock_timeout	Transaction lock timeout, in microseconds.
sql_throttle_rt	Response time (RT), in microseconds. If the RT value of a query is not less than this value, the query is not allowed to be executed.
ob_enable_transmission_checksum	Whether to perform checksum on data packets between OceanBase Database Proxy (ODP) and OBServer nodes.
ob_early_lock_release	Whether to enable the early lock release (ELR) optimization for transactions.
writing_throttling_trigger_percentage	Write speed threshold.
ob_plan_cache_evict_low_percentage	The memory usage percentage that stops plan cache eviction.
ob_plan_cache_percentage	The percentage of the tenant memory that can be used by the plan cache.
max_sp_recursion_depth	The number of times any given stored procedure can be called recursively.
sql_throttle_network	Network usage threshold. When the network usage exceeds this threshold, the SQL statement will not be executed.
ob_enable_hash_group_by	Whether to open the `Hash Group by` path.
undo_retention	Multi-version data retention period, in seconds.
query_cache_type	Query cache type. OFF: Do not cache or retrieve results; ON: Cache all results except SELECT SQL_NO_CACHE ... queries; DEMAND: Only cache the results of SELECT SQL_CACHE ... queries.
sql_throttle_logical_reads	Logical read quantity threshold. If the logical read quantity exceeds this threshold, the SQL statement will not be executed.
auto_increment_cache_size	Number of auto-increment caches.
sql_auto_is_null	Whether to obtain the auto-increment column value of the last inserted row. This parameter is used by some special drivers, such as ODBC.
recyclebin	The switch of the recycle bin. If the switch is turned on, the database objects will go to the recycle bin after being deleted.
ob_enable_plan_cache	Whether to enable Plan Cache.
ob_enable_aggregation_pushdown	Whether to allow aggregation operations to be pushed down.
net_write_timeout	The number of seconds to wait for a block to be written to a connection before aborting the write. When the server is writing to a client, net_write_timeout is the timeout value that controls when to abort.
ob_enable_transformation	Whether to allow SQL rewrite.
sql_quote_show_create	Whether to quote identifiers for the SHOW CREATE TABLE and SHOW CREATE DATABASE statements.
sql_throttle_io	The threshold of I/O operations. If this number is exceeded, the SQL statement will not be executed.
ob_enable_jit	Just-in-time (JIT) execution engine mode. OFF: disables expression compilation and execution for the current session. AUTO: enables expression compilation and execution for the current session only when the average response time of SQL statement execution is greater than 1s. FORCE: forcibly enables expression compilation and execution for the current session.
max_stale_time_for_weak_consistency	The synchronization delay allowed between the primary and standby clusters for weak consistency reads.
ob_enable_truncate_flashback	Whether the object of the Truncate operation goes into the recycle bin. Note This parameter has been deprecated since OceanBase Database V4.x. You can still query and set it in the parameter management list, but the related functions will not take effect.
ob_trx_idle_timeout	Transaction idle timeout, that is, the transaction times out when the execution interval between two statements exceeds this value, in microseconds.
optimizer_capture_sql_plan_baselines	Whether to enable automatic capture of SQL plan baselines.
ob_enable_blk_nestedloop_join	Whether to enable Block Nested Loop Join.
auto_increment_offset	The start value of an auto-increment column.
ob_read_consistency	Read consistency level.
ob_create_table_strict_mode	Whether to enable the strict mode for table creation. 1: Replicas are created in strict accordance with the locality. Table creation fails if a replica fails to be created. 0: Table creation is successful when at least one full replica is created and replicas that can serve as Paxos group members constitute the majority.
block_encryption_mode	The encryption algorithm used in the AES_ENCRYPT() and AES_DECRYPT() functions.
sql_throttle_cpu	CPU usage threshold. When the CPU usage exceeds this threshold, the SQL statement will not be executed.
error_on_overlap_time	A dynamic variable used to specify whether to report an error in case of an ambiguous boundary datetime value, a case in which it is not clear whether the datetime is in standard or daylight saving time.
interactive_timeout	The number of seconds the server waits for activity before closing an interactive connection. An interactive client is defined as one that uses the CLIENT_INTERACTIVE option in mysql_real_connect (). See also wait_timeout.
query_cache_size	The memory allocated to store old query results (unused), in bytes.
max_allowed_packet	Maximum network packet size, in bytes.
ob_query_timeout	Query timeout, in microseconds.
sql_throttle_priority	SQL priority threshold. SQLs with a SQL priority lower than this will not be executed.
ob_plan_cache_evict_high_percentage	The memory usage percentage that triggers plan cache eviction.
explicit_defaults_for_timestamp	Whether to enable non-standard behaviors for processing default values and NULL values in TIMESTAMP columns.
sql_mode	The SQL mode. Database actions vary greatly with the SQL mode.
optimizer_use_sql_plan_baselines	Whether to enable the use of SQL plan baselines.
sql_warnings	Whether to generate an information string for single-row INSERT statements in the event of an alert.
ob_default_replica_num	The default number of table replicas in each cluster.
group_concat_max_len	The maximum length of the result of the GROUP_CONCAT() function, in bytes.
sql_throttle_current_priority	SQL throttling priority.