📣

TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →

Get Started

Overview

Quick Start

Guides

Connect
Manage Resources
Data Integration
Load Data
Unload Data
Multimodal Data Analytics
Performance Tuning
Security & Reliability
Management

Troubleshooting

Tutorials

Ingest & Stream Data
Migrate Data

Reference

SQL Reference
General Reference

Support Services

Worker

Worker-related SQL commands for deployments with cloud control enabled.

Note

Worker management commands require cloud control. If cloud_control_grpc_server_address is not configured, TiDB Cloud Lake returns a CloudControlNotEnabled error when you run these commands.

Supported Statements

Statement	Purpose
`CREATE WORKER`	Creates a worker with an optional key-value option list
`ALTER WORKER`	Updates worker tags or options, or changes worker state
`DROP WORKER`	Deletes a worker
`SHOW WORKERS`	Lists workers in the current tenant

Command Reference

Command	Description
CREATE WORKER	Creates a worker definition
ALTER WORKER	Modifies worker tags, options, or state
DROP WORKER	Removes a worker definition
SHOW WORKERS	Lists workers and their metadata
Examples	Shows validated worker SQL examples

Notes

Option names are case-insensitive. TiDB Cloud Lake normalizes them to lowercase during planning.
SHOW WORKERS returns the columns name, tags, options, created_at, and updated_at.
ALTER WORKER supports SET TAG, UNSET TAG, SET, UNSET, SUSPEND, and RESUME.
CREATE WORKER does not support a TAG clause.

Worker

Supported Statements

Command Reference

Notes

Was this page helpful?