TsFileResource (IoTDB Server 0.13.2 API)

java.lang.Object
- org.apache.iotdb.db.engine.storagegroup.TsFileResource

public class TsFileResource
extends Object

字段概要

字段
限定符和类型	字段和说明
`protected long`	`maxPlanIndex` Maximum index of plans executed within this TsFile.
`protected long`	`minPlanIndex` Minimum index of plans executed within this TsFile.
`protected TsFileResource`	`next`
`protected TsFileResource`	`prev` Used in `TsFileResourceList`
`static String`	`RESOURCE_SUFFIX`
`protected TsFileResourceStatus`	`status`
`protected ITimeIndex`	`timeIndex` time index
`static byte`	`VERSION_NUMBER` version number

构造器概要

构造器
构造器和说明
`TsFileResource()`
`TsFileResource(File file)` for sealed TsFile, call setClosed to close TsFileResource
`TsFileResource(File file, Map<String,Integer> deviceToIndex, long[] startTimes, long[] endTimes)`
`TsFileResource(File file, TsFileProcessor processor)` unsealed TsFile, for writter
`TsFileResource(Map<PartialPath,List<ReadOnlyMemChunk>> pathToReadOnlyMemChunkMap, Map<PartialPath,List<IChunkMetadata>> pathToChunkMetadataListMap, TsFileResource originTsFileResource)` unsealed TsFile, for query
`TsFileResource(PartialPath path, List<ReadOnlyMemChunk> readOnlyMemChunk, List<IChunkMetadata> chunkMetadataList, TsFileResource originTsFileResource)` unsealed TsFile, for query
`TsFileResource(TsFileResource other)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`long`	`calculateRamSize()`
`void`	`close()`
`static int`	`compareFileName(TsFileResource o1, TsFileResource o2)`
`int`	`compareIndexDegradePriority(TsFileResource tsFileResource)`
`TsFileResource`	`createHardlink()` Create a hardlink for the TsFile and modification file (if exists) The hardlink will have a suffix like ".
`long`	`degradeTimeIndex()` the DeviceTimeIndex degrade to FileTimeIndex and release memory
`void`	`delete()`
`void`	`deserialize()` deserialize from disk
`void`	`deserializeFromOldFile()` deserialize tsfile resource from old file
`boolean`	`equals(Object o)`
`List<IChunkMetadata>`	`getChunkMetadataList(PartialPath seriesPath)`
`ModificationFile`	`getCompactionModFile()`
`Set<String>`	`getDevices()`
`long`	`getEndTime(String deviceId)` open file's end time is Long.MIN_VALUE
`long`	`getFileEndTime()` open file's end time is Long.MIN_VALUE
`long`	`getFileStartTime()`
`static int`	`getInnerCompactionCount(String fileName)`
`long`	`getMaxPlanIndex()`
`long`	`getMinPlanIndex()`
`ModificationFile`	`getModFile()`
`long`	`getOrderTime(String deviceId, boolean ascending)`
`long`	`getRamSize()`
`List<ReadOnlyMemChunk>`	`getReadOnlyMemChunk(PartialPath seriesPath)`
`VirtualStorageGroupProcessor.SettleTsFileCallBack`	`getSettleTsFileCallBack()`
`long`	`getStartTime(String deviceId)`
`byte`	`getTimeIndexType()`
`long`	`getTimePartition()` make sure Either the deviceToIndex is not empty Or the path contains a partition folder
`long`	`getTimePartitionWithCheck()` Used when load new TsFiles not generated by the server Check and get the time partition
`ITimeSeriesMetadata`	`getTimeSeriesMetadata(PartialPath seriesPath)` Get a timeseriesMetadata by path.
`File`	`getTsFile()`
`String`	`getTsFilePath()`
`long`	`getTsFileSize()`
`List<TsFileResource>`	`getUpgradedResources()`
`VirtualStorageGroupProcessor.UpgradeTsFileResourceCallBack`	`getUpgradeTsFileResourceCallBack()`
`long`	`getVersion()`
`int`	`hashCode()`
`boolean`	`isClosed()`
`boolean`	`isCompacting()`
`boolean`	`isCompactionCandidate()`
`boolean`	`isDeleted()`
`boolean`	`isDeviceIdExist(String deviceId)`
`boolean`	`isFileInList()`
`boolean`	`isPlanIndexOverlap(TsFileResource another)`
`boolean`	`isPlanRangeCovers(TsFileResource another)`
`boolean`	`isSatisfied(String deviceId, Filter timeFilter, boolean isSeq, long ttl, boolean debug)`
`boolean`	`isSatisfied(String deviceId, Filter timeFilter, TsFileFilter fileFilter, boolean isSeq, boolean debug)`
`boolean`	`isSeq()`
`boolean`	`isSpanMultiTimePartitions()` Check whether the tsFile spans multiple time partitions.
`boolean`	`mayContainsDevice(String device)` Whether this TsFileResource contains this device, if false, it must not contain this device, if true, it may or may not contain this device
`void`	`readLock()` If originTsFileResource is not null, we should acquire the read lock of originTsFileResource before construct the current TsFileResource
`void`	`readUnlock()`
`boolean`	`remove()` Remove the data file, its resource file, and its modification file physically.
`void`	`removeModFile()`
`boolean`	`removeResourceFile()`
`void`	`resetModFile()`
`boolean`	`resourceFileExists()`
`void`	`serialize()`
`void`	`setFile(File file)`
`void`	`setMaxPlanIndex(long maxPlanIndex)`
`void`	`setMinPlanIndex(long minPlanIndex)`
`void`	`setModFile(ModificationFile modFile)`
`void`	`setProcessor(TsFileProcessor processor)`
`void`	`setSeq(boolean seq)`
`void`	`setSettleTsFileCallBack(VirtualStorageGroupProcessor.SettleTsFileCallBack settleTsFileCallBack)`
`void`	`setStatus(TsFileResourceStatus status)`
`void`	`setTimeIndex(ITimeIndex timeIndex)`
`void`	`setTimeIndexType(byte type)`
`void`	`setTimeSeriesMetadata(PartialPath path, ITimeSeriesMetadata timeSeriesMetadata)`
`void`	`setUpgradedResources(List<TsFileResource> upgradedResources)`
`void`	`setUpgradeTsFileResourceCallBack(VirtualStorageGroupProcessor.UpgradeTsFileResourceCallBack upgradeTsFileResourceCallBack)`
`void`	`setVersion(long version)`
`boolean`	`stillLives(long timeLowerBound)` check if any of the device lives over the given time bound.
`String`	`toString()`
`boolean`	`tryReadLock()`
`boolean`	`tryWriteLock()`
`void`	`updateEndTime(String device, long time)`
`void`	`updatePlanIndexes(long planIndex)`
`void`	`updatePlanIndexes(TsFileResource another)` For merge, the index range of the new file should be the union of all files' in this merge.
`void`	`updateStartTime(String device, long time)`
`void`	`writeLock()`
`void`	`writeUnlock()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料
- RESOURCE_SUFFIX
```
public static final String RESOURCE_SUFFIX
```
  另请参阅:
  
  常量字段值
- VERSION_NUMBER
```
public static final byte VERSION_NUMBER
```
  version number
  
  另请参阅:
  
  常量字段值
- prev
```
protected TsFileResource prev
```
  Used in TsFileResourceList
- next
```
protected TsFileResource next
```
- timeIndex
```
protected ITimeIndex timeIndex
```
  time index
- status
```
protected volatile TsFileResourceStatus status
```
- maxPlanIndex
```
protected long maxPlanIndex
```
  Maximum index of plans executed within this TsFile.
- minPlanIndex
```
protected long minPlanIndex
```
  Minimum index of plans executed within this TsFile.

构造器详细资料

TsFileResource
```
public TsFileResource()
```

TsFileResource

public TsFileResource(TsFileResource other)
               throws IOException

抛出:: IOException

TsFileResource
```
public TsFileResource(File file)
```
for sealed TsFile, call setClosed to close TsFileResource

TsFileResource

public TsFileResource(File file,
                      TsFileProcessor processor)

unsealed TsFile, for writter

TsFileResource

public TsFileResource(PartialPath path,
                      List<ReadOnlyMemChunk> readOnlyMemChunk,
                      List<IChunkMetadata> chunkMetadataList,
                      TsFileResource originTsFileResource)
               throws IOException

unsealed TsFile, for query

抛出:: IOException

TsFileResource

public TsFileResource(Map<PartialPath,List<ReadOnlyMemChunk>> pathToReadOnlyMemChunkMap,
                      Map<PartialPath,List<IChunkMetadata>> pathToChunkMetadataListMap,
                      TsFileResource originTsFileResource)
               throws IOException

unsealed TsFile, for query

抛出:: IOException

TsFileResource

public TsFileResource(File file,
                      Map<String,Integer> deviceToIndex,
                      long[] startTimes,
                      long[] endTimes)

方法详细资料

serialize

public void serialize()
               throws IOException

抛出:: IOException

deserialize

public void deserialize()
                 throws IOException

deserialize from disk

抛出:: IOException

deserializeFromOldFile

public void deserializeFromOldFile()
                            throws IOException

deserialize tsfile resource from old file

抛出:: IOException

updateStartTime

public void updateStartTime(String device,
                            long time)

updateEndTime

public void updateEndTime(String device,
                          long time)

resourceFileExists
```
public boolean resourceFileExists()
```

getChunkMetadataList

public List<IChunkMetadata> getChunkMetadataList(PartialPath seriesPath)

getReadOnlyMemChunk

public List<ReadOnlyMemChunk> getReadOnlyMemChunk(PartialPath seriesPath)

getModFile
```
public ModificationFile getModFile()
```

getCompactionModFile

public ModificationFile getCompactionModFile()

resetModFile
```
public void resetModFile()
```

setFile
```
public void setFile(File file)
```

getTsFile
```
public File getTsFile()
```

getTsFilePath
```
public String getTsFilePath()
```

getTsFileSize
```
public long getTsFileSize()
```

getStartTime

public long getStartTime(String deviceId)

getEndTime
```
public long getEndTime(String deviceId)
```
open file's end time is Long.MIN_VALUE

getOrderTime

public long getOrderTime(String deviceId,
                         boolean ascending)

getFileStartTime
```
public long getFileStartTime()
```

getFileEndTime
```
public long getFileEndTime()
```
open file's end time is Long.MIN_VALUE

getDevices
```
public Set<String> getDevices()
```

mayContainsDevice
```
public boolean mayContainsDevice(String device)
```
Whether this TsFileResource contains this device, if false, it must not contain this device, if true, it may or may not contain this device

isClosed
```
public boolean isClosed()
```

close

public void close()
           throws IOException

抛出:: IOException

writeLock
```
public void writeLock()
```

writeUnlock
```
public void writeUnlock()
```

readLock
```
public void readLock()
```
If originTsFileResource is not null, we should acquire the read lock of originTsFileResource before construct the current TsFileResource

readUnlock
```
public void readUnlock()
```

tryWriteLock
```
public boolean tryWriteLock()
```

tryReadLock
```
public boolean tryReadLock()
```

removeModFile

public void removeModFile()
                   throws IOException

抛出:: IOException

remove
```
public boolean remove()
```
Remove the data file, its resource file, and its modification file physically.

removeResourceFile
```
public boolean removeResourceFile()
```

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

equals
```
public boolean equals(Object o)
```
覆盖:

equals 在类中 Object

hashCode
```
public int hashCode()
```
覆盖:

hashCode 在类中 Object

isDeleted
```
public boolean isDeleted()
```

isCompacting
```
public boolean isCompacting()
```

isCompactionCandidate

public boolean isCompactionCandidate()

setStatus

public void setStatus(TsFileResourceStatus status)

stillLives
```
public boolean stillLives(long timeLowerBound)
```
check if any of the device lives over the given time bound. If the file is not closed, then return true.

isDeviceIdExist

public boolean isDeviceIdExist(String deviceId)

isSatisfied

public boolean isSatisfied(String deviceId,
                           Filter timeFilter,
                           boolean isSeq,
                           long ttl,
                           boolean debug)

返回:: true if the device is contained in the TsFile and it lives beyond TTL

isSatisfied

public boolean isSatisfied(String deviceId,
                           Filter timeFilter,
                           TsFileFilter fileFilter,
                           boolean isSeq,
                           boolean debug)

返回:: true if the device is contained in the TsFile

setProcessor

public void setProcessor(TsFileProcessor processor)

getTimeSeriesMetadata
```
public ITimeSeriesMetadata getTimeSeriesMetadata(PartialPath seriesPath)
```
Get a timeseriesMetadata by path.

返回:

TimeseriesMetadata or the first ValueTimeseriesMetadata in VectorTimeseriesMetadata

setTimeSeriesMetadata

public void setTimeSeriesMetadata(PartialPath path,
                                  ITimeSeriesMetadata timeSeriesMetadata)

setUpgradedResources

public void setUpgradedResources(List<TsFileResource> upgradedResources)

getUpgradedResources

public List<TsFileResource> getUpgradedResources()

setUpgradeTsFileResourceCallBack

public void setUpgradeTsFileResourceCallBack(VirtualStorageGroupProcessor.UpgradeTsFileResourceCallBack upgradeTsFileResourceCallBack)

getUpgradeTsFileResourceCallBack

public VirtualStorageGroupProcessor.UpgradeTsFileResourceCallBack getUpgradeTsFileResourceCallBack()

getSettleTsFileCallBack

public VirtualStorageGroupProcessor.SettleTsFileCallBack getSettleTsFileCallBack()

setSettleTsFileCallBack

public void setSettleTsFileCallBack(VirtualStorageGroupProcessor.SettleTsFileCallBack settleTsFileCallBack)

getTimePartition
```
public long getTimePartition()
```
make sure Either the deviceToIndex is not empty Or the path contains a partition folder

getTimePartitionWithCheck
```
public long getTimePartitionWithCheck()
                               throws PartitionViolationException
```
Used when load new TsFiles not generated by the server Check and get the time partition

抛出:

PartitionViolationException - if the data of the file spans partitions or it is empty

isSpanMultiTimePartitions
```
public boolean isSpanMultiTimePartitions()
```
Check whether the tsFile spans multiple time partitions.

createHardlink
```
public TsFileResource createHardlink()
```
Create a hardlink for the TsFile and modification file (if exists) The hardlink will have a suffix like ".{sysTime}_{randomLong}"

返回:

a new TsFileResource with its file changed to the hardlink or null the hardlink cannot be created.

setModFile

public void setModFile(ModificationFile modFile)

calculateRamSize
```
public long calculateRamSize()
```
返回:

resource map size

delete

public void delete()
            throws IOException

抛出:: IOException

getMaxPlanIndex
```
public long getMaxPlanIndex()
```

getMinPlanIndex
```
public long getMinPlanIndex()
```

updatePlanIndexes

public void updatePlanIndexes(long planIndex)

getInnerCompactionCount

public static int getInnerCompactionCount(String fileName)
                                   throws IOException

抛出:: IOException

updatePlanIndexes
```
public void updatePlanIndexes(TsFileResource another)
```
For merge, the index range of the new file should be the union of all files' in this merge.

isPlanIndexOverlap

public boolean isPlanIndexOverlap(TsFileResource another)

isPlanRangeCovers

public boolean isPlanRangeCovers(TsFileResource another)

setMaxPlanIndex

public void setMaxPlanIndex(long maxPlanIndex)

setMinPlanIndex

public void setMinPlanIndex(long minPlanIndex)

setVersion
```
public void setVersion(long version)
```

getVersion
```
public long getVersion()
```

setTimeIndex

public void setTimeIndex(ITimeIndex timeIndex)

compareFileName

public static int compareFileName(TsFileResource o1,
                                  TsFileResource o2)

setSeq
```
public void setSeq(boolean seq)
```

isSeq
```
public boolean isSeq()
```

compareIndexDegradePriority

public int compareIndexDegradePriority(TsFileResource tsFileResource)

getTimeIndexType
```
public byte getTimeIndexType()
```

setTimeIndexType

public void setTimeIndexType(byte type)

getRamSize
```
public long getRamSize()
```

degradeTimeIndex
```
public long degradeTimeIndex()
```
the DeviceTimeIndex degrade to FileTimeIndex and release memory

isFileInList
```
public boolean isFileInList()
```
返回:

is this tsfile resource in a TsFileResourceList

类 TsFileResource

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

RESOURCE_SUFFIX

VERSION_NUMBER

prev

next

timeIndex

status

maxPlanIndex

minPlanIndex

构造器详细资料

TsFileResource

TsFileResource

TsFileResource

TsFileResource

TsFileResource

TsFileResource

TsFileResource

方法详细资料

serialize

deserialize

deserializeFromOldFile

updateStartTime

updateEndTime

resourceFileExists

getChunkMetadataList

getReadOnlyMemChunk

getModFile

getCompactionModFile

resetModFile

setFile

getTsFile

getTsFilePath

getTsFileSize

getStartTime

getEndTime

getOrderTime

getFileStartTime

getFileEndTime

getDevices

mayContainsDevice

isClosed

close

writeLock

writeUnlock

readLock

readUnlock

tryWriteLock

tryReadLock

removeModFile

remove

removeResourceFile

toString

equals

hashCode

isDeleted

isCompacting

isCompactionCandidate

setStatus

stillLives

isDeviceIdExist

isSatisfied

isSatisfied

setProcessor

getTimeSeriesMetadata

setTimeSeriesMetadata

setUpgradedResources

getUpgradedResources

setUpgradeTsFileResourceCallBack

getUpgradeTsFileResourceCallBack

getSettleTsFileCallBack

setSettleTsFileCallBack

getTimePartition

getTimePartitionWithCheck

isSpanMultiTimePartitions

createHardlink