org.apache.hudi.secondary.index

Class SecondaryIndexManager

java.lang.Object

org.apache.hudi.secondary.index.SecondaryIndexManager

public class SecondaryIndexManager
extends Object

Manages secondary index.

Method Summary

Modifier and Type	Method and Description
void	create(HoodieTableMetaClient metaClient, String indexName, String indexType, boolean ignoreIfExists, LinkedHashMap<String,Map<String,String>> columns, Map<String,String> options) Create a secondary index for hoodie table, two steps will be performed: 1.
void	drop(HoodieTableMetaClient metaClient, String indexName, boolean ignoreIfNotExists) Drop a secondary index by index name
static SecondaryIndexManager	getInstance()
void	refresh(HoodieTableMetaClient metaClient, String indexName) Refresh the specific secondary index
Option<List<HoodieSecondaryIndex>>	show(HoodieTableMetaClient metaClient) Show secondary indexes from hoodie table

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SecondaryIndexManager getInstance()

create

public void create(HoodieTableMetaClient metaClient,
                   String indexName,
                   String indexType,
                   boolean ignoreIfExists,
                   LinkedHashMap<String,Map<String,String>> columns,
                   Map<String,String> options)

Create a secondary index for hoodie table, two steps will be performed: 1. Add secondary index metadata to hoodie.properties 2. Trigger build secondary index

Parameters:

metaClient - Hoodie table meta client

indexName - The unique secondary index name

indexType - Index type

ignoreIfExists - Whether ignore the creation if the specific secondary index exists

columns - The columns referenced by this secondary index, each column has its own options

options - Options for this secondary index

drop

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

Drop a secondary index by index name

Parameters:

metaClient - Hoodie table meta client

indexName - The unique secondary index name

ignoreIfNotExists - Whether ignore drop if the specific secondary index no exists

show

public Option<List<HoodieSecondaryIndex>> show(HoodieTableMetaClient metaClient)

Show secondary indexes from hoodie table

Parameters:

metaClient - Hoodie table meta client

Returns:

Indexes in this table

refresh

public void refresh(HoodieTableMetaClient metaClient,
                    String indexName)

Refresh the specific secondary index

Parameters:

metaClient - Hoodie table meta client

indexName - The target secondary index name