org.apache.hadoop.hbase.procedure2.store.wal

Class ProcedureWALFormatReader

java.lang.Object

org.apache.hadoop.hbase.procedure2.store.wal.ProcedureWALFormatReader

@InterfaceAudience.Private
public class ProcedureWALFormatReader
extends Object

Helper class that loads the procedures stored in a WAL.

Field Summary

Fields

Modifier and Type	Field and Description
private ProcedureWALFormat.Loader	loader
private WALProcedureMap	localProcedureMap We will use the localProcedureMap to track the active procedures for the current proc wal file, and when we finished reading one proc wal file, we will merge he localProcedureMap to the procedureMap, which tracks the global active procedures.
private ProcedureStoreTracker	localTracker If tracker for a log file is partial (see ProcedureStoreTracker.partial), we re-build the list of procedures modified in that WAL because we need it for log cleaning purposes.
private static org.slf4j.Logger	LOG
private long	maxProcId
private WALProcedureMap	procedureMap
private ProcedureStoreTracker	tracker Global tracker that will be used by the WALProcedureStore after load.

Constructor Summary

Constructors

Constructor and Description
ProcedureWALFormatReader(ProcedureStoreTracker tracker, ProcedureWALFormat.Loader loader)

Method Summary

Modifier and Type	Method and Description
private void	deleteEntry(long procId)
void	finish()
private void	insertIfPartial(ProcedureStoreTracker tracker, org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proc)
private boolean	isDeleted(long procId)
private boolean	isRequired(long procId)
private void	loadProcedure(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry, org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proc)
void	read(ProcedureWALFile log)
private void	readDeleteEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)
private void	readInitEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)
private void	readInsertEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)
private void	readUpdateEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)
private void	setDeletedIfPartial(ProcedureStoreTracker tracker, long procId)

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.slf4j.Logger LOG

localProcedureMap

private final WALProcedureMap localProcedureMap

We will use the localProcedureMap to track the active procedures for the current proc wal file, and when we finished reading one proc wal file, we will merge he localProcedureMap to the procedureMap, which tracks the global active procedures.

See the comments of WALProcedureMap for more details.

After reading all the proc wal files, we will use the procedures in the procedureMap to build a WALProcedureTree, and then give the result to the upper layer. See the comments of WALProcedureTree and the code in finish() for more details.

procedureMap

private final WALProcedureMap procedureMap

loader

private final ProcedureWALFormat.Loader loader

tracker

private final ProcedureStoreTracker tracker

Global tracker that will be used by the WALProcedureStore after load. If the last WAL was closed cleanly we already have a full tracker ready to be used. If the last WAL was truncated (e.g. master killed) the tracker will be empty and the 'partial' flag will be set. In this case, on WAL replay we are going to rebuild the tracker.

localTracker

private ProcedureStoreTracker localTracker

If tracker for a log file is partial (see ProcedureStoreTracker.partial), we re-build the list of procedures modified in that WAL because we need it for log cleaning purposes. If all procedures modified in a WAL are found to be obsolete, it can be safely deleted. (see WALProcedureStore.removeInactiveLogs()).

Notice that, the deleted part for this tracker will not be global valid as we can only count the deletes in the current file, but it is not big problem as finally, the above tracker will have the global state of deleted, and it will also be used to build the cleanup tracker.

maxProcId

private long maxProcId

Constructor Detail

ProcedureWALFormatReader

public ProcedureWALFormatReader(ProcedureStoreTracker tracker,
                                ProcedureWALFormat.Loader loader)

Method Detail

read

public void read(ProcedureWALFile log)
          throws IOException

Throws:

IOException

finish

public void finish()
            throws IOException

Throws:

IOException

setDeletedIfPartial

private void setDeletedIfPartial(ProcedureStoreTracker tracker,
                                 long procId)

insertIfPartial

private void insertIfPartial(ProcedureStoreTracker tracker,
                             org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proc)

loadProcedure

private void loadProcedure(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry,
                           org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.Procedure proc)

readInitEntry

private void readInitEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)

readInsertEntry

private void readInsertEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)

readUpdateEntry

private void readUpdateEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)

readDeleteEntry

private void readDeleteEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.ProcedureProtos.ProcedureWALEntry entry)

deleteEntry

private void deleteEntry(long procId)

isDeleted

private boolean isDeleted(long procId)

isRequired

private boolean isRequired(long procId)