tidb-lightning
This repository has been moved to https://github.com/pingcap/br
File Explorer
Download Latest Version (.zip)- bug-report.md
- feature-request.md
- question.md
- challenge-bot.yml
- pull_request_template.md
- main.go
- main_test.go
- main.go
- main_test.go
- allocator.go
- backend.go
- backend_test.go
- checkreq_test.go
- importer.go
- importer_test.go
- local.go
- local_test.go
- local_unix.go
- local_windows.go
- localhelper.go
- localhelper_test.go
- session.go
- session_test.go
- sql2kv.go
- sql2kv_test.go
- tidb.go
- tidb_test.go
- tikv.go
- tikv_test.go
- checkpoints.go
- checkpoints_file_test.go
- checkpoints_sql_test.go
- checkpoints_test.go
- file_checkpoints.pb.go
- file_checkpoints.proto
- glue_checkpoint.go
- tidb.go
- once_error.go
- once_error_test.go
- pause.go
- pause_test.go
- security.go
- security_test.go
- storage.go
- storage_test.go
- storage_unix.go
- storage_windows.go
- util.go
- util_test.go
- version.go
- version_test.go
- bytesize.go
- bytesize_test.go
- config.go
- config_test.go
- configlist.go
- configlist_test.go
- const.go
- global.go
- glue.go
- log.go
- log_test.go
- redact.go
- testlogger.go
- manual.go
- manual_nocgo.go
- metric.go
- metric_test.go
- split_large_file.csv
- metadata
- mocker_test-schema-create.sql
- mocker_test.i-schema.sql
- mocker_test.i.sql
- mocker_test.report_case_high_risk-schema.sql
- mocker_test.report_case_high_risk.sql
- mocker_test.tbl_autoid-schema.sql
- mocker_test.tbl_autoid.sql
- mocker_test.tbl_multi_index-schema.sql
- mocker_test.tbl_multi_index.sql
- bytes.go
- csv_parser.go
- csv_parser_test.go
- loader.go
- loader_test.go
- parquet_parser.go
- parquet_parser_test.go
- parser.go
- parser.rl
- parser_generated.go
- parser_test.go
- reader.go
- reader_test.go
- region.go
- region_test.go
- router.go
- router_test.go
- checksum.go
- checksum_test.go
- const.go
- restore.go
- restore_test.go
- tidb.go
- tidb_test.go
- checksum.go
- checksum_test.go
- progress.go
- res.go
- res_vfsdata.go
- worker.go
- worker_test.go
- lightning.go
- lightning_test.go
- sigusr1_other.go
- sigusr1_unix.go
- lightning.rules.yml
- lightning.json
- backend.go
- glue.go
- glue_checkpoint.go
- importer.go
- storage.go
- check_cluster_version
- check_contains
- check_not_contains
- read_result
- run_curl
- run_lightning
- run_lightning_ctl
- run_services
- run_sql
- alter_random-schema-create.sql
- alter_random.t-schema.sql
- alter_random.t.sql
- config.toml
- run.sh
- auto_random-schema-create.sql
- auto_random.t-schema.sql
- auto_random.t.0.sql
- auto_random.t.1.sql
- config.toml
- run.sh
- firstdb-schema-create.sql
- firstdb.first-schema.sql
- firstdb.first.1.sql
- firstdb.first.2.sql
- firstdb.second-schema.sql
- firstdb.second.1.sql
- mysql-schema-create.sql
- mysql.testtable-schema.sql
- seconddb-schema-create.sql
- seconddb.fourth-schema.sql
- seconddb.fourth.1.sql
- seconddb.third-schema.sql
- seconddb.third.1.sql
- config.toml
- even-table-only.toml
- firstdb-only.toml
- run.sh
- charsets-schema-create.sql
- charsets.gb18030-schema.sql
- charsets.gb18030.sql
- charsets-schema-create.sql
- charsets.mixed-schema.sql
- charsets.mixed.sql
- charsets-schema-create.sql
- charsets.utf8mb4-schema.sql
- charsets.utf8mb4.sql
- auto.toml
- binary.toml
- gb18030.toml
- run.sh
- utf8mb4.toml
- checkreq-schema-create.sql
- config.toml
- run.sh
- config.toml
- run.sh
- config.toml
- file.toml
- run.sh
- config.toml
- run.sh
- cpdt-schema-create.sql
- cpdt.t-schema.sql
- cpdt.t.sql
- file.toml
- mysql.toml
- run.sh
- cpeng-schema-create.sql
- cpeng.a-schema.sql
- cpeng.a.1.sql
- cpeng.a.2.sql
- cpeng.a.3.sql
- cpeng.b-schema.sql
- cpeng.b.1.sql
- cpeng.b.2.sql
- config.toml
- mysql.toml
- run.sh
- cped-schema-create.sql
- cped.t-schema.sql
- cped.t.sql
- cped-schema-create.sql
- cped.t-schema.sql
- cped.t.sql
- file.toml
- mysql.toml
- run.sh
- config.toml
- parquet.go
- run.sh
- cpts-schema-create.sql
- cpts.cpts-schema.sql
- cpts.cpts.1.sql
- cpts.cpts.2.sql
- config.toml
- mysql.toml
- run.sh
- cmdline_override-schema-create.sql
- cmdline_override.t-schema.sql
- cmdline_override.t.sql
- config.toml
- run.sh
- perm-schema-create.sql
- perm.test_perm-schema.sql
- perm.test_perm.0.csv
- config.toml
- run.sh
- config.toml
- run.sh
- config.toml
- run.sh
- csv-schema-create.sql
- csv.empty_strings-schema.sql
- csv.empty_strings.csv
- csv.escapes-schema.sql
- csv.escapes.CSV
- csv.threads-schema.sql
- csv.threads.csv
- config.toml
- run.sh
- defcol-schema-create.sql
- defcol.t-schema.sql
- defcol.t.1.sql
- defcol.t.2.sql
- defcol.u-schema.sql
- defcol.u.1.sql
- config.toml
- run.sh
- disk_quota-schema-create.sql
- disk_quota.t-schema.sql
- disk_quota.t.0.sql
- disk_quota.t.1.sql
- disk_quota.t.2.sql
- disk_quota.t.3.sql
- config.toml
- run.sh
- error_summary-schema-create.sql
- error_summary.a-schema.sql
- error_summary.a.sql
- error_summary.b-schema.sql
- error_summary.b.sql
- error_summary.c-schema.sql
- error_summary.c.sql
- config.toml
- run.sh
- 1.toml
- 131072.toml
- 512.toml
- run.sh
- xfn-schema-create.sql
- xfn.etn-schema.sql
- xfn.etn.sql
- zwk-schema-create.sql
- zwk.zwb-schema.sql
- zwk.zwb.sql
- config.toml
- run.sh
- config.toml
- run.sh
- gencol-schema-create.sql
- gencol.nested-schema.sql
- gencol.nested.0.sql
- gencol.various_types-schema.sql
- gencol.various_types.0.sql
- config.toml
- run.sh
- issue282-schema-create.sql
- issue282.t_access3-schema.sql
- issue282.t_access3.sql
- config.toml
- run.sh
- issue410-schema-create.sql
- issue410.row_flow_d-schema.sql
- issue410.row_flow_d.0.csv
- config.toml
- run.sh
- issue519-schema-create.sql
- issue519.t-schema.sql
- issue519.t.csv
- config.toml
- run.sh
- cpeng-schema-create.sql
- cpeng.a-schema.sql
- cpeng.a.1.sql
- cpeng.a.2.sql
- cpeng.a.3.sql
- cpeng.b-schema.sql
- cpeng.b.1.sql
- cpeng.b.2.sql
- config.toml
- file.toml
- mysql.toml
- run.sh
- config.toml
- run.sh
- noschema.t.sql
- noschema-schema-create.sql
- noschema.t-schema.sql
- config.toml
- run.sh
- _SUCCESS
- part-00000-c3744aeb-351c-49ba-bdf3-5864befff481-c000.gz.parquet
- _SUCCESS
- part-00000-f61f4bef-6765-432a-8f18-cd17b4607f2a-c000.gz.parquet
- _SUCCESS
- part-00000-8cf0e97a-1169-4335-a93f-8805e02def97-c000.gz.parquet
- _SUCCESS
- part-00000-8905ded8-4c54-477f-9907-6e3eae50358b-c000.gz.parquet
- _SUCCESS
- part-00000-d868200e-b629-4445-bd96-d34b6674b09d-c000.gz.parquet
- _SUCCESS
- part-00000-e36fecd0-3f59-4ff6-b271-2e4b27ffbcf5-c000.gz.parquet
- _SUCCESS
- part-00000-b45481f5-92c0-4961-9bf7-32a0a04ffee5-c000.gz.parquet
- _SUCCESS
- part-00000-eef45943-3034-4d65-b375-ee55aa479215-c000.gz.parquet
- _SUCCESS
- part-00000-c6c33252-4d2f-4c5c-8a2f-d162bde6c360-c000.gz.parquet
- export_info_ci.json
- export_tables_info_ci_from_1_to_9.json
- config.toml
- db.sql
- run.sh
- partitioned-schema-create.sql
- partitioned.a-schema.sql
- partitioned.a.sql
- config.toml
- run.sh
- config.toml
- run.sh
- routes_a0-schema-create.sql
- routes_a0.t0-schema.sql
- routes_a0.t0.1.sql
- routes_a0.t0.2.sql
- routes_a0.t1-schema.sql
- routes_a0.t1.1.sql
- routes_a1-schema-create.sql
- routes_a1.s1-schema.sql
- routes_a1.s1.sql
- routes_a1.t2-schema.sql
- routes_a1.t2.sql
- config.toml
- run.sh
- rowformatv2-schema-create.sql
- rowformatv2.t1-schema.sql
- rowformatv2.t1.1.sql
- config.toml
- run.sh
- config.toml
- run.sh
- config.toml
- run.sh
- sqlmodedb-schema-create.sql
- sqlmodedb.t-schema.sql
- sqlmodedb.t.1.sql
- off.toml
- on.toml
- run.sh
- dup-schema-create.sql
- dup.dup-schema.sql
- dup.dup.sql
- error.toml
- ignore.toml
- replace.toml
- run.sh
- rowid-schema-create.sql
- rowid.explicit_tidb_rowid-schema.sql
- rowid.explicit_tidb_rowid.sql
- rowid.non_pk-schema.sql
- rowid.non_pk.sql
- rowid.non_pk_auto_inc-schema.sql
- rowid.non_pk_auto_inc.sql
- rowid.pre_rebase-schema.sql
- rowid.pre_rebase.sql
- rowid.specific_auto_inc-schema.sql
- rowid.specific_auto_inc.sql
- config.toml
- run.sh
- config.toml
- run.sh
- too_many_columns-schema-create.sql
- too_many_columns.t-schema.sql
- too_many_columns.t.0.csv
- config.toml
- run.sh
- tool_135-schema-create.sql
- tool_135.bar1-schema.sql
- tool_135.bar1.sql
- tool_135.bar2-schema.sql
- tool_135.bar2.sql
- tool_135.bar3-schema.sql
- tool_135.bar3.sql
- tool_135.bar4-schema.sql
- tool_135.bar4.sql
- tool_135.bar5-schema.sql
- tool_135.bar5.sql
- config.toml
- run.sh
- EE1420-schema-create.sql
- EE1420.pt_role-schema.sql
- EE1420.pt_role.sql
- config.toml
- run.sh
- EE1472-schema-create.sql
- EE1472.notpk-schema.sql
- EE1472.notpk.1.sql
- EE1472.notpk.2.sql
- EE1472.pk-schema.sql
- EE1472.pk.1.sql
- EE1472.pk.2.sql
- config.toml
- run.sh
- qyjc-schema-create.sql
- qyjc.q_alarm_group-schema.sql
- qyjc.q_alarm_group.sql
- qyjc.q_alarm_message_log-schema.sql
- qyjc.q_alarm_message_log.sql
- qyjc.q_alarm_receiver-schema.sql
- qyjc.q_config-schema.sql
- qyjc.q_fish_event-schema.sql
- qyjc.q_fish_event.sql
- qyjc.q_report_circular_data-schema.sql
- qyjc.q_report_desc-schema.sql
- qyjc.q_report_summary-schema.sql
- qyjc.q_system_update-schema.sql
- qyjc.q_system_update.sql
- qyjc.q_user_log-schema.sql
- qyjc.q_user_log.sql
- config.toml
- run.sh
- unused_config_keys-schema-create.sql
- config.toml
- run.sh
- vt-schema-create.sql
- vt.binary-schema.sql
- vt.binary.sql
- vt.bit-schema.sql
- vt.bit.sql
- vt.char-schema.sql
- vt.char.sql
- vt.datetime-schema.sql
- vt.datetime.sql
- vt.decimal-schema.sql
- vt.decimal.sql
- vt.double-schema.sql
- vt.double.sql
- vt.empty_strings-schema.sql
- vt.empty_strings.sql
- vt.enum-set-schema.sql
- vt.enum-set.sql
- vt.json-schema.sql
- vt.json.sql
- vt.precise_types-schema.sql
- vt.precise_types.sql
- config.toml
- run.sh
- db0-schema-create.sql
- db0.v2-schema-view.sql
- db0.v2-schema.sql
- db1-schema-create.sql
- db1.tbl-schema.sql
- db1.tbl.0.sql
- db1.v1-schema-view.sql
- db1.v1-schema.sql
- config.toml
- run.sh
- go.mod
- README.md
- run.sh
- go.mod
- go.sum
- go_mod_guard.go
- revive.toml
- api.yaml
- InfoPage.png
- ProgressPage.png
- TableProgressPage.png
- index.html
- api.ts
- ChunksProgressPanel.tsx
- DottedProgress.tsx
- EnginesProgressPanel.tsx
- ErrorButton.tsx
- index.tsx
- InfoButton.tsx
- InfoPage.tsx
- json-bigint.d.ts
- MoveTaskButton.tsx
- PauseButton.tsx
- ProgressPage.tsx
- RefreshButton.tsx
- TableProgressCard.tsx
- TableProgressPage.tsx
- TaskButton.tsx
- TitleBar.tsx
- TitleLink.tsx
- go.mod
- package-lock.json
- package.json
- README.md
- tsconfig.json
- webpack.config.js
- .gitattributes
- .gitignore
- CONTRIBUTING.md
- go.mod1
- go.sum1
- LICENSE
- MAINTAINERS.md
- Makefile
- README.md
- ROADMAP.md
- tidb-lightning.toml
# Installation Guide
1. Get the code
git clone https://github.com/pingcap/tidb-lightning
Downloads the entire project code from GitHub to your computer.
cd tidb-lightning
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
cd web
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
3. Go
MediumPrerequisites
cd tools
This project's files live in a subfolder, so move into it first.
go build ./...
Compiles the Go program into an executable.
go run .
Runs the Go program directly without a separate build step.
If the build finishes without errors, it worked. If you used go run ., check the terminal output.
4. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)