WALProcedureStore (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.store.ProcedureStoreBase
- - org.apache.hadoop.hbase.procedure2.store.wal.WALProcedureStore

All Implemented Interfaces:: ProcedureStore

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class WALProcedureStore
extends ProcedureStoreBase

WAL implementation of the ProcedureStore.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface WALProcedureStore.LeaseRecovery

static class WALProcedureStore.SyncMetrics
- Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.procedure2.store.ProcedureStore
  ProcedureStore.ProcedureIterator, ProcedureStore.ProcedureLoader, ProcedureStore.ProcedureStoreListener

Nested Classes
Modifier and Type	Class and Description
`static interface`	`WALProcedureStore.LeaseRecovery`
`static class`	`WALProcedureStore.SyncMetrics`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`MAX_RETRIES_BEFORE_ROLL_CONF_KEY`
`static String`	`MAX_SYNC_FAILURE_ROLL_CONF_KEY`
`static String`	`PERIODIC_ROLL_CONF_KEY`
`static String`	`ROLL_RETRIES_CONF_KEY`
`static String`	`ROLL_THRESHOLD_CONF_KEY`
`static String`	`STORE_WAL_SYNC_STATS_COUNT`
`static String`	`SYNC_WAIT_MSEC_CONF_KEY`
`static String`	`USE_HSYNC_CONF_KEY`
`static String`	`WAIT_BEFORE_ROLL_CONF_KEY`

Constructor Summary

Constructors
Constructor and Description
`WALProcedureStore(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path walDir, WALProcedureStore.LeaseRecovery leaseRecovery)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`delete(long procId)` The specified procId was removed from the executor, due to completion, abort or failure.
`void`	`delete(Procedure proc, long[] subProcIds)` The parent procedure completed.
`ArrayList<ProcedureWALFile>`	`getActiveLogs()`
`Set<ProcedureWALFile>`	`getCorruptedLogs()`
`org.apache.hadoop.fs.FileSystem`	`getFileSystem()`
`protected org.apache.hadoop.fs.Path`	`getLogFilePath(long logId)`
`long`	`getMillisFromLastRoll()`
`long`	`getMillisToNextPeriodicRoll()`
`int`	`getNumThreads()`
`ProcedureStoreTracker`	`getStoreTracker()`
`ArrayList<WALProcedureStore.SyncMetrics>`	`getSyncMetrics()`
`org.apache.hadoop.fs.Path`	`getWALDir()`
`void`	`insert(Procedure proc, Procedure[] subprocs)` When a procedure is submitted to the executor insert(proc, null) will be called.
`void`	`load(ProcedureStore.ProcedureLoader loader)` Load the Procedures in the store.
`protected void`	`periodicRollForTesting()`
`void`	`recoverLease()` Acquire the lease for the procedure store.
`protected boolean`	`rollWriterForTesting()`
`void`	`start(int numSlots)` Start/Open the procedure store
`void`	`stop(boolean abort)` Stop/Close the procedure store
`protected long`	`syncSlots(org.apache.hadoop.fs.FSDataOutputStream stream, ByteSlot[] slots, int offset, int count)`
`void`	`update(Procedure proc)` The specified procedure was executed, and the new state should be written to the store.

Methods inherited from class org.apache.hadoop.hbase.procedure2.store.ProcedureStoreBase
isRunning, registerListener, sendAbortProcessSignal, sendPostSyncSignal, setRunning, unregisterListener

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

- Field Detail
  - MAX_RETRIES_BEFORE_ROLL_CONF_KEY
```
public static final String MAX_RETRIES_BEFORE_ROLL_CONF_KEY
```
    See Also:
    Constant Field Values
  - WAIT_BEFORE_ROLL_CONF_KEY
```
public static final String WAIT_BEFORE_ROLL_CONF_KEY
```
    See Also:
    Constant Field Values
  - ROLL_RETRIES_CONF_KEY
```
public static final String ROLL_RETRIES_CONF_KEY
```
    See Also:
    Constant Field Values
  - MAX_SYNC_FAILURE_ROLL_CONF_KEY
```
public static final String MAX_SYNC_FAILURE_ROLL_CONF_KEY
```
    See Also:
    Constant Field Values
  - PERIODIC_ROLL_CONF_KEY
```
public static final String PERIODIC_ROLL_CONF_KEY
```
    See Also:
    Constant Field Values
  - SYNC_WAIT_MSEC_CONF_KEY
```
public static final String SYNC_WAIT_MSEC_CONF_KEY
```
    See Also:
    Constant Field Values
  - USE_HSYNC_CONF_KEY
```
public static final String USE_HSYNC_CONF_KEY
```
    See Also:
    Constant Field Values
  - ROLL_THRESHOLD_CONF_KEY
```
public static final String ROLL_THRESHOLD_CONF_KEY
```
    See Also:
    Constant Field Values
  - STORE_WAL_SYNC_STATS_COUNT
```
public static final String STORE_WAL_SYNC_STATS_COUNT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - WALProcedureStore
```
public WALProcedureStore(org.apache.hadoop.conf.Configuration conf,
                 org.apache.hadoop.fs.FileSystem fs,
                 org.apache.hadoop.fs.Path walDir,
                 WALProcedureStore.LeaseRecovery leaseRecovery)
```
- Method Detail
  - start
```
public void start(int numSlots)
           throws IOException
```
    Description copied from interface: ProcedureStore
    
    Start/Open the procedure store
    
    Throws:
    
    IOException
  - stop
```
public void stop(boolean abort)
```
    Description copied from interface: ProcedureStore
    
    Stop/Close the procedure store
    
    Parameters:
    abort - true if the stop is an abort
  - getNumThreads
```
public int getNumThreads()
```
    Returns:
    the number of threads/slots passed to start()
  - getStoreTracker
```
public ProcedureStoreTracker getStoreTracker()
```
  - getActiveLogs
```
public ArrayList<ProcedureWALFile> getActiveLogs()
```
  - getCorruptedLogs
```
public Set<ProcedureWALFile> getCorruptedLogs()
```
  - recoverLease
```
public void recoverLease()
                  throws IOException
```
    Description copied from interface: ProcedureStore
    
    Acquire the lease for the procedure store.
    
    Throws:
    
    IOException
  - load
```
public void load(ProcedureStore.ProcedureLoader loader)
          throws IOException
```
    Description copied from interface: ProcedureStore
    
    Load the Procedures in the store.
    
    Parameters:
    loader - the ProcedureLoader that will handle the store-load events
    
    Throws:
    
    IOException
  - insert
```
public void insert(Procedure proc,
          Procedure[] subprocs)
```
    Description copied from interface: ProcedureStore
    
    When a procedure is submitted to the executor insert(proc, null) will be called. 'proc' has a 'RUNNABLE' state and the initial information required to start up. When a procedure is executed and it returns children insert(proc, subprocs) will be called. 'proc' has a 'WAITING' state and an update state. 'subprocs' are the children in 'RUNNABLE' state with the initial information.
    
    Parameters:
    proc - the procedure to serialize and write to the store.
    subprocs - the newly created child of the proc.
  - update
```
public void update(Procedure proc)
```
    Description copied from interface: ProcedureStore
    
    The specified procedure was executed, and the new state should be written to the store.
    
    Parameters:
    proc - the procedure to serialize and write to the store.
  - delete
```
public void delete(long procId)
```
    Description copied from interface: ProcedureStore
    
    The specified procId was removed from the executor, due to completion, abort or failure. The store implementor should remove all the information about the specified procId.
    
    Parameters:
    procId - the ID of the procedure to remove.
  - delete
```
public void delete(Procedure proc,
          long[] subProcIds)
```
    Description copied from interface: ProcedureStore
    
    The parent procedure completed. Update the state and mark all the child deleted.
    
    Parameters:
    proc - the parent procedure to serialize and write to the store.
    subProcIds - the IDs of the sub-procedure to remove.
  - getSyncMetrics
```
public ArrayList<WALProcedureStore.SyncMetrics> getSyncMetrics()
```
  - syncSlots
```
protected long syncSlots(org.apache.hadoop.fs.FSDataOutputStream stream,
             ByteSlot[] slots,
             int offset,
             int count)
                  throws IOException
```
    Throws:
    
    IOException
  - getMillisToNextPeriodicRoll
```
public long getMillisToNextPeriodicRoll()
```
  - getMillisFromLastRoll
```
public long getMillisFromLastRoll()
```
  - periodicRollForTesting
```
protected void periodicRollForTesting()
                               throws IOException
```
    Throws:
    
    IOException
  - rollWriterForTesting
```
protected boolean rollWriterForTesting()
                                throws IOException
```
    Throws:
    
    IOException
  - getWALDir
```
public org.apache.hadoop.fs.Path getWALDir()
```
  - getFileSystem
```
public org.apache.hadoop.fs.FileSystem getFileSystem()
```
  - getLogFilePath
```
protected org.apache.hadoop.fs.Path getLogFilePath(long logId)
                                            throws IOException
```
    Throws:
    
    IOException

Class WALProcedureStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.procedure2.store.ProcedureStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.procedure2.store.ProcedureStoreBase

Methods inherited from class java.lang.Object

Field Detail

MAX_RETRIES_BEFORE_ROLL_CONF_KEY

WAIT_BEFORE_ROLL_CONF_KEY

ROLL_RETRIES_CONF_KEY

MAX_SYNC_FAILURE_ROLL_CONF_KEY

PERIODIC_ROLL_CONF_KEY

SYNC_WAIT_MSEC_CONF_KEY

USE_HSYNC_CONF_KEY

ROLL_THRESHOLD_CONF_KEY

STORE_WAL_SYNC_STATS_COUNT

Constructor Detail

WALProcedureStore

Method Detail

start

stop

getNumThreads

getStoreTracker

getActiveLogs

getCorruptedLogs

recoverLease

load

insert

update

delete

delete

getSyncMetrics

syncSlots

getMillisToNextPeriodicRoll

getMillisFromLastRoll

periodicRollForTesting

rollWriterForTesting

getWALDir

getFileSystem

getLogFilePath