001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.backup;
019
020import java.io.IOException;
021import org.apache.hadoop.conf.Configurable;
022import org.apache.hadoop.fs.Path;
023import org.apache.hadoop.hbase.TableName;
024import org.apache.yetus.audience.InterfaceAudience;
025
026/**
027 * Restore operation job interface Concrete implementation is provided by backup provider, see
028 * {@link BackupRestoreFactory}
029 */
030
031@InterfaceAudience.Private
032public interface RestoreJob extends Configurable {
033
034  String KEEP_ORIGINAL_SPLITS_KEY = "hbase.backup.restorejob.keep.original.splits";
035  String BACKUP_ROOT_PATH_KEY = "hbase.backup.root.path";
036  boolean KEEP_ORIGINAL_SPLITS_DEFAULT = false;
037
038  /**
039   * Run restore operation
040   * @param dirPaths          path array of WAL log directories
041   * @param fromTables        from tables
042   * @param restoreRootDir    output file system
043   * @param toTables          to tables
044   * @param fullBackupRestore full backup restore
045   * @throws IOException if running the job fails
046   */
047  void run(Path[] dirPaths, TableName[] fromTables, Path restoreRootDir, TableName[] toTables,
048    boolean fullBackupRestore) throws IOException;
049}