TSFileConfig (TsFile 0.14.0-preview1 API)

java.lang.Object
- org.apache.iotdb.tsfile.common.conf.TSFileConfig

All Implemented Interfaces:

Serializable
```
public class TSFileConfig
extends Object
implements Serializable
```
TSFileConfig is a configuration class. Every variable is public and has default value.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY_CAPACITY_THRESHOLD` The primitive array capacity threshold.
`static int`	`BYTE_SIZE_PER_CHAR` String encoder with UTF-8 encodes a character to at most 4 bytes.
`static String`	`CONFIG_FILE_NAME`
`static int`	`DOUBLE_VALUE_LENGTH`
`static int`	`FLOAT_VALUE_LENGTH`
`static double`	`GORILLA_ENCODING_ENDING_DOUBLE`
`static float`	`GORILLA_ENCODING_ENDING_FLOAT`
`static int`	`GORILLA_ENCODING_ENDING_INTEGER`
`static long`	`GORILLA_ENCODING_ENDING_LONG`
`static int`	`LEADING_ZERO_BITS_LENGTH_32BIT`
`static int`	`LEADING_ZERO_BITS_LENGTH_64BIT`
`static String`	`MAGIC_STRING`
`static double`	`MAX_BLOOM_FILTER_ERROR_RATE`
`static int`	`MEANINGFUL_XOR_BITS_LENGTH_32BIT`
`static int`	`MEANINGFUL_XOR_BITS_LENGTH_64BIT`
`static double`	`MIN_BLOOM_FILTER_ERROR_RATE` Bloom filter constrain
`static int`	`RLE_MAX_BIT_PACKED_NUM`
`static int`	`RLE_MAX_REPEATED_NUM`
`static int`	`RLE_MIN_REPEATED_NUM` encoding configuration
`static Charset`	`STRING_CHARSET`
`static String`	`STRING_ENCODING`
`static int`	`VALUE_BITS_LENGTH_32BIT`
`static int`	`VALUE_BITS_LENGTH_64BIT`
`static byte`	`VERSION_NUMBER` version number is changed to use 1 byte to represent since version 3
`static String`	`VERSION_NUMBER_V1`
`static String`	`VERSION_NUMBER_V2`

Constructor Summary

Constructors
Constructor and Description

TSFileConfig()

Constructors
Constructor and Description
`TSFileConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBatchSize()`
`double`	`getBloomFilterErrorRate()`
`CompressionType`	`getCompressor()`
`String`	`getCoreSitePath()`
`int`	`getDeltaBlockSize()`
`String`	`getDfsClientFailoverProxyProvider()`
`String[]`	`getDfsHaNamenodes()`
`String`	`getDfsNameServices()`
`double`	`getDftSatisfyRate()`
`String`	`getEndian()`
`int`	`getFloatPrecision()`
`int`	`getFreqEncodingBlockSize()`
`double`	`getFreqEncodingSNR()`
`String`	`getFreqType()`
`int`	`getGroupSizeInByte()`
`String[]`	`getHdfsIp()`
`String`	`getHdfsPort()`
`String`	`getHdfsSitePath()`
`String`	`getKerberosKeytabFilePath()`
`String`	`getKerberosPrincipal()`
`int`	`getMaxDegreeOfIndexNode()`
`int`	`getMaxNumberOfPointsInPage()`
`int`	`getMaxStringLength()`
`int`	`getPageCheckSizeThreshold()`
`int`	`getPageSizeInByte()`
`double`	`getPlaMaxError()`
`int`	`getRleBitWidth()`
`double`	`getSdtMaxError()`
`String`	`getTimeEncoder()`
`TSDataType`	`getTimeSeriesDataType()`
`FSType`	`getTSFileStorageFs()`
`String`	`getValueEncoder()`
`boolean`	`isDfsHaAutomaticFailoverEnabled()`
`boolean`	`isUseKerberos()`
`void`	`setBatchSize(int batchSize)`
`void`	`setBloomFilterErrorRate(double bloomFilterErrorRate)`
`void`	`setCompressor(String compressor)`
`void`	`setCoreSitePath(String coreSitePath)`
`void`	`setDeltaBlockSize(int deltaBlockSize)`
`void`	`setDfsClientFailoverProxyProvider(String dfsClientFailoverProxyProvider)`
`void`	`setDfsHaAutomaticFailoverEnabled(boolean dfsHaAutomaticFailoverEnabled)`
`void`	`setDfsHaNamenodes(String[] dfsHaNamenodes)`
`void`	`setDfsNameServices(String dfsNameServices)`
`void`	`setDftSatisfyRate(double dftSatisfyRate)`
`void`	`setEndian(String endian)`
`void`	`setFloatPrecision(int floatPrecision)`
`void`	`setFreqEncodingBlockSize(int freqEncodingBlockSize)`
`void`	`setFreqEncodingSNR(double freqEncodingSNR)`
`void`	`setFreqType(String freqType)`
`void`	`setGroupSizeInByte(int groupSizeInByte)`
`void`	`setHdfsIp(String[] hdfsIp)`
`void`	`setHdfsPort(String hdfsPort)`
`void`	`setHdfsSitePath(String hdfsSitePath)`
`void`	`setKerberosKeytabFilePath(String kerberosKeytabFilePath)`
`void`	`setKerberosPrincipal(String kerberosPrincipal)`
`void`	`setMaxDegreeOfIndexNode(int maxDegreeOfIndexNode)`
`void`	`setMaxNumberOfPointsInPage(int maxNumberOfPointsInPage)`
`void`	`setMaxStringLength(int maxStringLength)`
`void`	`setPageCheckSizeThreshold(int pageCheckSizeThreshold)`
`void`	`setPageSizeInByte(int pageSizeInByte)`
`void`	`setPlaMaxError(double plaMaxError)`
`void`	`setRleBitWidth(int rleBitWidth)`
`void`	`setSdtMaxError(double sdtMaxError)`
`void`	`setTimeEncoder(String timeEncoder)`
`void`	`setTimeSeriesDataType(TSDataType timeSeriesDataType)`
`void`	`setTSFileStorageFs(FSType fileStorageFs)`
`void`	`setUseKerberos(boolean useKerberos)`
`void`	`setValueEncoder(String valueEncoder)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- RLE_MIN_REPEATED_NUM
```
public static final int RLE_MIN_REPEATED_NUM
```
  encoding configuration
  
  See Also:
  
  Constant Field Values
- RLE_MAX_REPEATED_NUM
```
public static final int RLE_MAX_REPEATED_NUM
```
  See Also:
  
  Constant Field Values
- RLE_MAX_BIT_PACKED_NUM
```
public static final int RLE_MAX_BIT_PACKED_NUM
```
  See Also:
  
  Constant Field Values
- FLOAT_VALUE_LENGTH
```
public static final int FLOAT_VALUE_LENGTH
```
  See Also:
  
  Constant Field Values
- DOUBLE_VALUE_LENGTH
```
public static final int DOUBLE_VALUE_LENGTH
```
  See Also:
  
  Constant Field Values
- VALUE_BITS_LENGTH_32BIT
```
public static final int VALUE_BITS_LENGTH_32BIT
```
  See Also:
  
  Constant Field Values
- LEADING_ZERO_BITS_LENGTH_32BIT
```
public static final int LEADING_ZERO_BITS_LENGTH_32BIT
```
  See Also:
  
  Constant Field Values
- MEANINGFUL_XOR_BITS_LENGTH_32BIT
```
public static final int MEANINGFUL_XOR_BITS_LENGTH_32BIT
```
  See Also:
  
  Constant Field Values
- VALUE_BITS_LENGTH_64BIT
```
public static final int VALUE_BITS_LENGTH_64BIT
```
  See Also:
  
  Constant Field Values
- LEADING_ZERO_BITS_LENGTH_64BIT
```
public static final int LEADING_ZERO_BITS_LENGTH_64BIT
```
  See Also:
  
  Constant Field Values
- MEANINGFUL_XOR_BITS_LENGTH_64BIT
```
public static final int MEANINGFUL_XOR_BITS_LENGTH_64BIT
```
  See Also:
  
  Constant Field Values
- GORILLA_ENCODING_ENDING_INTEGER
```
public static final int GORILLA_ENCODING_ENDING_INTEGER
```
  See Also:
  
  Constant Field Values
- GORILLA_ENCODING_ENDING_LONG
```
public static final long GORILLA_ENCODING_ENDING_LONG
```
  See Also:
  
  Constant Field Values
- GORILLA_ENCODING_ENDING_FLOAT
```
public static final float GORILLA_ENCODING_ENDING_FLOAT
```
  See Also:
  
  Constant Field Values
- GORILLA_ENCODING_ENDING_DOUBLE
```
public static final double GORILLA_ENCODING_ENDING_DOUBLE
```
  See Also:
  
  Constant Field Values
- BYTE_SIZE_PER_CHAR
```
public static final int BYTE_SIZE_PER_CHAR
```
  String encoder with UTF-8 encodes a character to at most 4 bytes.
  
  See Also:
  
  Constant Field Values
- STRING_ENCODING
```
public static final String STRING_ENCODING
```
  See Also:
  
  Constant Field Values
- STRING_CHARSET
```
public static final Charset STRING_CHARSET
```
- CONFIG_FILE_NAME
```
public static final String CONFIG_FILE_NAME
```
  See Also:
  
  Constant Field Values
- MAGIC_STRING
```
public static final String MAGIC_STRING
```
  See Also:
  
  Constant Field Values
- VERSION_NUMBER_V2
```
public static final String VERSION_NUMBER_V2
```
  See Also:
  
  Constant Field Values
- VERSION_NUMBER_V1
```
public static final String VERSION_NUMBER_V1
```
  See Also:
  
  Constant Field Values
- VERSION_NUMBER
```
public static final byte VERSION_NUMBER
```
  version number is changed to use 1 byte to represent since version 3
  
  See Also:
  
  Constant Field Values
- MIN_BLOOM_FILTER_ERROR_RATE
```
public static final double MIN_BLOOM_FILTER_ERROR_RATE
```
  Bloom filter constrain
  
  See Also:
  
  Constant Field Values
- MAX_BLOOM_FILTER_ERROR_RATE
```
public static final double MAX_BLOOM_FILTER_ERROR_RATE
```
  See Also:
  
  Constant Field Values
- ARRAY_CAPACITY_THRESHOLD
```
public static final int ARRAY_CAPACITY_THRESHOLD
```
  The primitive array capacity threshold.
  
  See Also:
  
  Constant Field Values

Constructor Detail
- TSFileConfig
```
public TSFileConfig()
```

Method Detail

getGroupSizeInByte
```
public int getGroupSizeInByte()
```

setGroupSizeInByte

public void setGroupSizeInByte(int groupSizeInByte)

getPageSizeInByte
```
public int getPageSizeInByte()
```

setPageSizeInByte

public void setPageSizeInByte(int pageSizeInByte)

getMaxNumberOfPointsInPage

public int getMaxNumberOfPointsInPage()

setMaxNumberOfPointsInPage

public void setMaxNumberOfPointsInPage(int maxNumberOfPointsInPage)

getMaxDegreeOfIndexNode
```
public int getMaxDegreeOfIndexNode()
```

setMaxDegreeOfIndexNode

public void setMaxDegreeOfIndexNode(int maxDegreeOfIndexNode)

getTimeSeriesDataType

public TSDataType getTimeSeriesDataType()

setTimeSeriesDataType

public void setTimeSeriesDataType(TSDataType timeSeriesDataType)

getMaxStringLength
```
public int getMaxStringLength()
```

setMaxStringLength

public void setMaxStringLength(int maxStringLength)

getFloatPrecision
```
public int getFloatPrecision()
```

setFloatPrecision

public void setFloatPrecision(int floatPrecision)

getTimeEncoder
```
public String getTimeEncoder()
```

setTimeEncoder

public void setTimeEncoder(String timeEncoder)

getValueEncoder
```
public String getValueEncoder()
```

setValueEncoder

public void setValueEncoder(String valueEncoder)

getRleBitWidth
```
public int getRleBitWidth()
```

setRleBitWidth

public void setRleBitWidth(int rleBitWidth)

getDeltaBlockSize
```
public int getDeltaBlockSize()
```

setDeltaBlockSize

public void setDeltaBlockSize(int deltaBlockSize)

getFreqType
```
public String getFreqType()
```

setFreqType

public void setFreqType(String freqType)

getPlaMaxError
```
public double getPlaMaxError()
```

setPlaMaxError

public void setPlaMaxError(double plaMaxError)

getSdtMaxError
```
public double getSdtMaxError()
```

setSdtMaxError

public void setSdtMaxError(double sdtMaxError)

getDftSatisfyRate
```
public double getDftSatisfyRate()
```

setDftSatisfyRate

public void setDftSatisfyRate(double dftSatisfyRate)

getCompressor

public CompressionType getCompressor()

setCompressor

public void setCompressor(String compressor)

getPageCheckSizeThreshold

public int getPageCheckSizeThreshold()

setPageCheckSizeThreshold

public void setPageCheckSizeThreshold(int pageCheckSizeThreshold)

getEndian
```
public String getEndian()
```

setEndian
```
public void setEndian(String endian)
```

isUseKerberos
```
public boolean isUseKerberos()
```

setUseKerberos

public void setUseKerberos(boolean useKerberos)

getKerberosKeytabFilePath

public String getKerberosKeytabFilePath()

setKerberosKeytabFilePath

public void setKerberosKeytabFilePath(String kerberosKeytabFilePath)

getKerberosPrincipal
```
public String getKerberosPrincipal()
```

setKerberosPrincipal

public void setKerberosPrincipal(String kerberosPrincipal)

getBloomFilterErrorRate

public double getBloomFilterErrorRate()

setBloomFilterErrorRate

public void setBloomFilterErrorRate(double bloomFilterErrorRate)

getTSFileStorageFs
```
public FSType getTSFileStorageFs()
```

setTSFileStorageFs

public void setTSFileStorageFs(FSType fileStorageFs)

getCoreSitePath
```
public String getCoreSitePath()
```

setCoreSitePath

public void setCoreSitePath(String coreSitePath)

getHdfsSitePath
```
public String getHdfsSitePath()
```

setHdfsSitePath

public void setHdfsSitePath(String hdfsSitePath)

getHdfsIp
```
public String[] getHdfsIp()
```

setHdfsIp

public void setHdfsIp(String[] hdfsIp)

getHdfsPort
```
public String getHdfsPort()
```

setHdfsPort

public void setHdfsPort(String hdfsPort)

getDfsNameServices
```
public String getDfsNameServices()
```

setDfsNameServices

public void setDfsNameServices(String dfsNameServices)

getDfsHaNamenodes
```
public String[] getDfsHaNamenodes()
```

setDfsHaNamenodes

public void setDfsHaNamenodes(String[] dfsHaNamenodes)

isDfsHaAutomaticFailoverEnabled

public boolean isDfsHaAutomaticFailoverEnabled()

setDfsHaAutomaticFailoverEnabled

public void setDfsHaAutomaticFailoverEnabled(boolean dfsHaAutomaticFailoverEnabled)

getDfsClientFailoverProxyProvider

public String getDfsClientFailoverProxyProvider()

setDfsClientFailoverProxyProvider

public void setDfsClientFailoverProxyProvider(String dfsClientFailoverProxyProvider)

getBatchSize
```
public int getBatchSize()
```

setBatchSize

public void setBatchSize(int batchSize)

getFreqEncodingSNR
```
public double getFreqEncodingSNR()
```

setFreqEncodingSNR

public void setFreqEncodingSNR(double freqEncodingSNR)

getFreqEncodingBlockSize
```
public int getFreqEncodingBlockSize()
```

setFreqEncodingBlockSize

public void setFreqEncodingBlockSize(int freqEncodingBlockSize)

Class TSFileConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RLE_MIN_REPEATED_NUM

RLE_MAX_REPEATED_NUM

RLE_MAX_BIT_PACKED_NUM

FLOAT_VALUE_LENGTH

DOUBLE_VALUE_LENGTH

VALUE_BITS_LENGTH_32BIT

LEADING_ZERO_BITS_LENGTH_32BIT

MEANINGFUL_XOR_BITS_LENGTH_32BIT

VALUE_BITS_LENGTH_64BIT

LEADING_ZERO_BITS_LENGTH_64BIT

MEANINGFUL_XOR_BITS_LENGTH_64BIT

GORILLA_ENCODING_ENDING_INTEGER

GORILLA_ENCODING_ENDING_LONG

GORILLA_ENCODING_ENDING_FLOAT

GORILLA_ENCODING_ENDING_DOUBLE

BYTE_SIZE_PER_CHAR

STRING_ENCODING

STRING_CHARSET

CONFIG_FILE_NAME

MAGIC_STRING

VERSION_NUMBER_V2

VERSION_NUMBER_V1

VERSION_NUMBER

MIN_BLOOM_FILTER_ERROR_RATE

MAX_BLOOM_FILTER_ERROR_RATE

ARRAY_CAPACITY_THRESHOLD

Constructor Detail

TSFileConfig

Method Detail

getGroupSizeInByte

setGroupSizeInByte

getPageSizeInByte

setPageSizeInByte

getMaxNumberOfPointsInPage

setMaxNumberOfPointsInPage

getMaxDegreeOfIndexNode

setMaxDegreeOfIndexNode

getTimeSeriesDataType

setTimeSeriesDataType

getMaxStringLength

setMaxStringLength

getFloatPrecision

setFloatPrecision

getTimeEncoder

setTimeEncoder

getValueEncoder

setValueEncoder

getRleBitWidth

setRleBitWidth

getDeltaBlockSize

setDeltaBlockSize

getFreqType

setFreqType

getPlaMaxError

setPlaMaxError

getSdtMaxError

setSdtMaxError

getDftSatisfyRate

setDftSatisfyRate

getCompressor

setCompressor

getPageCheckSizeThreshold

setPageCheckSizeThreshold

getEndian

setEndian

isUseKerberos

setUseKerberos

getKerberosKeytabFilePath

setKerberosKeytabFilePath

getKerberosPrincipal

setKerberosPrincipal

getBloomFilterErrorRate

setBloomFilterErrorRate

getTSFileStorageFs