org.apache.hudi.table.action.index.functional

Class BaseHoodieIndexClient

java.lang.Object

org.apache.hudi.table.action.index.functional.BaseHoodieIndexClient

public abstract class BaseHoodieIndexClient
extends Object

Constructor Summary

Constructors

Constructor and Description
BaseHoodieIndexClient()

Method Summary

Modifier and Type	Method and Description
abstract void	create(HoodieTableMetaClient metaClient, String indexName, String indexType, Map<String,Map<String,String>> columns, Map<String,String> options) Create a expression index.
abstract void	drop(HoodieTableMetaClient metaClient, String indexName, boolean ignoreIfNotExists) Drop an index.
void	register(HoodieTableMetaClient metaClient, HoodieIndexDefinition indexDefinition) Register a expression index.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseHoodieIndexClient

public BaseHoodieIndexClient()

Method Detail

register

public void register(HoodieTableMetaClient metaClient,
                     HoodieIndexDefinition indexDefinition)

Register a expression index. Index definitions are stored in user-specified path or, by default, in .hoodie/.index_defs/index.json. For the first time, the index definition file will be created if not exists. For the second time, the index definition file will be updated if exists. Table Config is updated if necessary.

create

public abstract void create(HoodieTableMetaClient metaClient,
                            String indexName,
                            String indexType,
                            Map<String,Map<String,String>> columns,
                            Map<String,String> options)
                     throws Exception

Create a expression index.

Throws:

Exception

drop

public abstract void drop(HoodieTableMetaClient metaClient,
                          String indexName,
                          boolean ignoreIfNotExists)

Drop an index. By default, ignore drop if index does not exist.

Parameters:

metaClient - HoodieTableMetaClient instance

indexName - index name for the index to be dropped

ignoreIfNotExists - ignore drop if index does not exist