Skip to content

Commit 593463d

Browse files
PsiACEPsiACE
authored
Merge pull request #10527 from PsiACE/settings
chore: update the descriptions of settings
2 parents 8c069bc + 48ed9e8 commit 593463d

File tree

5 files changed

+150
-144
lines changed

5 files changed

+150
-144
lines changed

‎docs/doc/14-sql-commands/40-show/show-settings.md‎

Lines changed: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,42 @@ SHOW SETTINGS
1616

1717
```sql
1818
SHOW SETTINGS;
19-
+---------------------------------+-------------+-------------+---------+-------------------------------------------------------------------------------------------------------------------+--------+
20-
| name | value | default | level | description | type |
21-
+---------------------------------+-------------+-------------+---------+-------------------------------------------------------------------------------------------------------------------+--------+
22-
| collation | binary | binary | SESSION | Char collation, support "binary" "utf8" default value: binary | String |
23-
| enable_cbo | 1 | 1 | SESSION | If enable cost based optimization, default value: 1. | UInt64 |
24-
| enable_distributed_eval_index | 1 | 1 | SESSION | If enable distributed eval index, default value: 1 | UInt64 |
25-
| flight_client_timeout | 60 | 60 | SESSION | Max duration the flight client request is allowed to take in seconds. By default, it is 60 seconds. | UInt64 |
26-
| format_compression | None | None | SESSION | Format compression, default value: "None". | String |
27-
| format_empty_as_default | 1 | 1 | SESSION | Format empty_as_default, default value: 1. | UInt64 |
28-
| format_escape | | | SESSION | format escape char, default value: "", which means the format`s default setting. | String |
29-
| format_field_delimiter | | | SESSION | Format field delimiter, default value is "": use default of the format. | String |
30-
| format_nan_display | | | SESSION | must be literal `nan` or `null` (case-sensitive), default value is "". | String |
31-
| format_quote | | | SESSION | The quote char for format. default value is "": use default of the format. | String |
32-
| format_record_delimiter | | | SESSION | Format record_delimiter, default value is "": use default of the format. | String |
33-
| format_skip_header | 0 | 0 | SESSION | Whether to skip the input header, default value: 0. | UInt64 |
34-
| group_by_two_level_threshold | 100000 | 100000 | SESSION | The threshold of keys to open two-level aggregation, default value: 10000. | UInt64 |
35-
| input_read_buffer_size | 1048576 | 1048576 | SESSION | The size of buffer in bytes for input with format. By default, it is 1MB. | UInt64 |
36-
| load_file_metadata_expire_hours | 168 | 168 | SESSION | How many hours will the COPY file metadata expired in the metasrv, default value: 24*7=7days | UInt64 |
37-
| max_block_size | 65536 | 65536 | SESSION | Maximum block size for reading, default value: 65536. | UInt64 |
38-
| max_execute_time | 0 | 0 | SESSION | The maximum query execution time. it means no limit if the value is zero. default value: 0. | UInt64 |
39-
| max_memory_usage | 26771259392 | 26771259392 | SESSION | The maximum memory usage for processing single query, in bytes. By default the value is determined automatically. | UInt64 |
40-
| max_storage_io_requests | 1000 | 1000 | SESSION | The maximum number of concurrent IO requests. By default, it is 64. | UInt64 |
41-
| max_threads | 24 | 24 | SESSION | The maximum number of threads to execute the request. By default the value is determined automatically. | UInt64 |
42-
| prefer_broadcast_join | 0 | 0 | SESSION | If enable broadcast join, default value: 0 | UInt64 |
43-
| quoted_ident_case_sensitive | 1 | 1 | SESSION | Case sensitivity of quoted identifiers, default value: 1 (aka case-sensitive). | UInt64 |
44-
| row_tag | row | row | SESSION | In xml format, this field is represented as a row tag, e.g. <row>...</row>. | String |
45-
| sql_dialect | PostgreSQL | PostgreSQL | SESSION | SQL dialect, support "PostgreSQL" "MySQL" and "Hive", default value: "PostgreSQL". | String |
46-
| storage_read_buffer_size | 1048576 | 1048576 | SESSION | The size of buffer in bytes for buffered reader of dal. By default, it is 1MB. | UInt64 |
47-
| timezone | UTC | UTC | SESSION | Timezone, default value: "UTC". | String |
48-
| unquoted_ident_case_sensitive | 0 | 0 | SESSION | Case sensitivity of unquoted identifiers, default value: 0 (aka case-insensitive). | UInt64 |
49-
+---------------------------------+-------------+-------------+---------+-------------------------------------------------------------------------------------------------------------------+--------+
19+
+---------------------------------------+-------------+-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------+
20+
| name | value | default | level | description | type |
21+
+---------------------------------------+-------------+-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------+
22+
| collation | binary | binary | SESSION | Sets the character collation. Available values include "binary" and "utf8". | String |
23+
| enable_bushy_join | 0 | 0 | SESSION | Enables generating a bushy join plan with the optimizer. | UInt64 |
24+
| enable_cbo | 1 | 1 | SESSION | Enables cost-based optimization. | UInt64 |
25+
| enable_distributed_eval_index | 1 | 1 | SESSION | Enables evaluated indexes to be created and maintained across multiple nodes. | UInt64 |
26+
| enable_query_result_cache | 0 | 0 | SESSION | Enables caching query results to improve performance for identical queries. | UInt64 |
27+
| enable_runtime_filter | 0 | 0 | SESSION | Enables runtime filter optimization for JOIN. | UInt64 |
28+
| flight_client_timeout | 60 | 60 | SESSION | Sets the maximum time in seconds that a flight client request can be processed. | UInt64 |
29+
| group_by_two_level_threshold | 20000 | 20000 | SESSION | Sets the number of keys in a GROUP BY operation that will trigger a two-level aggregation. | UInt64 |
30+
| hide_options_in_show_create_table | 1 | 1 | SESSION | Hides table-relevant information, such as SNAPSHOT_LOCATION and STORAGE_FORMAT, at the end of the result of SHOW TABLE CREATE. | UInt64 |
31+
| input_read_buffer_size | 1048576 | 1048576 | SESSION | Sets the memory size in bytes allocated to the buffer used by the buffered reader to read data from storage. | UInt64 |
32+
| load_file_metadata_expire_hours | 168 | 168 | SESSION | Sets the hours that the metadata of files you load data from with COPY INTO will expire in. | UInt64 |
33+
| max_block_size | 65536 | 65536 | SESSION | Sets the maximum byte size of a single data block that can be read. | UInt64 |
34+
| max_execute_time | 0 | 0 | SESSION | Sets the maximum query execution time in seconds. Setting it to 0 means no limit. | UInt64 |
35+
| max_inlist_to_or | 3 | 3 | SESSION | Sets the maximum number of values that can be included in an IN expression to be converted to an OR operator. | UInt64 |
36+
| max_memory_usage | 12911303065 | 12911303065 | SESSION | Sets the maximum memory usage in bytes for processing a single query. | UInt64 |
37+
| max_result_rows | 0 | 0 | SESSION | Sets the maximum number of rows that can be returned in a query result when no specific row count is specified. Setting it to 0 means no limit. | UInt64 |
38+
| max_storage_io_requests | 48 | 48 | SESSION | Sets the maximum number of concurrent I/O requests. | UInt64 |
39+
| max_threads | 16 | 16 | SESSION | Sets the maximum number of threads to execute a request. | UInt64 |
40+
| parquet_uncompressed_buffer_size | 2097152 | 2097152 | SESSION | Sets the byte size of the buffer used for reading Parquet files. | UInt64 |
41+
| prefer_broadcast_join | 1 | 1 | SESSION | Enables broadcast join. | UInt64 |
42+
| query_result_cache_allow_inconsistent | 0 | 0 | SESSION | Determines whether Databend will return cached query results that are inconsistent with the underlying data. | UInt64 |
43+
| query_result_cache_max_bytes | 1048576 | 1048576 | SESSION | Sets the maximum byte size of cache for a single query result. | UInt64 |
44+
| query_result_cache_ttl_secs | 300 | 300 | SESSION | Sets the time-to-live (TTL) in seconds for cached query results. Once the TTL for a cached result has expired, the result is considered stale and will not be used for new queries. | UInt64 |
45+
| quoted_ident_case_sensitive | 1 | 1 | SESSION | Determines whether Databend treats quoted identifiers as case-sensitive. | UInt64 |
46+
| retention_period | 12 | 12 | SESSION | Sets the retention period in hours. | UInt64 |
47+
| sandbox_tenant | | | SESSION | Injects a custom 'sandbox_tenant' into this session. This is only for testing purposes and will take effect only when 'internal_enable_sandbox_tenant' is turned on. | String |
48+
| spilling_bytes_threshold_per_proc | 0 | 0 | SESSION | Sets the maximum amount of memory in bytes that an aggregator can use before spilling data to storage during query execution. | UInt64 |
49+
| sql_dialect | PostgreSQL | PostgreSQL | SESSION | Sets the SQL dialect. Available values include "PostgreSQL", "MySQL", and "Hive". | String |
50+
| storage_fetch_part_num | 2 | 2 | SESSION | Sets the number of partitions that are fetched in parallel from storage during query execution. | UInt64 |
51+
| storage_io_max_page_bytes_for_read | 524288 | 524288 | SESSION | Sets the maximum byte size of data pages that can be read from storage in a single I/O operation. | UInt64 |
52+
| storage_io_min_bytes_for_seek | 48 | 48 | SESSION | Sets the minimum byte size of data that must be read from storage in a single I/O operation when seeking a new location in the data file. | UInt64 |
53+
| storage_read_buffer_size | 1048576 | 1048576 | SESSION | Sets the byte size of the buffer used for reading data into memory. | UInt64 |
54+
| timezone | UTC | UTC | SESSION | Sets the timezone. | String |
55+
| unquoted_ident_case_sensitive | 0 | 0 | SESSION | Determines whether Databend treats unquoted identifiers as case-sensitive. | UInt64 |
56+
+---------------------------------------+-------------+-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------+
5057
```

0 commit comments

Comments
 (0)