org.apache.hudi.common.bootstrap.index

Class BootstrapIndex

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HFileBootstrapIndex, NoOpBootstrapIndex

public abstract class BootstrapIndex
extends Object
implements Serializable

Bootstrap Index Interface.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BootstrapIndex.IndexReader Bootstrap Index Reader Interface.
static class	BootstrapIndex.IndexWriter Bootstrap Index Writer Interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected HoodieTableMetaClient	metaClient
protected static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
BootstrapIndex(HoodieTableMetaClient metaClient)

Method Summary

Modifier and Type	Method and Description
abstract BootstrapIndex.IndexReader	createReader() Create Bootstrap Index Reader.
abstract BootstrapIndex.IndexWriter	createWriter(String sourceBasePath) Create Bootstrap Index Writer.
abstract void	dropIndex() Drop bootstrap index.
static BootstrapIndex	getBootstrapIndex(HoodieTableMetaClient metaClient)
protected abstract boolean	isPresent() Check if bootstrap Index is physically present.
boolean	useIndex() Returns true if valid metadata bootstrap is present.

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

metaClient

protected final HoodieTableMetaClient metaClient

Constructor Detail

BootstrapIndex

public BootstrapIndex(HoodieTableMetaClient metaClient)

Method Detail

createReader

public abstract BootstrapIndex.IndexReader createReader()

Create Bootstrap Index Reader.

Returns:

Index Reader

createWriter

public abstract BootstrapIndex.IndexWriter createWriter(String sourceBasePath)

Create Bootstrap Index Writer.

Parameters:

sourceBasePath - Source Base Path

Returns:

Index Writer

dropIndex

public abstract void dropIndex()

Drop bootstrap index.

useIndex

public final boolean useIndex()

Returns true if valid metadata bootstrap is present.

Returns:

isPresent

protected abstract boolean isPresent()

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.

getBootstrapIndex

public static BootstrapIndex getBootstrapIndex(HoodieTableMetaClient metaClient)