Package org.apache.pinot.segment.local.startree

Class StarTreeBuilderUtils

java.lang.Object

org.apache.pinot.segment.local.startree.StarTreeBuilderUtils

public class StarTreeBuilderUtils
extends Object

The StarTreeBuilderUtils class contains utility methods for star-tree builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StarTreeBuilderUtils.TreeNode

Field Summary

Fields

Modifier and Type	Field	Description
static int	INVALID_ID

Method Summary

Modifier and Type	Method	Description
static List<StarTreeV2BuilderConfig>	generateBuilderConfigs(List<StarTreeIndexConfig> indexConfigs, boolean enableDefaultStarTree, SegmentMetadata segmentMetadata)	Generates the deduplicated star-tree builder configs.
static void	removeStarTrees(File indexDir)	Removes all the star-trees from the given segment.
static void	serializeTree(File starTreeFile, StarTreeBuilderUtils.TreeNode rootNode, String[] dimensions, int numNodes)	Serialize the star-tree structure into a file.
static boolean	shouldRemoveExistingStarTrees(List<StarTreeV2BuilderConfig> builderConfigs, List<StarTreeV2Metadata> metadataList)	Returns true if the given star-tree builder configs do not match the star-tree metadata, in which case the existing star-trees need to be removed, false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_ID

public static final int INVALID_ID

See Also:

Constant Field Values

Method Detail

generateBuilderConfigs

public static List<StarTreeV2BuilderConfig> generateBuilderConfigs(@Nullable
                                                                   List<StarTreeIndexConfig> indexConfigs,
                                                                   boolean enableDefaultStarTree,
                                                                   SegmentMetadata segmentMetadata)

Generates the deduplicated star-tree builder configs.

serializeTree

public static void serializeTree(File starTreeFile,
                                 StarTreeBuilderUtils.TreeNode rootNode,
                                 String[] dimensions,
                                 int numNodes)
                          throws IOException

Serialize the star-tree structure into a file.

Throws:

IOException

shouldRemoveExistingStarTrees

public static boolean shouldRemoveExistingStarTrees(List<StarTreeV2BuilderConfig> builderConfigs,
                                                    List<StarTreeV2Metadata> metadataList)

Returns true if the given star-tree builder configs do not match the star-tree metadata, in which case the existing star-trees need to be removed, false otherwise.

removeStarTrees

public static void removeStarTrees(File indexDir)
                            throws Exception

Removes all the star-trees from the given segment.

Throws:

Exception