Package org.apache.cassandra.db.compaction

Class CompactionInfo

java.lang.Object

org.apache.cassandra.db.compaction.CompactionInfo

public final class CompactionInfo
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompactionInfo.Holder
static enum	CompactionInfo.Unit

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLUMNFAMILY
static final String	COMPACTION_ID
static final String	COMPLETED
static final String	ID
static final String	KEYSPACE
static final String	SSTABLES
static final String	TARGET_DIRECTORY
static final String	TASK_TYPE
static final String	TOTAL
static final String	UNIT

Constructor Summary

Constructors

Constructor	Description
CompactionInfo(TableMetadata metadata, OperationType tasktype, long completed, long total, CompactionInfo.Unit unit, TimeUUID compactionId, Collection<? extends SSTableReader> sstables, String targetDirectory)
CompactionInfo(TableMetadata metadata, OperationType tasktype, long completed, long total, TimeUUID compactionId, Collection<? extends SSTableReader> sstables)
CompactionInfo(TableMetadata metadata, OperationType tasktype, long completed, long total, TimeUUID compactionId, Collection<SSTableReader> sstables, String targetDirectory)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	asMap()
long	estimatedRemainingWriteBytes()	Note that this estimate is based on the amount of data we have left to read - it assumes input size == output size for a compaction, which is not really true, but should most often provide a worst case remaining write size.
CompactionInfo	forProgress(long complete, long total)
long	getCompleted()
Optional<String>	getKeyspace()
Set<SSTableReader>	getSSTables()
Optional<String>	getTable()
TableMetadata	getTableMetadata()
List<File>	getTargetDirectories()	Get the directories this compaction could possibly write to.
TimeUUID	getTaskId()
OperationType	getTaskType()
long	getTotal()
CompactionInfo.Unit	getUnit()
String	targetDirectory()
String	toString()
static CompactionInfo	withoutSSTables(TableMetadata metadata, OperationType tasktype, long completed, long total, CompactionInfo.Unit unit, TimeUUID compactionId)	Special compaction info where we always need to cancel the compaction - for example ViewBuilderTask where we don't know the sstables at construction
static CompactionInfo	withoutSSTables(TableMetadata metadata, OperationType tasktype, long completed, long total, CompactionInfo.Unit unit, TimeUUID compactionId, String targetDirectory)	Special compaction info where we always need to cancel the compaction - for example AutoSavingCache where we don't know the sstables at construction

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

KEYSPACE

public static final String KEYSPACE

See Also:

• Constant Field Values

COLUMNFAMILY

public static final String COLUMNFAMILY

See Also:

• Constant Field Values

COMPLETED

public static final String COMPLETED

See Also:

• Constant Field Values

TOTAL

public static final String TOTAL

See Also:

• Constant Field Values

TASK_TYPE

public static final String TASK_TYPE

See Also:

• Constant Field Values

UNIT

public static final String UNIT

See Also:

• Constant Field Values

COMPACTION_ID

public static final String COMPACTION_ID

See Also:

• Constant Field Values

SSTABLES

public static final String SSTABLES

See Also:

• Constant Field Values

TARGET_DIRECTORY

public static final String TARGET_DIRECTORY

See Also:

• Constant Field Values

Constructor Details

CompactionInfo

public CompactionInfo(TableMetadata metadata,
 OperationType tasktype,
 long completed,
 long total,
 CompactionInfo.Unit unit,
 TimeUUID compactionId,
 Collection<? extends SSTableReader> sstables,
 String targetDirectory)

CompactionInfo

public CompactionInfo(TableMetadata metadata,
 OperationType tasktype,
 long completed,
 long total,
 TimeUUID compactionId,
 Collection<SSTableReader> sstables,
 String targetDirectory)

CompactionInfo

public CompactionInfo(TableMetadata metadata,
 OperationType tasktype,
 long completed,
 long total,
 TimeUUID compactionId,
 Collection<? extends SSTableReader> sstables)

Method Details

withoutSSTables

public static CompactionInfo withoutSSTables(TableMetadata metadata,
 OperationType tasktype,
 long completed,
 long total,
 CompactionInfo.Unit unit,
 TimeUUID compactionId)

Special compaction info where we always need to cancel the compaction - for example ViewBuilderTask where we don't know the sstables at construction

withoutSSTables

public static CompactionInfo withoutSSTables(TableMetadata metadata,
 OperationType tasktype,
 long completed,
 long total,
 CompactionInfo.Unit unit,
 TimeUUID compactionId,
 String targetDirectory)

Special compaction info where we always need to cancel the compaction - for example AutoSavingCache where we don't know the sstables at construction

forProgress

public CompactionInfo forProgress(long complete,
 long total)

Returns:

A copy of this CompactionInfo with updated progress.

getKeyspace

public Optional<String> getKeyspace()

getTable

public Optional<String> getTable()

getTableMetadata

public TableMetadata getTableMetadata()

getCompleted

public long getCompleted()

getTotal

public long getTotal()

getTaskType

public OperationType getTaskType()

getTaskId

public TimeUUID getTaskId()

getUnit

public CompactionInfo.Unit getUnit()

getSSTables

public Set<SSTableReader> getSSTables()

getTargetDirectories

public List<File> getTargetDirectories()

Get the directories this compaction could possibly write to.

Returns:

the directories that we might write to, or empty list if we don't know the metadata (like for index summary redistribution), or null if we don't have any disk boundaries

targetDirectory

public String targetDirectory()

estimatedRemainingWriteBytes

public long estimatedRemainingWriteBytes()

Note that this estimate is based on the amount of data we have left to read - it assumes input size == output size for a compaction, which is not really true, but should most often provide a worst case remaining write size.

toString

public String toString()

Overrides:

toString in class Object

asMap

public Map<String,String> asMap()