Package org.apache.pinot.spi.config.table

Class JsonIndexConfig

  • All Implemented Interfaces:
    Serializable
    public class JsonIndexConfig
extends BaseJsonConfig
    Configs related to the JSON index: - maxLevels: Max levels to flatten the json object (array is also counted as one level), non-positive value means unlimited - excludeArray: Whether to exclude array when flattening the object - disableCrossArrayUnnest: Whether to not unnest multiple arrays (unique combination of all elements) - includePaths: Only include the given paths, e.g. "$.a.b", "$.a.c[*]" (mutual exclusive with excludePaths). Paths under the included paths will be included, e.g. "$.a.b.c" will be included when "$.a.b" is configured to be included. - excludePaths: Exclude the given paths, e.g. "$.a.b", "$.a.c[*]" (mutual exclusive with includePaths). Paths under the excluded paths will also be excluded, e.g. "$.a.b.c" will be excluded when "$.a.b" is configured to be excluded. - excludeFields: Exclude the given fields, e.g. "b", "c", even if it is under the included paths.
    See Also:
    Serialized Form

    • Constructor Detail

      • JsonIndexConfig

        public JsonIndexConfig()

    • Method Detail

      • getMaxLevels

        public int getMaxLevels()

      • setMaxLevels

        public void setMaxLevels​(int maxLevels)

      • isExcludeArray

        public boolean isExcludeArray()

      • setExcludeArray

        public void setExcludeArray​(boolean excludeArray)

      • isDisableCrossArrayUnnest

        public boolean isDisableCrossArrayUnnest()

      • setDisableCrossArrayUnnest

        public void setDisableCrossArrayUnnest​(boolean disableCrossArrayUnnest)

      • getIncludePaths

        @Nullable
public Set<String> getIncludePaths()

      • setIncludePaths

        public void setIncludePaths​(@Nullable
                            Set<String> includePaths)

      • getExcludePaths

        @Nullable
public Set<String> getExcludePaths()

      • setExcludePaths

        public void setExcludePaths​(@Nullable
                            Set<String> excludePaths)

      • getExcludeFields

        @Nullable
public Set<String> getExcludeFields()

      • setExcludeFields

        public void setExcludeFields​(@Nullable
                             Set<String> excludeFields)