Apache/hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-8642 [Snapshot] List and delete snapshot by table

Browse Source 
Signed-off-by: Andrew Purtell <apurtell@apache.org>
This commit is contained in:
Ashish Singhi 2015-07-15 15:56:07 -07:00 committed by Andrew Purtell
parent 5315f0f11f
commit e6bd0c8c15
7 changed files with 405 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
hbase-client/src/main/java/org/apache/hadoop/hbase/client/Admin.java
View File

@ -1338,6 +1338,28 @@ public interface Admin extends Abortable, Closeable {
*/
List<HBaseProtos.SnapshotDescription> listSnapshots(Pattern pattern) throws IOException;
/**
* List all the completed snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNameRegex The table name regular expression to match against
* @param snapshotNameRegex The snapshot name regular expression to match against
* @return - returns a List of completed SnapshotDescription
* @throws IOException if a remote or network exception occurs
*/
List<HBaseProtos.SnapshotDescription> listTableSnapshots(String tableNameRegex,
String snapshotNameRegex) throws IOException;
/**
* List all the completed snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNamePattern The compiled table name regular expression to match against
* @param snapshotNamePattern The compiled snapshot name regular expression to match against
* @return - returns a List of completed SnapshotDescription
* @throws IOException if a remote or network exception occurs
*/
List<HBaseProtos.SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
Pattern snapshotNamePattern) throws IOException;
/**
* Delete an existing snapshot.
*
@ -1370,6 +1392,25 @@ public interface Admin extends Abortable, Closeable {
*/
void deleteSnapshots(final Pattern pattern) throws IOException;
/**
* Delete all existing snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNameRegex The table name regular expression to match against
* @param snapshotNameRegex The snapshot name regular expression to match against
* @throws IOException if a remote or network exception occurs
*/
void deleteTableSnapshots(String tableNameRegex, String snapshotNameRegex) throws IOException;
/**
* Delete all existing snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNamePattern The compiled table name regular expression to match against
* @param snapshotNamePattern The compiled snapshot name regular expression to match against
* @throws IOException if a remote or network exception occurs
*/
void deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)
throws IOException;
/**
* Apply the new quota settings.
*

73
hbase-client/src/main/java/org/apache/hadoop/hbase/client/HBaseAdmin.java
View File

@ -3808,6 +3808,45 @@ public class HBaseAdmin implements Admin {
return matched;
}
/**
* List all the completed snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNameRegex The table name regular expression to match against
* @param snapshotNameRegex The snapshot name regular expression to match against
* @return returns a List of completed SnapshotDescription
* @throws IOException if a remote or network exception occurs
*/
@Override
public List<SnapshotDescription> listTableSnapshots(String tableNameRegex,
String snapshotNameRegex) throws IOException {
return listTableSnapshots(Pattern.compile(tableNameRegex), Pattern.compile(snapshotNameRegex));
}
/**
* List all the completed snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNamePattern The compiled table name regular expression to match against
* @param snapshotNamePattern The compiled snapshot name regular expression to match against
* @return returns a List of completed SnapshotDescription
* @throws IOException if a remote or network exception occurs
*/
@Override
public List<SnapshotDescription> listTableSnapshots(Pattern tableNamePattern,
Pattern snapshotNamePattern) throws IOException {
TableName[] tableNames = listTableNames(tableNamePattern);
List<SnapshotDescription> tableSnapshots = new LinkedList<SnapshotDescription>();
List<SnapshotDescription> snapshots = listSnapshots(snapshotNamePattern);
List<TableName> listOfTableNames = Arrays.asList(tableNames);
for (SnapshotDescription snapshot : snapshots) {
if (listOfTableNames.contains(TableName.valueOf(snapshot.getTable()))) {
tableSnapshots.add(snapshot);
}
}
return tableSnapshots;
}
/**
* Delete an existing snapshot.
* @param snapshotName name of the snapshot
@ -3880,6 +3919,40 @@ public class HBaseAdmin implements Admin {
});
}
/**
* Delete all existing snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNameRegex The table name regular expression to match against
* @param snapshotNameRegex The snapshot name regular expression to match against
* @throws IOException if a remote or network exception occurs
*/
@Override
public void deleteTableSnapshots(String tableNameRegex, String snapshotNameRegex)
throws IOException {
deleteTableSnapshots(Pattern.compile(tableNameRegex), Pattern.compile(snapshotNameRegex));
}
/**
* Delete all existing snapshots matching the given table name regular expression and snapshot
* name regular expression.
* @param tableNamePattern The compiled table name regular expression to match against
* @param snapshotNamePattern The compiled snapshot name regular expression to match against
* @throws IOException if a remote or network exception occurs
*/
@Override
public void deleteTableSnapshots(Pattern tableNamePattern, Pattern snapshotNamePattern)
throws IOException {
List<SnapshotDescription> snapshots = listTableSnapshots(tableNamePattern, snapshotNamePattern);
for (SnapshotDescription snapshot : snapshots) {
try {
internalDeleteSnapshot(snapshot);
LOG.debug("Successfully deleted snapshot: " + snapshot.getName());
} catch (IOException e) {
LOG.error("Failed to delete snapshot: " + snapshot.getName(), e);
}
}
}
/**
* Apply the new quota settings.
*

152
hbase-server/src/test/java/org/apache/hadoop/hbase/client/TestSnapshotFromClient.java
View File

@ -18,8 +18,11 @@
package org.apache.hadoop.hbase.client;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.logging.Log;
@ -36,6 +39,7 @@ import org.apache.hadoop.hbase.master.snapshot.SnapshotManager;
import org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription;
import org.apache.hadoop.hbase.regionserver.ConstantSizeRegionSplitPolicy;
import org.apache.hadoop.hbase.snapshot.SnapshotCreationException;
import org.apache.hadoop.hbase.snapshot.SnapshotDoesNotExistException;
import org.apache.hadoop.hbase.snapshot.SnapshotTestingUtils;
import org.apache.hadoop.hbase.snapshot.SnapshotManifestV1;
import org.apache.hadoop.hbase.testclassification.ClientTests;
@ -302,4 +306,152 @@ public class TestSnapshotFromClient {
snapshots = admin.listSnapshots();
SnapshotTestingUtils.assertNoSnapshots(admin);
}
@Test(timeout = 300000)
public void testListTableSnapshots() throws Exception {
Admin admin = null;
TableName tableName2 = TableName.valueOf("testListTableSnapshots");
try {
admin = UTIL.getHBaseAdmin();
HTableDescriptor htd = new HTableDescriptor(tableName2);
UTIL.createTable(htd, new byte[][] { TEST_FAM }, UTIL.getConfiguration());
String table1Snapshot1 = "Table1Snapshot1";
admin.snapshot(table1Snapshot1, TABLE_NAME);
LOG.debug("Snapshot1 completed.");
String table1Snapshot2 = "Table1Snapshot2";
admin.snapshot(table1Snapshot2, TABLE_NAME);
LOG.debug("Snapshot2 completed.");
String table2Snapshot1 = "Table2Snapshot1";
admin.snapshot(Bytes.toBytes(table2Snapshot1), tableName2);
LOG.debug(table2Snapshot1 + " completed.");
List<SnapshotDescription> listTableSnapshots = admin.listTableSnapshots("test.*", ".*");
List<String> listTableSnapshotNames = new ArrayList<String>();
assertEquals(3, listTableSnapshots.size());
for (SnapshotDescription s : listTableSnapshots) {
listTableSnapshotNames.add(s.getName());
}
assertTrue(listTableSnapshotNames.contains(table1Snapshot1));
assertTrue(listTableSnapshotNames.contains(table1Snapshot2));
assertTrue(listTableSnapshotNames.contains(table2Snapshot1));
} finally {
if (admin != null) {
try {
admin.deleteSnapshots("Table.*");
} catch (SnapshotDoesNotExistException ignore) {
}
if (admin.tableExists(tableName2)) {
UTIL.deleteTable(tableName2);
}
admin.close();
}
}
}
@Test(timeout = 300000)
public void testListTableSnapshotsWithRegex() throws Exception {
Admin admin = null;
try {
admin = UTIL.getHBaseAdmin();
String table1Snapshot1 = "Table1Snapshot1";
admin.snapshot(table1Snapshot1, TABLE_NAME);
LOG.debug("Snapshot1 completed.");
String table1Snapshot2 = "Table1Snapshot2";
admin.snapshot(table1Snapshot2, TABLE_NAME);
LOG.debug("Snapshot2 completed.");
String table2Snapshot1 = "Table2Snapshot1";
admin.snapshot(Bytes.toBytes(table2Snapshot1), TABLE_NAME);
LOG.debug(table2Snapshot1 + " completed.");
List<SnapshotDescription> listTableSnapshots = admin.listTableSnapshots("test.*", "Table1.*");
List<String> listTableSnapshotNames = new ArrayList<String>();
assertEquals(2, listTableSnapshots.size());
for (SnapshotDescription s : listTableSnapshots) {
listTableSnapshotNames.add(s.getName());
}
assertTrue(listTableSnapshotNames.contains(table1Snapshot1));
assertTrue(listTableSnapshotNames.contains(table1Snapshot2));
assertFalse(listTableSnapshotNames.contains(table2Snapshot1));
} finally {
if (admin != null) {
try {
admin.deleteSnapshots("Table.*");
} catch (SnapshotDoesNotExistException ignore) {
}
admin.close();
}
}
}
@Test(timeout = 300000)
public void testDeleteTableSnapshots() throws Exception {
Admin admin = null;
TableName tableName2 = TableName.valueOf("testListTableSnapshots");
try {
admin = UTIL.getHBaseAdmin();
HTableDescriptor htd = new HTableDescriptor(tableName2);
UTIL.createTable(htd, new byte[][] { TEST_FAM }, UTIL.getConfiguration());
String table1Snapshot1 = "Table1Snapshot1";
admin.snapshot(table1Snapshot1, TABLE_NAME);
LOG.debug("Snapshot1 completed.");
String table1Snapshot2 = "Table1Snapshot2";
admin.snapshot(table1Snapshot2, TABLE_NAME);
LOG.debug("Snapshot2 completed.");
String table2Snapshot1 = "Table2Snapshot1";
admin.snapshot(Bytes.toBytes(table2Snapshot1), tableName2);
LOG.debug(table2Snapshot1 + " completed.");
admin.deleteTableSnapshots("test.*", ".*");
assertEquals(0, admin.listTableSnapshots("test.*", ".*").size());
} finally {
if (admin != null) {
if (admin.tableExists(tableName2)) {
UTIL.deleteTable(tableName2);
}
admin.close();
}
}
}
@Test(timeout = 300000)
public void testDeleteTableSnapshotsWithRegex() throws Exception {
Admin admin = null;
try {
admin = UTIL.getHBaseAdmin();
String table1Snapshot1 = "Table1Snapshot1";
admin.snapshot(table1Snapshot1, TABLE_NAME);
LOG.debug("Snapshot1 completed.");
String table1Snapshot2 = "Table1Snapshot2";
admin.snapshot(table1Snapshot2, TABLE_NAME);
LOG.debug("Snapshot2 completed.");
String table2Snapshot1 = "Table2Snapshot1";
admin.snapshot(Bytes.toBytes(table2Snapshot1), TABLE_NAME);
LOG.debug(table2Snapshot1 + " completed.");
admin.deleteTableSnapshots("test.*", "Table1.*");
assertEquals(1, admin.listTableSnapshots("test.*", ".*").size());
} finally {
if (admin != null) {
try {
admin.deleteTableSnapshots("test.*", ".*");
} catch (SnapshotDoesNotExistException ignore) {
}
admin.close();
}
}
}
}

12
hbase-shell/src/main/ruby/hbase/admin.rb
View File

@ -867,12 +867,24 @@ module Hbase
@admin.deleteSnapshots(regex).to_a
end
#----------------------------------------------------------------------------------------------
# Deletes the table snapshots matching the given regex
def delete_table_snapshots(tableNameRegex, snapshotNameRegex = ".*")
@admin.deleteTableSnapshots(tableNameRegex, snapshotNameRegex).to_a
end
#----------------------------------------------------------------------------------------------
# Returns a list of snapshots
def list_snapshot(regex = ".*")
@admin.listSnapshots(regex).to_a
end
#----------------------------------------------------------------------------------------------
# Returns a list of table snapshots
def list_table_snapshots(tableNameRegex, snapshotNameRegex = ".*")
@admin.listTableSnapshots(tableNameRegex, snapshotNameRegex).to_a
end
# Apply config specific to a table/column to its descriptor
def set_descriptor_config(descriptor, config)
raise(ArgumentError, "#{CONFIGURATION} must be a Hash type") unless config.kind_of?(Hash)

2
hbase-shell/src/main/ruby/shell.rb
View File

@ -365,7 +365,9 @@ Shell.load_command_group(
restore_snapshot
delete_snapshot
delete_all_snapshot
delete_table_snapshots
list_snapshots
list_table_snapshots
]
)

69
hbase-shell/src/main/ruby/shell/commands/delete_table_snapshots.rb Normal file
View File

@ -0,0 +1,69 @@
#
# 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 required 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.
#
module Shell
module Commands
class DeleteTableSnapshots < Command
def help
return <<-EOF
Delete all of the snapshots matching the given table name regular expression
and snapshot name regular expression.
By default snapshot name regular expression will delete all the snapshots of the
matching table name regular expression.
Examples:
hbase> delete_table_snapshots 'tableName'
hbase> delete_table_snapshots 'tableName.*'
hbase> delete_table_snapshots 'tableName' 'snapshotName'
hbase> delete_table_snapshots 'tableName' 'snapshotName.*'
hbase> delete_table_snapshots 'tableName.*' 'snapshotName.*'
hbase> delete_table_snapshots 'ns:tableName.*' 'snapshotName.*'
EOF
end
def command(tableNameregex, snapshotNameRegex = ".*")
formatter.header([ "SNAPSHOT", "TABLE + CREATION TIME"])
list = admin.list_table_snapshots(tableNameregex, snapshotNameRegex)
count = list.size
list.each do |snapshot|
creation_time = Time.at(snapshot.getCreationTime() / 1000).to_s
formatter.row([ snapshot.getName, snapshot.getTable + " (" + creation_time + ")" ])
end
puts "\nDelete the above #{count} snapshots (y/n)?" unless count == 0
answer = 'n'
answer = gets.chomp unless count == 0
puts "No snapshots matched the table name regular expression #{tableNameregex.to_s} and the snapshot name regular expression #{snapshotNameRegex.to_s}" if count == 0
return unless answer =~ /y.*/i
format_simple_command do
list.each do |deleteSnapshot|
begin
admin.delete_snapshot(deleteSnapshot.getName)
puts "Successfully deleted snapshot: #{deleteSnapshot.getName}"
puts "\n"
rescue RuntimeError
puts "Failed to delete snapshot: #{deleteSnapshot.getName}, due to below exception,\n" + $!
puts "\n"
end
end
end
end
end
end
end

56
hbase-shell/src/main/ruby/shell/commands/list_table_snapshots.rb Normal file
View File

@ -0,0 +1,56 @@
#
# 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 required 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.
#
require 'time'
module Shell
module Commands
class ListTableSnapshots < Command
def help
return <<-EOF
List all completed snapshots matching the table name regular expression and the
snapshot name regular expression (by printing the names and relative information).
Optional snapshot name regular expression parameter could be used to filter the output
by snapshot name.
Examples:
hbase> list_table_snapshots 'tableName'
hbase> list_table_snapshots 'tableName.*'
hbase> list_table_snapshots 'tableName' 'snapshotName'
hbase> list_table_snapshots 'tableName' 'snapshotName.*'
hbase> list_table_snapshots 'tableName.*' 'snapshotName.*'
hbase> list_table_snapshots 'ns:tableName.*' 'snapshotName.*'
EOF
end
def command(tableNameRegex, snapshotNameRegex = ".*")
now = Time.now
formatter.header([ "SNAPSHOT", "TABLE + CREATION TIME"])
list = admin.list_table_snapshots(tableNameRegex, snapshotNameRegex)
list.each do |snapshot|
creation_time = Time.at(snapshot.getCreationTime() / 1000).to_s
formatter.row([ snapshot.getName, snapshot.getTable + " (" + creation_time + ")" ])
end
formatter.footer(now, list.size)
return list.map { |s| s.getName() }
end
end
end
end