Package org.apache.hadoop.hbase.snapshot

Class SnapshotRegionLocator

java.lang.Object

org.apache.hadoop.hbase.snapshot.SnapshotRegionLocator

All Implemented Interfaces:

Closeable, AutoCloseable, RegionLocator

@Private
public final class SnapshotRegionLocator
extends Object
implements RegionLocator

RegionLocator built using the most recent full backup's snapshot manifest for a given table. Useful for aligning any subsequent incremental backups along the same splits as the full backup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	SnapshotRegionLocator.HRegionReplicas
static final class	SnapshotRegionLocator.SnapshotHRegionLocation

Field Summary

Fields

Modifier and Type	Field	Description
private static final ServerName	FAKE_SERVER_NAME
private final List<HRegionLocation>	rawLocations
private final TreeMap<byte[],SnapshotRegionLocator.HRegionReplicas>	regions
private static final String	SNAPSHOT_MANIFEST_DIR_PREFIX
private final TableName	tableName

Fields inherited from interface org.apache.hadoop.hbase.client.RegionLocator

LOCATOR_META_REPLICAS_MODE, LOCATOR_META_REPLICAS_MODE_LOADBALANCE_SELECTOR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SnapshotRegionLocator(TableName tableName, TreeMap<byte[],SnapshotRegionLocator.HRegionReplicas> regions, List<HRegionLocation> rawLocations)

Method Summary

Modifier and Type	Method	Description
void	clearRegionLocationCache()	Clear all the entries in the region location cache.
void	close()
static SnapshotRegionLocator	create(org.apache.hadoop.conf.Configuration conf, TableName table)
List<HRegionLocation>	getAllRegionLocations()	Retrieves all of the regions associated with this table.
TableName	getName()	Gets the fully qualified table name instance of this table.
HRegionLocation	getRegionLocation(byte[] row, int replicaId, boolean reload)	Finds the region with the given replica id on which the given row is being served.
List<HRegionLocation>	getRegionLocations(byte[] row, boolean reload)	Find all the replicas for the region on which the given row is being served.
private static String	getSnapshotManifestDirKey(TableName table)
static void	setSnapshotManifestDir(org.apache.hadoop.conf.Configuration conf, String dir, TableName table)
static boolean	shouldUseSnapshotRegionLocator(org.apache.hadoop.conf.Configuration conf, TableName table)
private static SnapshotRegionLocator.SnapshotHRegionLocation	toLocation(org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo ri, TableName tableName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.client.RegionLocator

getEndKeys, getRegionLocation, getRegionLocation, getRegionLocation, getRegionLocations, getStartEndKeys, getStartKeys

Field Details

SNAPSHOT_MANIFEST_DIR_PREFIX

private static final String SNAPSHOT_MANIFEST_DIR_PREFIX

See Also:

• Constant Field Values

FAKE_SERVER_NAME

private static final ServerName FAKE_SERVER_NAME

tableName

private final TableName tableName

regions

private final TreeMap<byte[],SnapshotRegionLocator.HRegionReplicas> regions

rawLocations

private final List<HRegionLocation> rawLocations

Constructor Details

SnapshotRegionLocator

private SnapshotRegionLocator(TableName tableName,
 TreeMap<byte[],SnapshotRegionLocator.HRegionReplicas> regions,
 List<HRegionLocation> rawLocations)

Method Details

create

public static SnapshotRegionLocator create(org.apache.hadoop.conf.Configuration conf,
 TableName table)
                                    throws IOException

Throws:

IOException

getRegionLocation

public HRegionLocation getRegionLocation(byte[] row,
 int replicaId,
 boolean reload)
                                  throws IOException

Description copied from interface: RegionLocator

Finds the region with the given replica id on which the given row is being served.

Specified by:

getRegionLocation in interface RegionLocator

Parameters:

row - Row to find.

replicaId - the replica id

reload - true to reload information or false to use cached information

Returns:

Location of the row.

Throws:

IOException - if a remote or network exception occurs

getRegionLocations

public List<HRegionLocation> getRegionLocations(byte[] row,
 boolean reload)
                                         throws IOException

Description copied from interface: RegionLocator

Find all the replicas for the region on which the given row is being served.

Specified by:

getRegionLocations in interface RegionLocator

Parameters:

row - Row to find.

reload - true to reload information or false to use cached information

Returns:

Locations for all the replicas of the row.

Throws:

IOException - if a remote or network exception occurs

clearRegionLocationCache

public void clearRegionLocationCache()

Description copied from interface: RegionLocator

Clear all the entries in the region location cache.

This may cause performance issue so use it with caution.

Specified by:

clearRegionLocationCache in interface RegionLocator

getAllRegionLocations

public List<HRegionLocation> getAllRegionLocations()
                                            throws IOException

Description copied from interface: RegionLocator

Retrieves all of the regions associated with this table.

Usually we will go to meta table directly in this method so there is no reload parameter.

Notice that the location for region replicas other than the default replica are also returned.

Specified by:

getAllRegionLocations in interface RegionLocator

Returns:

a List of all regions associated with this table.

Throws:

IOException - if a remote or network exception occurs

getName

public TableName getName()

Description copied from interface: RegionLocator

Gets the fully qualified table name instance of this table.

Specified by:

getName in interface RegionLocator

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

shouldUseSnapshotRegionLocator

public static boolean shouldUseSnapshotRegionLocator(org.apache.hadoop.conf.Configuration conf,
 TableName table)

setSnapshotManifestDir

public static void setSnapshotManifestDir(org.apache.hadoop.conf.Configuration conf,
 String dir,
 TableName table)

getSnapshotManifestDirKey

private static String getSnapshotManifestDirKey(TableName table)

toLocation

private static SnapshotRegionLocator.SnapshotHRegionLocation toLocation(org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo ri,
 TableName tableName)