Skip to content

Commit

Permalink
docs: add descriptions for scan_block_size and scan_yield_interval
Browse files Browse the repository at this point in the history
  • Loading branch information
YoshiakiNishimura committed Oct 11, 2024
1 parent 0167c48 commit 2219cf0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/config-parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Target component
| `lowercase_regular_identifiers` | Boolean (true/false) | Whether to convert table and column names into lowercase internally. The default value is false.||
| `stealing_enabled` | Boolean (true/false) | Whether the scheduler steals tasks to utilize idle CPU cores. The default value is true. |
| `thread_pool_size` | Integer | Number of threads used by the task scheduler in the SQL service. The default value is set according to the environment by the following formula. <ul><li>`MIN(<default worker coefficient> * <number of physical cores>, <maximum default worker count>)` </li><li>If the result is less than 1, it is set to 1. </li><li>the `<default worker coefficient>` is 0.8 </li><li>the `<maximum default worker count>` is 32.</ul> |
| `scan_block_size` | Integer | The scan operator processes either the entire table or a specific range of data. When the range to be processed is large, the processing thread may become unresponsive. To prevent this, the scan operator limits the maximum number of records processed before yielding to other tasks. The default limit is 100 records. |
| `scan_yield_interval` | Integer | Similar to scan_block_size, the scan_yield_interval parameter also imposes a limit on the records processed by the scan operator, but this limit is based on time in milliseconds. Since scan_block_size takes precedence over scan_yield_interval, if scan_block_size is set too high, the effectiveness of scan_yield_interval is effectively negated. The default time is 1 millisecond. |

## `ipc_endpoint` section

Expand Down

0 comments on commit 2219cf0

Please sign in to comment.