org.apache.hudi.common.bootstrap.index

Class HFileBootstrapIndex

java.lang.Object

org.apache.hudi.common.bootstrap.index.BootstrapIndex

org.apache.hudi.common.bootstrap.index.HFileBootstrapIndex

All Implemented Interfaces:

Serializable

public class HFileBootstrapIndex
extends BootstrapIndex

Maintains mapping from skeleton file id to external bootstrap file. It maintains 2 physical indices. (a) At partition granularity to lookup all indices for each partition. (b) At file-group granularity to lookup bootstrap mapping for an individual file-group. This implementation uses HFile as physical storage of index. FOr the initial run, bootstrap mapping for the entire dataset resides in a single file but care has been taken in naming the index files in the same way as Hudi data files so that we can reuse file-system abstraction on these index files to manage multiple file-groups.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HFileBootstrapIndex.HFileBootstrapIndexReader HFile Based Index Reader.
static class	HFileBootstrapIndex.HFileBootstrapIndexWriter Bootstrap Index Writer to build bootstrap index.
static class	HFileBootstrapIndex.HoodieKVComparator This class is explicitly used as Key Comparator to workaround hard coded legacy format class names inside HBase.

Nested classes/interfaces inherited from class org.apache.hudi.common.bootstrap.index.BootstrapIndex

BootstrapIndex.IndexReader, BootstrapIndex.IndexWriter

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOTSTRAP_INDEX_FILE_ID
static byte[]	INDEX_INFO_KEY
protected static long	serialVersionUID

Fields inherited from class org.apache.hudi.common.bootstrap.index.BootstrapIndex

metaClient

Constructor Summary

Constructors

Constructor and Description
HFileBootstrapIndex(HoodieTableMetaClient metaClient)

Method Summary

Modifier and Type	Method and Description
BootstrapIndex.IndexReader	createReader() Create Bootstrap Index Reader.
BootstrapIndex.IndexWriter	createWriter(String bootstrapBasePath) Create Bootstrap Index Writer.
void	dropIndex() Drop bootstrap index.
boolean	isPresent() Check if bootstrap Index is physically present.

Methods inherited from class org.apache.hudi.common.bootstrap.index.BootstrapIndex

getBootstrapIndex, useIndex

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

See Also:

Constant Field Values

BOOTSTRAP_INDEX_FILE_ID

public static final String BOOTSTRAP_INDEX_FILE_ID

See Also:

Constant Field Values

INDEX_INFO_KEY

public static final byte[] INDEX_INFO_KEY

Constructor Detail

HFileBootstrapIndex

public HFileBootstrapIndex(HoodieTableMetaClient metaClient)

Method Detail

createReader

public BootstrapIndex.IndexReader createReader()

Description copied from class: BootstrapIndex

Create Bootstrap Index Reader.

Specified by:

createReader in class BootstrapIndex

Returns:

Index Reader

createWriter

public BootstrapIndex.IndexWriter createWriter(String bootstrapBasePath)

Description copied from class: BootstrapIndex

Create Bootstrap Index Writer.

Specified by:

createWriter in class BootstrapIndex

Parameters:

bootstrapBasePath - Source Base Path

Returns:

Index Writer

dropIndex

public void dropIndex()

Description copied from class: BootstrapIndex

Drop bootstrap index.

Specified by:

dropIndex in class BootstrapIndex

isPresent

public boolean isPresent()

Description copied from class: BootstrapIndex

Check if bootstrap Index is physically present. It does not guarantee the validity of the index. To ensure an index is valid, use useIndex() API.

Specified by:

isPresent in class BootstrapIndex