hbase-protocol-shaded/src/main/protobuf/Backup.proto

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless optional by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
syntax = "proto2";
// This file contains Backup manifest
package hbase.pb;

option java_package = "org.apache.hadoop.hbase.shaded.protobuf.generated";
option java_outer_classname = "BackupProtos";
option java_generic_services = true;
option java_generate_equals_and_hash = true;
option optimize_for = SPEED;

import "HBase.proto";

/**
 * Backup type enum: FULL or INCREMENTAL
 */

enum BackupType {
  FULL = 0;
  INCREMENTAL = 1;
}
/**
 * ServerTimestamp keeps last WAL roll time per Region Server
 */
message ServerTimestamp {
  optional ServerName server_name = 1;
  optional uint64 timestamp = 2;
}

/**
 *  TableServerTimestamp keeps last WAL roll time per Region Server & Table
 *  Each table have different last WAL roll time stamps across cluster, on every RS
 */
message TableServerTimestamp {
  optional TableName table_name = 1;
  repeated ServerTimestamp server_timestamp = 2;
}

/**
 * Structure keeps relevant info for backup restore session
 */
message BackupImage {
  optional string backup_id = 1;
  optional BackupType backup_type = 2;
  optional string backup_root_dir = 3;
  repeated TableName table_list = 4;
  optional uint64 start_ts = 5;
  optional uint64 complete_ts = 6;
  repeated BackupImage ancestors = 7;
  repeated TableServerTimestamp tst_map = 8;

}

/**
 * Internal structure used during backup
 */
message BackupTableInfo {
  optional TableName table_name = 1;
  optional string snapshot_name = 2;
}

/**
 * Backup session information
 */
message BackupInfo {
  optional string backup_id = 1;
  optional BackupType backup_type = 2;
  optional string backup_root_dir = 3;
  optional BackupState backup_state = 4;
  optional BackupPhase backup_phase = 5;
  optional string failed_message = 6;
  repeated BackupTableInfo backup_table_info = 7;
  optional uint64  start_ts = 8;
  optional uint64  complete_ts = 9;
  optional uint32 progress = 10;
  optional uint32 workers_number = 11;
  optional uint64 bandwidth = 12;

  /**
   * Backup session states
   */
  enum BackupState {
    RUNNING = 0;
    COMPLETE = 1;
    FAILED = 2;
    CANCELLED = 3;
  }

  /**
   * Phases of a backup session in RUNNING state
   *
   */
  enum BackupPhase {
    REQUEST = 0;
    SNAPSHOT = 1;
    PREPARE_INCREMENTAL = 2;
    SNAPSHOTCOPY = 3;
    INCREMENTAL_COPY = 4;
    STORE_MANIFEST = 5;
  }
}