package externalworkloadpb
Get desktop application:
View/edit binary Protocol Buffers messages
ExternalWorkloadController is the service that an external controller exposes to TiDB instances. TiDB calls into it to register and recycle background workloads (GC, distributed background subtasks, TTL, auto-analyze, remote queries) so that the controller can run them on dedicated TiDB instances and scale those instances on demand.
DeleteTTLTableInfo notifies the controller that a table no longer has TTL or has been dropped.
message
externalworkloadpb.proto:197optional header = 1
int64 table_id = 2
table_id is the ID of the table that no longer has TTL or has been dropped.
GetBgTaskConfig returns the worker-pool configuration for a background task type.
message
externalworkloadpb.proto:128optional header = 1
string worker_type = 2
worker_type is the background worker type being queried.
message
externalworkloadpb.proto:134optional error = 1
uint32 worker_count = 2
worker_count is the worker-pool size the controller has provisioned for this type.
bool auto_scale_enabled = 3
auto_scale_enabled reports whether the controller auto-scales this worker type.
rpc Ping (, )
externalworkloadpb.proto:23Ping verifies that the controller is reachable.
message
externalworkloadpb.proto:66(message has no fields)
RecycleAutoAnalyze notifies the controller that an auto-analyze task has been completed.
message
externalworkloadpb.proto:222optional header = 1
uint64 task_id = 2
task_id is the ID of the completed auto-analyze task.
RecycleBgTask notifies the controller that a background subtask has been completed.
message
externalworkloadpb.proto:157optional header = 1
int64 global_task_id = 2
global_task_id is the ID of the task in mysql.tidb_global_task.
int64 sub_task_id = 3
sub_task_id is the ID of the subtask in mysql.tidb_background_subtask. A value of 0 recycles all subtasks of global_task_id.
rpc RecycleGC (, )
externalworkloadpb.proto:28RecycleGC notifies the controller that all GC delete-range entries at or before safe_point have been processed.
message
externalworkloadpb.proto:102optional header = 1
uint64 safe_point = 2
safe_point is the timestamp at or before which all delete-range entries have been processed.
RecycleGCV2 notifies the controller that all keyspace-level GC tasks at or before safe_point are finished.
message
externalworkloadpb.proto:116optional header = 1
uint64 safe_point = 2
safe_point is the timestamp at or before which all keyspace-level GC tasks have been processed.
RecycleTTLTask notifies the controller that a TTL job has completed.
message
externalworkloadpb.proto:203optional header = 1
uint64 completed_job_create_time = 2
completed_job_create_time is the greatest creation timestamp among TTL jobs that have completed on the calling TiDB.
RegisterAutoAnalyze notifies the controller that an auto-analyze task has been registered.
message
externalworkloadpb.proto:216optional header = 1
uint64 task_id = 2
task_id is the ID of the registered auto-analyze task.
RegisterBgTask notifies the controller that a background subtask has been created.
message
externalworkloadpb.proto:142optional header = 1
string task_type = 2
task_type is the worker type that should execute the subtask.
string task_key = 3
task_key is the key of the distributed task job.
int64 global_task_id = 4
global_task_id is the ID of the task in mysql.tidb_global_task.
int64 sub_task_id = 5
sub_task_id is the ID of the subtask in mysql.tidb_background_subtask. A value of 0 is used for a task-level guard entry.
string exec_id = 6
exec_id is the logical TiDB ID assigned to the subtask, or empty for a task-level guard entry.
RegisterGC notifies the controller that a new GC delete-range entry was inserted at deletion_ts.
message
externalworkloadpb.proto:96optional header = 1
uint64 deletion_ts = 2
deletion_ts is the timestamp at which a new delete-range row was inserted.
RegisterGCV2 notifies the controller that a round of keyspace-level GC has just been performed at safe_point. If no further heartbeats are received the controller should schedule another round after gc_life_time seconds elapse.
message
externalworkloadpb.proto:108optional header = 1
uint64 safe_point = 2
safe_point is the timestamp of the most recent keyspace-level GC.
int64 gc_life_time = 3
gc_life_time is the GC life time configured on the calling TiDB, in seconds.
RegisterRemoteQuery notifies the controller that a query is being executed remotely.
message
externalworkloadpb.proto:181optional header = 1
string query_id = 2
query_id is the ID of the query being executed remotely.
string query_address = 3
query_address is the address of the TiDB executing the query.
RegisterTTLTask notifies the controller that a table with TTL has been created or altered.
message
externalworkloadpb.proto:189optional header = 1
int64 table_id = 2
table_id is the ID of the table with TTL configured.
bool ttl_job_enable = 3
ttl_job_enable is the current value of the tidb_ttl_job_enable system variable.
UpdateBgTaskExecID notifies the controller that the exec IDs assigned to subtasks of a task have changed.
message
externalworkloadpb.proto:173optional header = 1
int64 global_task_id = 2
global_task_id is the ID of the task in mysql.tidb_global_task.
repeated assignments = 3
assignments are the subtask-to-exec-ID mappings being updated.
UpdateGCLifeTime notifies the controller that the user's gc_life_time changed.
message
externalworkloadpb.proto:122optional header = 1
int64 gc_life_time = 2
gc_life_time is the new gc_life_time value, in seconds.
UpdateTTLJobEnable notifies the controller that the tidb_ttl_job_enable system variable changed.
message
externalworkloadpb.proto:210optional header = 1
bool ttl_job_enable = 2
ttl_job_enable is the new value of the tidb_ttl_job_enable system variable.
message
externalworkloadpb.proto:80Used in: ,
ErrorType type = 1
string message = 2
Used in:
OK = 0
UNKNOWN = 1
PAUSED = 2
PAUSED indicates the controller has temporarily paused the corresponding handler.
message
externalworkloadpb.proto:87RequestHeader carries TiDB-side identity information used by the controller to route a request to the right pool.
Used in: , , , , , , , , , , , , , , ,
uint32 keyspace_id = 1
keyspace_id is the keyspace ID of the calling TiDB.
string keyspace_name = 2
keyspace_name is the keyspace name of the calling TiDB.
string tidb_pool = 3
tidb_pool is the pool the calling TiDB belongs to.
message
externalworkloadpb.proto:69Response is the standard reply for RPCs that only need to surface an Error.
Used as response type in: ExternalWorkloadController.DeleteTTLTableInfo, ExternalWorkloadController.Ping, ExternalWorkloadController.RecycleAutoAnalyze, ExternalWorkloadController.RecycleBgTask, ExternalWorkloadController.RecycleGC, ExternalWorkloadController.RecycleGCV2, ExternalWorkloadController.RecycleTTLTask, ExternalWorkloadController.RegisterAutoAnalyze, ExternalWorkloadController.RegisterBgTask, ExternalWorkloadController.RegisterGC, ExternalWorkloadController.RegisterGCV2, ExternalWorkloadController.RegisterRemoteQuery, ExternalWorkloadController.RegisterTTLTask, ExternalWorkloadController.UpdateBgTaskExecID, ExternalWorkloadController.UpdateGCLifeTime, ExternalWorkloadController.UpdateTTLJobEnable
optional error = 1
message
externalworkloadpb.proto:166Used in:
int64 sub_task_id = 1
sub_task_id is the ID of the subtask in mysql.tidb_background_subtask.
string exec_id = 2
exec_id is the logical TiDB ID assigned to the subtask.