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

Class MultipleTreesBuilder

java.lang.Object

org.apache.pinot.segment.local.startree.v2.builder.MultipleTreesBuilder

All Implemented Interfaces:

Closeable, AutoCloseable

public class MultipleTreesBuilder
extends Object
implements Closeable

The MultipleTreesBuilder class is the top level star-tree builder that takes a list of StarTreeIndexConfigs and a boolean flag for the default star-tree, and builds multiple star-trees with the given MultipleTreesBuilder.BuildMode (ON_HEAP or OFF_HEAP).

The indexes for all star-trees will be stored in a single index file, and there will be an extra index map file to mark the offset and size of each index in the index file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultipleTreesBuilder.BuildMode

Constructor Summary

Constructors

Constructor	Description
MultipleTreesBuilder(List<StarTreeV2BuilderConfig> builderConfigs, File indexDir, MultipleTreesBuilder.BuildMode buildMode)	Constructor for the multiple star-trees builder.
MultipleTreesBuilder(List<StarTreeIndexConfig> indexConfigs, boolean enableDefaultStarTree, File indexDir, MultipleTreesBuilder.BuildMode buildMode)	Constructor for the multiple star-trees builder.

Method Summary

Modifier and Type	Method	Description
void	build()	Builds the star-trees.
void	close()

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipleTreesBuilder

public MultipleTreesBuilder(List<StarTreeV2BuilderConfig> builderConfigs,
                            File indexDir,
                            MultipleTreesBuilder.BuildMode buildMode)
                     throws Exception

Constructor for the multiple star-trees builder.

Parameters:

builderConfigs - List of builder configs (should already be deduplicated)

indexDir - Index directory

buildMode - Build mode (ON_HEAP or OFF_HEAP)

Throws:

Exception

MultipleTreesBuilder

public MultipleTreesBuilder(@Nullable
                            List<StarTreeIndexConfig> indexConfigs,
                            boolean enableDefaultStarTree,
                            File indexDir,
                            MultipleTreesBuilder.BuildMode buildMode)
                     throws Exception

Constructor for the multiple star-trees builder.

Parameters:

indexConfigs - List of index configs

enableDefaultStarTree - Whether to enable the default star-tree

indexDir - Index directory

buildMode - Build mode (ON_HEAP or OFF_HEAP)

Throws:

Exception

Method Detail

build

public void build()
           throws Exception

Builds the star-trees.

Throws:

Exception

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable