Package org.apache.druid.segment.file

Class SegmentFileBuilderV10

java.lang.Object

org.apache.druid.segment.file.SegmentFileBuilderV10

All Implemented Interfaces:

Closeable, AutoCloseable, SegmentFileBuilder

public class SegmentFileBuilderV10
extends Object
implements SegmentFileBuilder

SegmentFileBuilder for V10 format segments. Right now, this uses a FileSmoosher underneath to build V9 smoosh files and collect the metadata about the offsets in those containers, and then appends them into the V10 consolidated segment file after the header and SegmentFileMetadata is written.

V10 file format: | version (byte) | meta compression (byte) | meta length (int) | meta json | container 0 | ... | container n |

Method Summary

Modifier and Type	Method	Description
void	abort()	cleanup any open resources in the event of an exception while building the segment files
void	add(String name, File fileToAdd)	Add a File to the segment file as the specified name
void	add(String name, ByteBuffer bufferToAdd)	Add a ByteBuffer to a segment file as the specified name
void	addBitmapEncoding(BitmapSerdeFactory bitmapEncoding)
void	addColumn(String name, ColumnDescriptor columnDescriptor)	Add a column to the metadata of this segment file
void	addInterval(String interval)
void	addProjections(List<ProjectionMetadata> projections)
SegmentFileChannel	addWithChannel(String name, long size)	Creates a SegmentFileChannel to write data to the segment file as the specified name.
void	close()	Close the segment file builder, writing the file(s) to the destination
static SegmentFileBuilderV10	create(com.fasterxml.jackson.databind.ObjectMapper jsonMapper, File baseDir)
static SegmentFileBuilderV10	create(com.fasterxml.jackson.databind.ObjectMapper jsonMapper, File baseDir, CompressionStrategy metaCompression)
SegmentFileBuilder	getExternalBuilder(String externalFile)	Allow adding data to an 'external' segment container file which will be built in the same directory as this segment file.

Methods inherited from class java.lang.Object

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

Method Details

create

public static SegmentFileBuilderV10 create(com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
 File baseDir)

create

public static SegmentFileBuilderV10 create(com.fasterxml.jackson.databind.ObjectMapper jsonMapper,
 File baseDir,
 CompressionStrategy metaCompression)

add

public void add(String name,
 File fileToAdd)
         throws IOException

Description copied from interface: SegmentFileBuilder

Add a File to the segment file as the specified name

Specified by:

add in interface SegmentFileBuilder

Throws:

IOException

add

public void add(String name,
 ByteBuffer bufferToAdd)
         throws IOException

Description copied from interface: SegmentFileBuilder

Add a ByteBuffer to a segment file as the specified name

Specified by:

add in interface SegmentFileBuilder

Throws:

IOException

addWithChannel

public SegmentFileChannel addWithChannel(String name,
 long size)
                                  throws IOException

Description copied from interface: SegmentFileBuilder

Creates a SegmentFileChannel to write data to the segment file as the specified name. Callers must be sure to write the amount of data specified by the size parameter.

Specified by:

addWithChannel in interface SegmentFileBuilder

Throws:

IOException

getExternalBuilder

public SegmentFileBuilder getExternalBuilder(String externalFile)

Description copied from interface: SegmentFileBuilder

Allow adding data to an 'external' segment container file which will be built in the same directory as this segment file. Legacy implementations of this method just return the same builder since they do not support this concept. This allows column implementations to use these methods, but also still work with older segment formats (assuming the older format otherwise supports the contents).

Specified by:

getExternalBuilder in interface SegmentFileBuilder

addColumn

public void addColumn(String name,
 ColumnDescriptor columnDescriptor)

Description copied from interface: SegmentFileBuilder

Add a column to the metadata of this segment file

Specified by:

addColumn in interface SegmentFileBuilder

addInterval

public void addInterval(String interval)

addBitmapEncoding

public void addBitmapEncoding(BitmapSerdeFactory bitmapEncoding)

addProjections

public void addProjections(List<ProjectionMetadata> projections)

abort

public void abort()

Description copied from interface: SegmentFileBuilder

cleanup any open resources in the event of an exception while building the segment files

Specified by:

abort in interface SegmentFileBuilder

close

public void close()
           throws IOException

Description copied from interface: SegmentFileBuilder

Close the segment file builder, writing the file(s) to the destination

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SegmentFileBuilder

Throws:

IOException