package backup

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

service Backup

brpb.proto:670

service ExternalStorage

brpb.proto:693

ExternalStorage is a service for using a cloud backend from StorageBackend to store files. This can be used to backup and restore SST files.

message AzureBlobStorage

brpb.proto:551

AzureBlobStorage storage backend saves files into azure blob storage.

Used in: StorageBackend

message AzureCustomerKey

brpb.proto:543

The encryption algorithm must be AES256.

Used in: AzureBlobStorage

message BackupMeta

brpb.proto:65

The message save the metadata of a backup.

enum BackupMode

brpb.proto:354

BackupMpde represents the mode of this whole backup request to the cluster. and we need to store it in `backupmeta`.

Used in: BackupMeta, BackupRequest

message BackupRange

brpb.proto:152

Used in: BackupMeta, MetaFile

message Bucket

brpb.proto:605

Used in: CloudDynamic

message CipherInfo

brpb.proto:365

Used in: BackupRequest, StreamBackupTaskSecurityConfig, import_sstpb.ApplyRequest, import_sstpb.DownloadRequest

message CloudDynamic

brpb.proto:614

CloudDynamic allows testing new cloud providers and new fields without changing protobuf definitions

Used in: StorageBackend

message ClusterIDError

brpb.proto:321

Used in: Error

enum CompressionType

brpb.proto:337

sst files or log files compression algorithm for log files, unknown means not use compression algorithm

Used in: BackupRequest, DataFileInfo, StreamBackupTaskInfo, import_sstpb.KVMeta

message DataFileGroup

brpb.proto:739

DataFileGroup is the merged file info in log-backup

Used in: Metadata

message DataFileInfo

brpb.proto:761

Used in: DataFileGroup, Metadata

message DeleteSpansOfFile

brpb.proto:1012

An extended version of `SpansOfFile`, added more metadata for the execution of delayed deletion.

Used in: MetaEdit

message Error

brpb.proto:326

Used in: BackupResponse, CheckAdminResponse, CleanupResponse, PrepareResponse

message File

brpb.proto:168

Used in: BackupMeta, BackupRange, BackupResponse, IngestedSSTs, LogFileSubcompaction, MetaFile

enum FileType

brpb.proto:733

Used in: DataFileInfo, LogFileSubcompactionMeta

message GCS

brpb.proto:527

GCS storage backend saves files into google cloud storage.

Used in: StorageBackend

message HDFS

brpb.proto:621

HDFS storage backend saves file into HDFS compatible storages

Used in: StorageBackend

message IDMap

brpb.proto:269

Used in: PitrDBMap, PitrTableMap

message IngestedSSTs

brpb.proto:982

IngestedSSTs is created by a client that wants to put data to the cluster by `Ingest` APIs, these write cannot be directly recorded by log backup. The client should put a migration that contains the SSTs it uploaded.

message Local

brpb.proto:496

Local storage backend saves files into local disk

Used in: StorageBackend

message LogFileCompaction

brpb.proto:911

Used in: Migration

message LogFileSubcompaction

brpb.proto:883

A subcompaction from a compaction. Subcompactions are actions that collect then sort key values from one region.

Used in: LogFileSubcompactions

message LogFileSubcompactionMeta

brpb.proto:855

Used in: LogFileSubcompaction

message LogFileSubcompactions

brpb.proto:907

Batched version of `LogFileSubcompaction`. So we can store many subcompactions to one file, to reduce the number of file.

message MasterKeyConfig

brpb.proto:370

Used in: StreamBackupTaskSecurityConfig

message MetaEdit

brpb.proto:948

Used in: Migration

message MetaFile

brpb.proto:195

MetaFile describes a multi-level index of data used in backup.

Used in: BackupMeta

enum MetaVersion

brpb.proto:717

Used in: Metadata

message Metadata

brpb.proto:722

message Migration

brpb.proto:1030

enum MigrationVersion

brpb.proto:1021

Used in: Migration

message Noop

brpb.proto:493

Noop storage backend saves files into void.

Used in: StorageBackend

(message has no fields)

message PitrDBMap

brpb.proto:295

Used in: BackupMeta

message PitrForeignKeyReference

brpb.proto:274

Used in: PitrTableMap

message PitrTableMap

brpb.proto:279

Used in: PitrDBMap

message PlacementPolicy

brpb.proto:211

Used in: BackupMeta

enum PrepareSnapshotBackupEventType

brpb.proto:44

Used in: PrepareSnapshotBackupResponse

enum PrepareSnapshotBackupRequestType

brpb.proto:20

Used in: PrepareSnapshotBackupRequest

message RawRange

brpb.proto:315

Used in: BackupMeta, MetaFile

message RegionMetaHint

brpb.proto:893

You may get region id from `LogFileSubcompactionMeta`.

Used in: LogFileSubcompaction

message RewrittenTableID

brpb.proto:972

RewrittenTableID records a sort of modification over the SSTs during restoring. When "backing up" this "restored" SST, we want to backup the original SST before any rewrite. But in some cases, SSTs are not restored "as is", TiKV may rewrite or truncate its content by the client's request.

Used in: IngestedSSTs

message S3

brpb.proto:502

S3 storage backend saves files into S3 compatible storages For non-aws providers, endpoint must be provided

Used in: StorageBackend

message Schema

brpb.proto:243

Used in: BackupMeta, MetaFile

message SortedSubRanges

brpb.proto:375

Used in: BackupRequest

message Span

brpb.proto:845

Used in: DeleteSpansOfFile, SpansOfFile

message SpansOfFile

brpb.proto:850

Used in: LogFileSubcompactionMeta

message StatsBlock

brpb.proto:215

Used in: StatsFile

message StatsFile

brpb.proto:223

message StatsFileIndex

brpb.proto:228

Used in: Schema

message StorageBackend

brpb.proto:480

Used in: BackupRequest, ExternalStorageRestoreRequest, ExternalStorageSaveRequest, StreamBackupTaskInfo, import_sstpb.ApplyRequest, import_sstpb.DownloadRequest

message StreamBackupError

brpb.proto:834

message StreamBackupTaskInfo

brpb.proto:441

message StreamBackupTaskSecurityConfig

brpb.proto:344

Used in: StreamBackupTaskInfo

message TableMeta

brpb.proto:160

The message saves the physical table checksum

Used in: File