Skip to main content

Module global

Module global 

Source
Expand description

Global runtimes

Macrosยง

define_global_runtime_spawn ๐Ÿ”’
define_scheduled_spawn ๐Ÿ”’
define_spawn ๐Ÿ”’

Structsยง

ConfigRuntimes ๐Ÿ”’
GlobalRuntimes ๐Ÿ”’
RuntimeOptions
The options for the global runtimes.
WorkloadSchedulerOptions
Experimental options for sharing Tokio capacity between query and write workloads.

Constantsยง

COMPACT_WORKERS ๐Ÿ”’
GLOBAL_WORKERS ๐Ÿ”’
HB_WORKERS ๐Ÿ”’
MIN_RUNTIME_THREADS ๐Ÿ”’
The minimum number of worker threads for runtimes sized by CPU count. A single-threaded runtime can easily deadlock in async code.
QUERY_TASK_CLASS ๐Ÿ”’
WRITE_TASK_CLASS ๐Ÿ”’

Staticsยง

CONFIG_RUNTIMES ๐Ÿ”’
GLOBAL_RUNTIMES ๐Ÿ”’
START ๐Ÿ”’

Functionsยง

block_on_compact
Run a future to complete in compact thread pool.
block_on_global
Run a future to complete in global thread pool.
block_on_hb
Run a future to complete in hb thread pool.
block_on_ingest
Run a future to complete in ingest thread pool.
block_on_query
Run a future to complete in query thread pool.
compact_runtime
Returns the global compact thread pool.
create_compact_runtime ๐Ÿ”’
create_runtime
create_workload_scheduler ๐Ÿ”’
global_runtime
Returns the global global thread pool.
hb_runtime
Returns the global hb thread pool.
ingest_runtime
Returns the global ingest thread pool.
init_common_runtimes ๐Ÿ”’
init_datanode_runtimes
Initialize runtimes for a datanode process.
init_global_runtimes
Initialize runtimes for frontend, metasrv, and flownode processes.
init_standalone_runtimes
Initialize runtimes for a standalone process.
query_runtime
Returns the global query thread pool.
set_workload_scheduler_enabled
Enables or disables the experimental workload scheduler for new spawn submissions. Returns false when no scheduler was constructed at startup.
set_workload_scheduler_weights
Sets the query and write weights atomically. Returns false when no scheduler was constructed at startup.
spawn_blocking_compact
Run the blocking operation in compact thread pool.
spawn_blocking_global
Run the blocking operation in global thread pool.
spawn_blocking_hb
Run the blocking operation in hb thread pool.
spawn_blocking_ingest
Run the blocking operation in ingest thread pool.
spawn_blocking_query
Run the blocking operation in query thread pool.
spawn_compact
Spawn a future and execute it in compact thread pool.
spawn_global
Spawn a future and execute it in global thread pool.
spawn_hb
Spawn a future and execute it in hb thread pool.
spawn_ingest
Spawn a future and execute it in ingest thread pool.
spawn_query
Spawn a future and execute it in query thread pool.
workload_scheduler_enabled
Returns whether the experimental workload scheduler is currently enabled. Returns false when no scheduler was constructed at startup.
workload_scheduler_stats
Returns scheduler counters when the experimental workload scheduler was constructed at startup, including while it is dynamically disabled.