ProcedureWALFormat (Apache HBase 1.2.12 API)

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

@InterfaceAudience.Private
@InterfaceStability.Evolving
public final class ProcedureWALFormat
extends Object

Helper class that contains the WAL serialization utils.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ProcedureWALFormat.InvalidWALDataException

(package private) static interface ProcedureWALFormat.Loader

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcedureWALFormat.InvalidWALDataException`
`(package private) static interface`	`ProcedureWALFormat.Loader`

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static long`	`HEADER_MAGIC`
`(package private) static byte`	`HEADER_VERSION`
`(package private) static byte`	`LOG_TYPE_COMPACTED`
`(package private) static byte`	`LOG_TYPE_MAX_VALID`
`(package private) static byte`	`LOG_TYPE_STREAM`
`(package private) static long`	`TRAILER_MAGIC`
`(package private) static byte`	`TRAILER_VERSION`

Constructor Summary

Constructors
Modifier Constructor and Description

private ProcedureWALFormat()

Constructors
Modifier	Constructor and Description
`private`	`ProcedureWALFormat()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`load(Iterator<ProcedureWALFile> logs, ProcedureStoreTracker tracker, ProcedureWALFormat.Loader loader)`
`static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALEntry`	`readEntry(InputStream stream)`
`static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALHeader`	`readHeader(InputStream stream)`
`static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALTrailer`	`readTrailer(org.apache.hadoop.fs.FSDataInputStream stream, long startPos, long size)`
`static void`	`writeDelete(ByteSlot slot, long procId)`
`static void`	`writeEntry(ByteSlot slot, org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALEntry.Type type, Procedure proc, Procedure[] subprocs)`
`static void`	`writeHeader(OutputStream stream, org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALHeader header)`
`static void`	`writeInsert(ByteSlot slot, Procedure proc)`
`static void`	`writeInsert(ByteSlot slot, Procedure proc, Procedure[] subprocs)`
`static void`	`writeTrailer(org.apache.hadoop.fs.FSDataOutputStream stream, ProcedureStoreTracker tracker)`
`static void`	`writeUpdate(ByteSlot slot, Procedure proc)`

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

Field Detail
- LOG_TYPE_STREAM
```
static final byte LOG_TYPE_STREAM
```
  See Also:
  Constant Field Values
- LOG_TYPE_COMPACTED
```
static final byte LOG_TYPE_COMPACTED
```
  See Also:
  Constant Field Values
- LOG_TYPE_MAX_VALID
```
static final byte LOG_TYPE_MAX_VALID
```
  See Also:
  Constant Field Values
- HEADER_VERSION
```
static final byte HEADER_VERSION
```
  See Also:
  Constant Field Values
- TRAILER_VERSION
```
static final byte TRAILER_VERSION
```
  See Also:
  Constant Field Values
- HEADER_MAGIC
```
static final long HEADER_MAGIC
```
  See Also:
  Constant Field Values
- TRAILER_MAGIC
```
static final long TRAILER_MAGIC
```
  See Also:
  Constant Field Values

Constructor Detail
- ProcedureWALFormat
```
private ProcedureWALFormat()
```

Method Detail

load

public static void load(Iterator<ProcedureWALFile> logs,
        ProcedureStoreTracker tracker,
        ProcedureWALFormat.Loader loader)
                 throws IOException

Throws:: IOException

writeHeader

public static void writeHeader(OutputStream stream,
               org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALHeader header)
                        throws IOException

Throws:: IOException

writeTrailer

public static void writeTrailer(org.apache.hadoop.fs.FSDataOutputStream stream,
                ProcedureStoreTracker tracker)
                         throws IOException

Throws:: IOException

readHeader

public static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALHeader readHeader(InputStream stream)
                                                                                                throws IOException

Throws:: IOException

readTrailer

public static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALTrailer readTrailer(org.apache.hadoop.fs.FSDataInputStream stream,
                                                                                         long startPos,
                                                                                         long size)
                                                                                                  throws IOException

Throws:: IOException

readEntry

public static org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALEntry readEntry(InputStream stream)
                                                                                              throws IOException

Throws:: IOException

writeEntry

public static void writeEntry(ByteSlot slot,
              org.apache.hadoop.hbase.protobuf.generated.ProcedureProtos.ProcedureWALEntry.Type type,
              Procedure proc,
              Procedure[] subprocs)
                       throws IOException

Throws:: IOException

writeInsert

public static void writeInsert(ByteSlot slot,
               Procedure proc)
                        throws IOException

Throws:: IOException

writeInsert

public static void writeInsert(ByteSlot slot,
               Procedure proc,
               Procedure[] subprocs)
                        throws IOException

Throws:: IOException

writeUpdate

public static void writeUpdate(ByteSlot slot,
               Procedure proc)
                        throws IOException

Throws:: IOException

writeDelete

public static void writeDelete(ByteSlot slot,
               long procId)
                        throws IOException

Throws:: IOException

Class ProcedureWALFormat

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG_TYPE_STREAM

LOG_TYPE_COMPACTED

LOG_TYPE_MAX_VALID

HEADER_VERSION

TRAILER_VERSION

HEADER_MAGIC

TRAILER_MAGIC

Constructor Detail

ProcedureWALFormat

Method Detail

load

writeHeader

writeTrailer

readHeader

readTrailer

readEntry

writeEntry

writeInsert

writeInsert

writeUpdate

writeDelete