HoodieFunctionalIndex (hudi-common 1.0.0-beta2 API)

Type Parameters:

S - The source type of the values from the fields used in the functional index expression. Note that this assumes than an expression is operating on fields of same type.

T - The target type after applying the transformation. Represents the type of the indexed value.

All Superinterfaces:

Serializable
```
public interface HoodieFunctionalIndex<S,T>
extends Serializable
```
Interface representing a functional index in Hudi.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SPARK_CONCAT`
`static String`	`SPARK_DATE_ADD`
`static String`	`SPARK_DATE_FORMAT`
`static String`	`SPARK_DATE_SUB`
`static String`	`SPARK_DAY`
`static String`	`SPARK_FROM_UNIXTIME`
`static String`	`SPARK_HOUR`
`static String`	`SPARK_IDENTITY`
`static String`	`SPARK_LENGTH`
`static String`	`SPARK_LOWER`
`static String`	`SPARK_LTRIM`
`static String`	`SPARK_MONTH`
`static String`	`SPARK_REGEXP_EXTRACT`
`static String`	`SPARK_REGEXP_REPLACE`
`static String`	`SPARK_RTRIM`
`static String`	`SPARK_SPLIT`
`static String`	`SPARK_SUBSTRING`
`static String`	`SPARK_TO_DATE`
`static String`	`SPARK_TO_TIMESTAMP`
`static String`	`SPARK_TRIM`
`static String`	`SPARK_UNIX_TIMESTAMP`
`static String`	`SPARK_UPPER`
`static String`	`SPARK_YEAR`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`apply(List<S> orderedSourceValues)` Apply the transformation based on the source values and the expression.
`String`	`getIndexFunction()` Get the expression associated with the index.
`String`	`getIndexName()` Get the name of the index.
`List<String>`	`getOrderedSourceFields()` Get the list of fields involved in the expression in order.

- Field Detail
  - SPARK_DATE_FORMAT
```
static final String SPARK_DATE_FORMAT
```
    See Also:
    
    Constant Field Values
  - SPARK_DAY
```
static final String SPARK_DAY
```
    See Also:
    
    Constant Field Values
  - SPARK_MONTH
```
static final String SPARK_MONTH
```
    See Also:
    
    Constant Field Values
  - SPARK_YEAR
```
static final String SPARK_YEAR
```
    See Also:
    
    Constant Field Values
  - SPARK_HOUR
```
static final String SPARK_HOUR
```
    See Also:
    
    Constant Field Values
  - SPARK_FROM_UNIXTIME
```
static final String SPARK_FROM_UNIXTIME
```
    See Also:
    
    Constant Field Values
  - SPARK_UNIX_TIMESTAMP
```
static final String SPARK_UNIX_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - SPARK_TO_DATE
```
static final String SPARK_TO_DATE
```
    See Also:
    
    Constant Field Values
  - SPARK_TO_TIMESTAMP
```
static final String SPARK_TO_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - SPARK_DATE_ADD
```
static final String SPARK_DATE_ADD
```
    See Also:
    
    Constant Field Values
  - SPARK_DATE_SUB
```
static final String SPARK_DATE_SUB
```
    See Also:
    
    Constant Field Values
  - SPARK_CONCAT
```
static final String SPARK_CONCAT
```
    See Also:
    
    Constant Field Values
  - SPARK_SUBSTRING
```
static final String SPARK_SUBSTRING
```
    See Also:
    
    Constant Field Values
  - SPARK_UPPER
```
static final String SPARK_UPPER
```
    See Also:
    
    Constant Field Values
  - SPARK_LOWER
```
static final String SPARK_LOWER
```
    See Also:
    
    Constant Field Values
  - SPARK_TRIM
```
static final String SPARK_TRIM
```
    See Also:
    
    Constant Field Values
  - SPARK_LTRIM
```
static final String SPARK_LTRIM
```
    See Also:
    
    Constant Field Values
  - SPARK_RTRIM
```
static final String SPARK_RTRIM
```
    See Also:
    
    Constant Field Values
  - SPARK_LENGTH
```
static final String SPARK_LENGTH
```
    See Also:
    
    Constant Field Values
  - SPARK_REGEXP_REPLACE
```
static final String SPARK_REGEXP_REPLACE
```
    See Also:
    
    Constant Field Values
  - SPARK_REGEXP_EXTRACT
```
static final String SPARK_REGEXP_EXTRACT
```
    See Also:
    
    Constant Field Values
  - SPARK_SPLIT
```
static final String SPARK_SPLIT
```
    See Also:
    
    Constant Field Values
  - SPARK_IDENTITY
```
static final String SPARK_IDENTITY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getIndexName
```
String getIndexName()
```
    Get the name of the index.
    
    Returns:
    
    Name of the index.
  - getIndexFunction
```
String getIndexFunction()
```
    Get the expression associated with the index.
    
    Returns:
    
    Expression string.
  - getOrderedSourceFields
```
List<String> getOrderedSourceFields()
```
    Get the list of fields involved in the expression in order.
    
    Returns:
    
    List of fields.
  - apply
```
T apply(List<S> orderedSourceValues)
```
    Apply the transformation based on the source values and the expression.
    
    Parameters:
    
    orderedSourceValues - List of source values corresponding to fields in the expression.
    
    Returns:
    
    Transformed value.

Interface HoodieFunctionalIndex<S,T>

Field Summary

Method Summary

Field Detail

SPARK_DATE_FORMAT

SPARK_DAY

SPARK_MONTH

SPARK_YEAR

SPARK_HOUR

SPARK_FROM_UNIXTIME

SPARK_UNIX_TIMESTAMP

SPARK_TO_DATE

SPARK_TO_TIMESTAMP

SPARK_DATE_ADD

SPARK_DATE_SUB

SPARK_CONCAT

SPARK_SUBSTRING

SPARK_UPPER

SPARK_LOWER

SPARK_TRIM

SPARK_LTRIM

SPARK_RTRIM

SPARK_LENGTH

SPARK_REGEXP_REPLACE

SPARK_REGEXP_EXTRACT

SPARK_SPLIT

SPARK_IDENTITY

Method Detail

getIndexName

getIndexFunction

getOrderedSourceFields

apply