SplitTransactionImpl (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.SplitTransactionImpl

All Implemented Interfaces:: SplitTransaction

@InterfaceAudience.Private
public class SplitTransactionImpl
extends Object
implements SplitTransaction

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`SplitTransactionImpl.DaughterOpener`
`static class`	`SplitTransactionImpl.JournalEntryImpl`
`(package private) static class`	`SplitTransactionImpl.LoggingProgressable`
`(package private) class`	`SplitTransactionImpl.StoreFileSplitter` Utility class used to do the file splitting / reference writing in parallel instead of sequentially.

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.SplitTransaction
SplitTransaction.JournalEntry, SplitTransaction.SplitTransactionPhase, SplitTransaction.TransactionListener

Field Summary

Fields
Modifier and Type	Field and Description
`private static IOException`	`closedByOtherException`
`private SplitTransaction.SplitTransactionPhase`	`currentPhase`
`private long`	`fileSplitTimeout`
`private HRegionInfo`	`hri_a`
`private HRegionInfo`	`hri_b`
`private List<SplitTransaction.JournalEntry>`	`journal`
`private ArrayList<SplitTransaction.TransactionListener>`	`listeners` Listeners
`private static org.apache.commons.logging.Log`	`LOG`
`private HRegion`	`parent`
`private RegionServerServices`	`rsServices`
`private Server`	`server`
`private byte[]`	`splitrow`
`SplitTransactionCoordination.SplitTransactionDetails`	`std`
`(package private) boolean`	`useZKForAssignment`

Constructor Summary

Constructors
Constructor and Description

SplitTransactionImpl(Region r, byte[] splitrow)
Constructor

Constructors
Constructor and Description
`SplitTransactionImpl(Region r, byte[] splitrow)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`private static Put`	`addEmptyLocation(Put p, int replicaId)`
`Put`	`addLocation(Put p, ServerName sn, long openSeqNum)`
`(package private) void`	`assertReferenceFileCount(int expectedReferenceFileCount, org.apache.hadoop.fs.Path dir)`
`(package private) PairOfSameType<Region>`	`createDaughters(Server server, RegionServerServices services)`
`(package private) PairOfSameType<Region>`	`createDaughters(Server server, RegionServerServices services, User user)` Prepare the regions and region files.
`PairOfSameType<Region>`	`execute(Server server, RegionServerServices services)` Run the transaction.
`PairOfSameType<Region>`	`execute(Server server, RegionServerServices services, User user)` Run the transaction.
`private static long`	`getDaughterRegionIdTimestamp(HRegionInfo hri)` Calculate daughter regionid to use.
`(package private) HRegionInfo`	`getFirstDaughter()`
`List<SplitTransaction.JournalEntry>`	`getJournal()` Get the journal for the transaction.
`RegionServerServices`	`getRegionServerServices()` Get the RegonServerServices of the server running the transaction or rollback
`(package private) HRegionInfo`	`getSecondDaughter()`
`Server`	`getServer()` Get the Server running the transaction or rollback
`private void`	`offlineParentInMetaAndputMetaEntries(HConnection hConnection, HRegionInfo parent, HRegionInfo splitA, HRegionInfo splitB, ServerName serverName, List<Mutation> metaEntries, int regionReplication)`
`(package private) void`	`openDaughterRegion(Server server, HRegion daughter)` Open daughter regions, add them to online list and update meta.
`(package private) void`	`openDaughters(Server server, RegionServerServices services, Region a, Region b)` Perform time consuming opening of the daughter regions.
`boolean`	`prepare()` Does checks on split inputs.
`SplitTransaction`	`registerTransactionListener(SplitTransaction.TransactionListener listener)` Register a listener for transaction preparation, execution, and possibly rollback phases.
`boolean`	`rollback(Server server, RegionServerServices services)` Roll back a failed transaction
`boolean`	`rollback(Server server, RegionServerServices services, User user)` Roll back a failed transaction
`private Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>`	`splitStoreFile(byte[] family, StoreFile sf)`
`private Pair<Integer,Integer>`	`splitStoreFiles(Map<byte[],List<StoreFile>> hstoreFilesToSplit)` Creates reference files for top and bottom half of the
`PairOfSameType<Region>`	`stepsAfterPONR(Server server, RegionServerServices services, PairOfSameType<Region> regions)` Deprecated.
`PairOfSameType<Region>`	`stepsAfterPONR(Server server, RegionServerServices services, PairOfSameType<Region> regions, User user)`
`PairOfSameType<Region>`	`stepsBeforePONR(Server server, RegionServerServices services, boolean testing)`
`private void`	`transition(SplitTransaction.SplitTransactionPhase nextPhase)`
`private void`	`transition(SplitTransaction.SplitTransactionPhase nextPhase, boolean isRollback)`
`private boolean`	`useCoordinatedStateManager(Server server)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

parent
```
private final HRegion parent
```

hri_a
```
private HRegionInfo hri_a
```

hri_b
```
private HRegionInfo hri_b
```

fileSplitTimeout
```
private long fileSplitTimeout
```

std

public SplitTransactionCoordination.SplitTransactionDetails std

useZKForAssignment
```
boolean useZKForAssignment
```

splitrow
```
private final byte[] splitrow
```

currentPhase

private SplitTransaction.SplitTransactionPhase currentPhase

server
```
private Server server
```

rsServices

private RegionServerServices rsServices

journal

private final List<SplitTransaction.JournalEntry> journal

listeners

private final ArrayList<SplitTransaction.TransactionListener> listeners

Listeners

closedByOtherException

private static IOException closedByOtherException

Constructor Detail
- SplitTransactionImpl
```
public SplitTransactionImpl(Region r,
                    byte[] splitrow)
```
  Constructor
  
  Parameters:
  r - Region to split
  splitrow - Row to split around

Method Detail

transition

private void transition(SplitTransaction.SplitTransactionPhase nextPhase)
                 throws IOException

Throws:: IOException

transition

private void transition(SplitTransaction.SplitTransactionPhase nextPhase,
              boolean isRollback)
                 throws IOException

Throws:: IOException

prepare
```
public boolean prepare()
                throws IOException
```
Does checks on split inputs.

Specified by:

prepare in interface SplitTransaction

Returns:
true if the region is splittable else false if it is not (e.g. its already closed, etc.).

Throws:

IOException

getDaughterRegionIdTimestamp
```
private static long getDaughterRegionIdTimestamp(HRegionInfo hri)
```
Calculate daughter regionid to use.

Parameters:
hri - Parent HRegionInfo

Returns:
Daughter region id (timestamp) to use.

createDaughters

PairOfSameType<Region> createDaughters(Server server,
                                     RegionServerServices services)
                                 throws IOException

Throws:: IOException

createDaughters
```
PairOfSameType<Region> createDaughters(Server server,
                                     RegionServerServices services,
                                     User user)
                                 throws IOException
```
Prepare the regions and region files.

Parameters:
server - Hosting server instance. Can be null when testing (won't try and update in zk if a null server)
services - Used to online/offline regions.
user -

Returns:
Regions created

Throws:

IOException - If thrown, transaction failed. Call rollback(Server, RegionServerServices)

stepsBeforePONR

public PairOfSameType<Region> stepsBeforePONR(Server server,
                                     RegionServerServices services,
                                     boolean testing)
                                       throws IOException

Throws:: IOException

assertReferenceFileCount

void assertReferenceFileCount(int expectedReferenceFileCount,
                            org.apache.hadoop.fs.Path dir)
                        throws IOException

Throws:: IOException

openDaughters
```
void openDaughters(Server server,
                 RegionServerServices services,
                 Region a,
                 Region b)
             throws IOException
```
Perform time consuming opening of the daughter regions.

Parameters:
server - Hosting server instance. Can be null when testing
services - Used to online/offline regions.
a - first daughter region
a - second daughter region

Throws:

IOException - If thrown, transaction failed. Call rollback(Server, RegionServerServices)

execute
```
public PairOfSameType<Region> execute(Server server,
                             RegionServerServices services)
                               throws IOException
```
Description copied from interface: SplitTransaction

Run the transaction.

Specified by:

execute in interface SplitTransaction

Parameters:
server - Hosting server instance. Can be null when testing.
services - Used to online/offline regions.

Returns:
Regions created

Throws:

IOException - If thrown, transaction failed. Call SplitTransaction.rollback(Server, RegionServerServices)
See Also:
SplitTransaction.rollback(Server, RegionServerServices)

execute
```
public PairOfSameType<Region> execute(Server server,
                             RegionServerServices services,
                             User user)
                               throws IOException
```
Run the transaction.

Specified by:

execute in interface SplitTransaction

Parameters:
server - Hosting server instance. Can be null when testing
services - Used to online/offline regions.

Returns:
Regions created

Throws:

IOException - If thrown, transaction failed. Call rollback(Server, RegionServerServices)

IOException
See Also:
rollback(Server, RegionServerServices)

stepsAfterPONR

@Deprecated
public PairOfSameType<Region> stepsAfterPONR(Server server,
                                               RegionServerServices services,
                                               PairOfSameType<Region> regions)
                                      throws IOException

Deprecated.

Throws:: IOException

stepsAfterPONR

public PairOfSameType<Region> stepsAfterPONR(Server server,
                                    RegionServerServices services,
                                    PairOfSameType<Region> regions,
                                    User user)
                                      throws IOException

Throws:: IOException

offlineParentInMetaAndputMetaEntries

private void offlineParentInMetaAndputMetaEntries(HConnection hConnection,
                                        HRegionInfo parent,
                                        HRegionInfo splitA,
                                        HRegionInfo splitB,
                                        ServerName serverName,
                                        List<Mutation> metaEntries,
                                        int regionReplication)
                                           throws IOException

Throws:: IOException

addEmptyLocation

private static Put addEmptyLocation(Put p,
                   int replicaId)

addLocation

public Put addLocation(Put p,
              ServerName sn,
              long openSeqNum)

openDaughterRegion

void openDaughterRegion(Server server,
                      HRegion daughter)
                  throws IOException,
                         org.apache.zookeeper.KeeperException

Open daughter regions, add them to online list and update meta.

Parameters:: server -; daughter -
Throws:: IOException; org.apache.zookeeper.KeeperException

useCoordinatedStateManager

private boolean useCoordinatedStateManager(Server server)

splitStoreFiles
```
private Pair<Integer,Integer> splitStoreFiles(Map<byte[],List<StoreFile>> hstoreFilesToSplit)
                                       throws IOException
```
Creates reference files for top and bottom half of the

Parameters:
hstoreFilesToSplit - map of store files to create half file references for.

Returns:
the number of reference files that were created.

Throws:

IOException

splitStoreFile

private Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path> splitStoreFile(byte[] family,
                                                                       StoreFile sf)
                                                                          throws IOException

Throws:: IOException

rollback
```
public boolean rollback(Server server,
               RegionServerServices services)
                 throws IOException
```
Description copied from interface: SplitTransaction

Roll back a failed transaction

Specified by:

rollback in interface SplitTransaction

Parameters:
server - Hosting server instance (May be null when testing).

Returns:
True if we successfully rolled back, false if we got to the point of no return and so now need to abort the server to minimize damage.

Throws:

IOException - If thrown, rollback failed. Take drastic action.

rollback
```
public boolean rollback(Server server,
               RegionServerServices services,
               User user)
                 throws IOException
```
Description copied from interface: SplitTransaction

Roll back a failed transaction

Specified by:

rollback in interface SplitTransaction

Parameters:
server - Hosting server instance (May be null when testing).
services -

Returns:
True if we successfully rolled back, false if we got to the point of no return and so now need to abort the server to minimize damage.

Throws:

IOException - If thrown, rollback failed. Take drastic action.

getFirstDaughter
```
HRegionInfo getFirstDaughter()
```

getSecondDaughter
```
HRegionInfo getSecondDaughter()
```

getJournal
```
public List<SplitTransaction.JournalEntry> getJournal()
```
Description copied from interface: SplitTransaction

Get the journal for the transaction.
Journal entries are an opaque type represented as JournalEntry. They can also provide useful debugging information via their toString method.

Specified by:

getJournal in interface SplitTransaction

Returns:
the transaction journal

registerTransactionListener
```
public SplitTransaction registerTransactionListener(SplitTransaction.TransactionListener listener)
```
Description copied from interface: SplitTransaction

Register a listener for transaction preparation, execution, and possibly rollback phases.
A listener can abort a transaction by throwing an exception.

Specified by:

registerTransactionListener in interface SplitTransaction

Parameters:
listener - the listener

Returns:
'this' for chaining

getServer
```
public Server getServer()
```
Description copied from interface: SplitTransaction

Get the Server running the transaction or rollback

Specified by:

getServer in interface SplitTransaction

Returns:
server instance

getRegionServerServices
```
public RegionServerServices getRegionServerServices()
```
Description copied from interface: SplitTransaction

Get the RegonServerServices of the server running the transaction or rollback

Specified by:

getRegionServerServices in interface SplitTransaction

Returns:
region server services

Class SplitTransactionImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.regionserver.SplitTransaction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

parent

hri_a

hri_b

fileSplitTimeout

std

useZKForAssignment

splitrow

currentPhase

server

rsServices

journal

listeners

closedByOtherException

Constructor Detail

SplitTransactionImpl

Method Detail

transition

transition

prepare

getDaughterRegionIdTimestamp

createDaughters

createDaughters

stepsBeforePONR

assertReferenceFileCount

openDaughters

execute

execute

stepsAfterPONR

stepsAfterPONR

offlineParentInMetaAndputMetaEntries

addEmptyLocation

addLocation

openDaughterRegion

useCoordinatedStateManager

splitStoreFiles

splitStoreFile

rollback

rollback

getFirstDaughter

getSecondDaughter

getJournal

registerTransactionListener

getServer

getRegionServerServices