Package org.apache.iotdb.tsfile.write

Class TsFileWriter

java.lang.Object

org.apache.iotdb.tsfile.write.TsFileWriter

All Implemented Interfaces:

AutoCloseable

public class TsFileWriter
extends Object
implements AutoCloseable

TsFileWriter is the entrance for writing processing. It receives a record and send it to responding chunk group write. It checks memory size for all writing processing along its strategy and flush data stored in memory to OutputStream. At the end of writing, user should call close() method to flush the last data outside and close the normal outputStream and error outputStream.

Field Summary

Fields

Modifier and Type	Field	Description
protected static TSFileConfig	config
protected Schema	schema	schema of this TsFile.

Constructor Summary

Constructors

Modifier	Constructor	Description
	TsFileWriter(File file)	init this TsFileWriter.
	TsFileWriter(File file, Schema schema)	init this TsFileWriter.
	TsFileWriter(File file, Schema schema, TSFileConfig conf)	init this TsFileWriter.
	TsFileWriter(TsFileIOWriter fileWriter)	init this TsFileWriter.
protected	TsFileWriter(TsFileIOWriter fileWriter, Schema schema, TSFileConfig conf)	init this TsFileWriter.
	TsFileWriter(TsFileOutput output, Schema schema)	init this TsFileWriter.

Method Summary

Modifier and Type	Method	Description
void	close()	calling this method to write the last data remaining in memory and close the normal and error OutputStream.
boolean	flushAllChunkGroups()	flush the data in all series writers of all chunk group writers and their page writers to outputStream.
TsFileIOWriter	getIOWriter()	this function is only for Test.
void	registerAlignedTimeseries(Path devicePath, List<MeasurementSchema> measurementSchemas)	Register aligned timeseries.
void	registerDevice(String deviceId, String templateName)	This method is used to register all timeseries in the specified template under the specified device.
void	registerSchemaTemplate(String templateName, Map<String,MeasurementSchema> template, boolean isAligned)
void	registerTimeseries(Path devicePath, List<MeasurementSchema> measurementSchemas)	Register nonAligned timeseries by groups.
void	registerTimeseries(Path devicePath, MeasurementSchema measurementSchema)	Register nonAligned timeseries by single.
boolean	write(Tablet tablet)	write a tablet
boolean	write(TSRecord record)	write a record in type of T.
boolean	writeAligned(Tablet tablet)
boolean	writeAligned(TSRecord record)

Methods inherited from class java.lang.Object

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

Field Detail

config

protected static final TSFileConfig config

schema

protected final Schema schema

schema of this TsFile.

Constructor Detail

TsFileWriter

public TsFileWriter(File file)
             throws IOException

init this TsFileWriter.

Parameters:

file - the File to be written by this TsFileWriter

Throws:

IOException

TsFileWriter

public TsFileWriter(TsFileIOWriter fileWriter)
             throws IOException

init this TsFileWriter.

Parameters:

fileWriter - the io writer of this TsFile

Throws:

IOException

TsFileWriter

public TsFileWriter(File file,
                    Schema schema)
             throws IOException

init this TsFileWriter.

Parameters:

file - the File to be written by this TsFileWriter

schema - the schema of this TsFile

Throws:

IOException

TsFileWriter

public TsFileWriter(TsFileOutput output,
                    Schema schema)
             throws IOException

init this TsFileWriter.

Parameters:

output - the TsFileOutput of the file to be written by this TsFileWriter

schema - the schema of this TsFile

Throws:

IOException

TsFileWriter

public TsFileWriter(File file,
                    Schema schema,
                    TSFileConfig conf)
             throws IOException

init this TsFileWriter.

Parameters:

file - the File to be written by this TsFileWriter

schema - the schema of this TsFile

conf - the configuration of this TsFile

Throws:

IOException

TsFileWriter

protected TsFileWriter(TsFileIOWriter fileWriter,
                       Schema schema,
                       TSFileConfig conf)
                throws IOException

init this TsFileWriter.

Parameters:

fileWriter - the io writer of this TsFile

schema - the schema of this TsFile

conf - the configuration of this TsFile

Throws:

IOException

Method Detail

registerSchemaTemplate

public void registerSchemaTemplate(String templateName,
                                   Map<String,MeasurementSchema> template,
                                   boolean isAligned)

registerDevice

public void registerDevice(String deviceId,
                           String templateName)
                    throws WriteProcessException

This method is used to register all timeseries in the specified template under the specified device.

Parameters:

deviceId -

templateName -

Throws:

WriteProcessException

registerTimeseries

public void registerTimeseries(Path devicePath,
                               MeasurementSchema measurementSchema)
                        throws WriteProcessException

Register nonAligned timeseries by single.

Parameters:

devicePath -

measurementSchema -

Throws:

WriteProcessException

registerTimeseries

public void registerTimeseries(Path devicePath,
                               List<MeasurementSchema> measurementSchemas)

Register nonAligned timeseries by groups.

Parameters:

devicePath -

measurementSchemas -

registerAlignedTimeseries

public void registerAlignedTimeseries(Path devicePath,
                                      List<MeasurementSchema> measurementSchemas)
                               throws WriteProcessException

Register aligned timeseries. Once the device is registered for aligned timeseries, it cannot be expanded.

Parameters:

devicePath -

measurementSchemas -

Throws:

WriteProcessException

write

public boolean write(TSRecord record)
              throws IOException,
                     WriteProcessException

write a record in type of T.

Parameters:

record - - record responding a data line

Returns:

true -size of tsfile or metadata reaches the threshold. false - otherwise

Throws:

IOException - exception in IO

WriteProcessException - exception in write process

writeAligned

public boolean writeAligned(TSRecord record)
                     throws IOException,
                            WriteProcessException

Throws:

IOException

WriteProcessException

write

public boolean write(Tablet tablet)
              throws IOException,
                     WriteProcessException

write a tablet

Parameters:

tablet - - multiple time series of one device that share a time column

Throws:

IOException - exception in IO

WriteProcessException - exception in write process

writeAligned

public boolean writeAligned(Tablet tablet)
                     throws IOException,
                            WriteProcessException

Throws:

IOException

WriteProcessException

flushAllChunkGroups

public boolean flushAllChunkGroups()
                            throws IOException

flush the data in all series writers of all chunk group writers and their page writers to outputStream.

Returns:

true - size of tsfile or metadata reaches the threshold. false - otherwise. But this function just return false, the Override of IoTDB may return true.

Throws:

IOException - exception in IO

close

public void close()
           throws IOException

calling this method to write the last data remaining in memory and close the normal and error OutputStream.

Specified by:

close in interface AutoCloseable

Throws:

IOException - exception in IO

getIOWriter

public TsFileIOWriter getIOWriter()

this function is only for Test.

Returns:

TsFileIOWriter