- Key Features
- Horizontal Scalability
- MySQL Compatible Syntax
- Replicate from and to MySQL
- Distributed Transactions with Strong Consistency
- Cloud Native Architecture
- Minimize ETL with HTAP
- Fault Tolerance & Recovery with Raft
- Automatic Rebalancing
- Deployment and Orchestration with Ansible, Kubernetes, Docker
- JSON Support
- Spark Integration
- Read Historical Data Without Restoring from Backup
- Fast Import and Restore of Data
- Hybrid of Column and Row Storage
- SQL Plan Management
- Open Source
- Online Schema Changes
- Get Started
- MySQL Compatibility
- SQL Language Structure
- Data Types
- Functions and Operators
- Function and Operator Reference
- Type Conversion in Expression Evaluation
- Control Flow Functions
- String Functions
- Numeric Functions and Operators
- Date and Time Functions
- Bit Functions and Operators
- Cast Functions and Operators
- Encryption and Compression Functions
- Information Functions
- JSON Functions
- Aggregate (GROUP BY) Functions
- Miscellaneous Functions
- Precision Math
- SQL Statements
ADMIN CANCEL DDL
ADMIN CHECKSUM TABLE
ADMIN CHECK [TABLE|INDEX]
ADMIN SHOW DDL [JOBS|QUERIES]
CREATE TABLE LIKE
SET [NAMES|CHARACTER SET]
SET [GLOBAL|SESSION] <variable>
SHOW CHARACTER SET
SHOW [FULL] COLUMNS FROM
SHOW CREATE TABLE
SHOW [FULL] FIELDS FROM
SHOW INDEXES [FROM|IN]
SHOW INDEX [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW [FULL] PROCESSSLIST
SHOW [FULL] TABLES
SHOW TABLE STATUS
SHOW [GLOBAL|SESSION] VARIABLES
- Generated Columns
- Character Set
- System Databases
- Errors Codes
- Supported Client Drivers
- Garbage Collection (GC)
- Key Monitoring Metrics
- Alert Rules
- Best Practices
- TiDB Binlog
- Use Cases
- TiDB Data Migration
- TiDB Lightning
- PD Control
- PD Recover
- TiKV Control
- TiDB Control
- All Releases
You are viewing the documentation of an older version of the TiDB database (TiDB v2.1).
TiDB Lightning provides a webpage for viewing the import progress and performing some simple task management. This is called the server mode.
To enable server mode, either start
tidb-lightning with the
./tidb-lightning --server-mode --status-addr :8289
or set the
lightning.server-mode setting in the configuration file.
[lightning] server-mode = true status-addr = ':8289'
After TiDB Lightning is launched, visit
http://127.0.0.1:8289 to control the program (the actual URL depends on the
In server mode, TiDB Lightning does not start running immediately. Rather, users submit (multiple) tasks via the web interface to import data.
Functions of the title bar, from left to right:
|"TiDB Lightning"||Click to go back to the front page|
|⚠||Display any error message from previous task|
|ⓘ||List current and queued tasks; a badge may appear here to indicate number of queued tasks|
|+||Submit a task|
|⏸/▶||Pause/resume current execution|
|⟳||Configure auto-refresh of the web page|
Three panels below the title bar show all tables in different states:
- Active: these tables are currently being imported
- Completed: these tables have been imported successfully or failed
- Pending: these tables are not yet processed
Each panel contains cards describing the status of the table.
Click the + button on the title bar to submit a task.
Tasks are TOML files described as task configurations. One could also open a local TOML file by clicking UPLOAD.
Click SUBMIT to run the task. If a task is already running, the new task will be queued and executed after the current task succeeds.
Click the > button of a table card on the front page to view the detailed progress of a table.
The page shows the import progress of every engine and data files associated with the table.
Click TiDB Lightning on the title bar to go back to the front page.
Click the ⓘ button on the title bar to manage the current and queued tasks.
Each task is labeled by the time it was submitted. Clicking the task would show the configuration formatted as JSON.
Manage tasks by clicking the ⋮ button next to a task. You can stop a task immediately, or reorder queued tasks.