pingcap/tidb

br: open format file generation by backup

Open

#58611 opened on Dec 30, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (40,090 stars) (6,186 forks)batch import
help wantedtype/feature-request

Description

Feature Request

Is your feature request related to a problem? Please describe:

Currently, there is no native tidb tool to export tikv data into open format files, like parquet. Instead, tidb users need to use client like tispark etc to extract data and do the format conversion. And the long tech stack suffers from bad performance.

Describe the feature you'd like:

tidb can provide a native way to dump snapshot data and incremental data to open format files. A preferred way is to let backup to generate open format files directly, in other words, backup can support to generate either log/sst files or parquet files. A simple prototype code is here https://github.com/BornChanger/sampleParquet.

Describe alternatives you've considered:

Teachability, Documentation, Adoption, Migration Strategy:

Contributor guide

Tech stack
go
Domain
databasedatabackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GolangTiDB backup internalsParquet file format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue requests adding native Parquet export to TiDB backup. The prototype code at https://github.com/BornChanger/sampleParquet provides a starting point. The implementation will likely involve modifying the backup module (e.g., `br` in the TiDB repository) to write Parquet files instead of SST or log files. Look into how backup currently writes data and explore the Parquet Go library (e.g., apache/arrow go) for integration. The feature requires understanding of both TiDB's snapshot/incremental backup mechanisms and Parquet schema generation.