org.apache.hudi.index.functional.HoodieFunctionalIndex Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hudi-spark3.0-bundle_2.12 Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.hudi.index.functional;

import java.io.Serializable;
import java.util.List;

/**
 * Interface representing a functional index in Hudi.
 *
 * @param  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.
 * @param  The target type after applying the transformation. Represents the type of the indexed value.
 */
public interface HoodieFunctionalIndex extends Serializable {

  public static final String SPARK_DATE_FORMAT = "date_format";
  public static final String SPARK_DAY = "day";
  public static final String SPARK_MONTH = "month";
  public static final String SPARK_YEAR = "year";
  public static final String SPARK_HOUR = "hour";
  public static final String SPARK_FROM_UNIXTIME = "from_unixtime";
  public static final String SPARK_UNIX_TIMESTAMP = "unix_timestamp";
  public static final String SPARK_TO_DATE = "to_date";
  public static final String SPARK_TO_TIMESTAMP = "to_timestamp";
  public static final String SPARK_DATE_ADD = "date_add";
  public static final String SPARK_DATE_SUB = "date_sub";
  public static final String SPARK_CONCAT = "concat";
  public static final String SPARK_SUBSTRING = "substring";
  public static final String SPARK_UPPER = "upper";
  public static final String SPARK_LOWER = "lower";
  public static final String SPARK_TRIM = "trim";
  public static final String SPARK_LTRIM = "ltrim";
  public static final String SPARK_RTRIM = "rtrim";
  public static final String SPARK_LENGTH = "length";
  public static final String SPARK_REGEXP_REPLACE = "regexp_replace";
  public static final String SPARK_REGEXP_EXTRACT = "regexp_extract";
  public static final String SPARK_SPLIT = "split";
  public static final String SPARK_IDENTITY = "identity";

  /**
   * Get the name of the index.
   *
   * @return Name of the index.
   */
  String getIndexName();

  /**
   * Get the expression associated with the index.
   *
   * @return Expression string.
   */
  String getIndexFunction();

  /**
   * Get the list of fields involved in the expression in order.
   *
   * @return List of fields.
   */
  List getOrderedSourceFields();

  /**
   * Apply the transformation based on the source values and the expression.
   *
   * @param orderedSourceValues List of source values corresponding to fields in the expression.
   * @return Transformed value.
   */
  T apply(List orderedSourceValues);
}