org.apache.cassandra.db
Class ColumnFamilyStore

java.lang.Object
  org.apache.cassandra.db.ColumnFamilyStore

All Implemented Interfaces:

ColumnFamilyStoreMBean

public class ColumnFamilyStore
extends java.lang.Object
implements ColumnFamilyStoreMBean

Field Summary

java.lang.String	columnFamily
CFMetaData	metadata
IPartitioner	partitioner
static java.util.concurrent.ExecutorService	postFlushExecutor
Table	table

Method Summary

void	addIndex(ColumnDefinition info)
void	addSSTable(SSTableReader sstable)
static java.lang.Iterable<ColumnFamilyStore>	all()
java.lang.Iterable<DecoratedKey>	allKeySamples()
void	buildSecondaryIndexes(java.util.Collection<SSTableReader> sstables, java.util.SortedSet<java.nio.ByteBuffer> columns)
static ColumnFamilyStore	createColumnFamilyStore(Table table, java.lang.String columnFamily)
static ColumnFamilyStore	createColumnFamilyStore(Table table, java.lang.String columnFamily, IPartitioner partitioner, CFMetaData metadata)
void	disableAutoCompaction() Disable automatic compaction.
long	estimateKeys()
void	forceBlockingFlush()
void	forceCleanup()
java.util.concurrent.Future<?>	forceFlush() Triggers an immediate memtable flush.
void	forceFlushBinary()
void	forceFlushIfExpired()
void	forceMajorCompaction() force a major compaction of this column family
int	gcBefore()
long	getBloomFilterFalsePositives()
double	getBloomFilterFalseRatio()
java.util.List<java.lang.String>	getBuiltIndexes() Returns a list of the names of the built column indexes for current store
ColumnFamily	getColumnFamily(DecoratedKey key, QueryPath path, java.nio.ByteBuffer start, java.nio.ByteBuffer finish, boolean reversed, int limit)
ColumnFamily	getColumnFamily(QueryFilter filter) get a list of columns starting from a given column, in a specified order.
java.lang.String	getColumnFamilyName()
AbstractType	getComparator()
long[]	getEstimatedColumnCountHistogram()
long[]	getEstimatedRowSizeHistogram()
java.lang.String	getFlushPath()
ColumnFamilyStore	getIndexedColumnFamilyStore(java.nio.ByteBuffer column)
java.util.SortedSet<java.nio.ByteBuffer>	getIndexedColumns()
DecoratedKey<LocalToken>	getIndexKeyFor(java.nio.ByteBuffer name, java.nio.ByteBuffer value)
int	getKeyCacheCapacity()
int	getKeyCacheSize()
long[]	getLifetimeReadLatencyHistogramMicros()
long[]	getLifetimeWriteLatencyHistogramMicros()
long	getLiveDiskSpaceUsed()
int	getLiveSSTableCount()
int	getMaximumCompactionThreshold() Gets the maximum number of sstables in queue before compaction kicks off
long	getMaxRowSize() return the size of the largest compacted row
int	getMeanColumns()
long	getMeanRowSize() return the mean size of the rows compacted
int	getMemtableColumnsCount() Returns the total number of columns present in the memtable.
int	getMemtableDataSize() Returns the total amount of data stored in the memtable, including column related overhead.
int	getMemtableFlushAfterMins()
double	getMemtableOperationsInMillions()
java.util.Set<Memtable>	getMemtablesPendingFlush()
int	getMemtableSwitchCount() Returns the number of times that a flush has resulted in the memtable being switched out.
int	getMemtableThroughputInMB()
int	getMinimumCompactionThreshold() Gets the minimum number of sstables in queue before compaction kicks off
long	getMinRowSize() return the size of the smallest compacted row
int	getPendingTasks()
java.util.List<Row>	getRangeSlice(java.nio.ByteBuffer superColumn, AbstractBounds range, int maxResults, IFilter columnFilter) Fetch a range of rows and columns from memtables/sstables.
ColumnFamily	getRawCachedRow(DecoratedKey key) raw cached row -- does not fetch the row if it is not present.
long	getReadCount()
long	getRecentBloomFilterFalsePositives()
double	getRecentBloomFilterFalseRatio()
long[]	getRecentReadLatencyHistogramMicros()
double	getRecentReadLatencyMicros()
long[]	getRecentSSTablesPerReadHistogram()
long[]	getRecentWriteLatencyHistogramMicros()
double	getRecentWriteLatencyMicros()
int	getRowCacheCapacity()
int	getRowCacheSize()
java.util.Collection<SSTableReader>	getSSTables()
long[]	getSSTablesPerReadHistogram()
java.lang.String	getTempSSTablePath(java.lang.String directory)
long	getTotalDiskSpaceUsed()
long	getTotalReadLatencyMicros()
long	getTotalWriteLatencyMicros()
long	getWriteCount()
boolean	hasUnreclaimedSpace()
void	initRowCache()
void	invalidateKeyCache() invalidate the key cache; for use after invalidating row cache
void	invalidateRowCache() invalidate the row cache; for use after bulk loading via BinaryMemtable
boolean	isIndex() true if this CFS contains secondary index data
boolean	isIndexBuilt() Check if index is already built for current store
boolean	isInvalid()
boolean	isKeyInRemainingSSTables(DecoratedKey key, java.util.Set<SSTable> sstablesToIgnore) Uses bloom filters to check if key may be present in any sstable in this ColumnFamilyStore, minus a set of provided ones.
ColumnFamily	newIndexedColumnFamily(java.nio.ByteBuffer column)
protected java.util.Set<DecoratedKey>	readSavedCache(java.io.File path)
void	reduceCacheSizes() sets each cache's maximum capacity to 75% of its current size
void	reload()
void	removeAllSSTables()
static ColumnFamily	removeDeleted(ColumnFamily cf, int gcBefore)
static ColumnFamily	removeDeletedCF(ColumnFamily cf, int gcBefore)
void	renameSSTables(java.lang.String newCfName)
java.util.List<Row>	scan(IndexClause clause, AbstractBounds range, IFilter dataFilter)
static void	scrubDataDirectories(java.lang.String table, java.lang.String columnFamily) Removes unnecessary files from the cf directory at startup: these include temp files, orphans, zero-length files and compacted sstables.
void	setMaximumCompactionThreshold(int maxCompactionThreshold) Sets the maximum number of sstables in queue before compaction kicks off
void	setMemtableFlushAfterMins(int time)
void	setMemtableOperationsInMillions(double ops)
void	setMemtableThroughputInMB(int size)
void	setMinimumCompactionThreshold(int minCompactionThreshold) Sets the minimum number of sstables in queue before compaction kicks off
void	snapshot(java.lang.String snapshotName) Take a snap shot of this columnfamily store.
java.util.concurrent.Future<?>	submitKeyCacheWrite()
java.util.concurrent.Future<?>	submitRowCacheWrite()
java.lang.String	toString()
java.util.concurrent.Future<?>	truncate() Truncate practically deletes the entire column family's data

Methods inherited from class java.lang.Object

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

Field Detail

postFlushExecutor

public static final java.util.concurrent.ExecutorService postFlushExecutor

table

public final Table table

columnFamily

public final java.lang.String columnFamily

partitioner

public final IPartitioner partitioner

metadata

public final CFMetaData metadata

Method Detail

reload

public void reload()

readSavedCache

protected java.util.Set<DecoratedKey> readSavedCache(java.io.File path)

addIndex

public void addIndex(ColumnDefinition info)

buildSecondaryIndexes

public void buildSecondaryIndexes(java.util.Collection<SSTableReader> sstables,
                                  java.util.SortedSet<java.nio.ByteBuffer> columns)

getMinRowSize

public long getMinRowSize()

Description copied from interface: ColumnFamilyStoreMBean

return the size of the smallest compacted row

Specified by:

getMinRowSize in interface ColumnFamilyStoreMBean

Returns:

getMaxRowSize

public long getMaxRowSize()

Description copied from interface: ColumnFamilyStoreMBean

return the size of the largest compacted row

Specified by:

getMaxRowSize in interface ColumnFamilyStoreMBean

Returns:

getMeanRowSize

public long getMeanRowSize()

Description copied from interface: ColumnFamilyStoreMBean

return the mean size of the rows compacted

Specified by:

getMeanRowSize in interface ColumnFamilyStoreMBean

Returns:

getMeanColumns

public int getMeanColumns()

createColumnFamilyStore

public static ColumnFamilyStore createColumnFamilyStore(Table table,
                                                        java.lang.String columnFamily)

createColumnFamilyStore

public static ColumnFamilyStore createColumnFamilyStore(Table table,
                                                        java.lang.String columnFamily,
                                                        IPartitioner partitioner,
                                                        CFMetaData metadata)

scrubDataDirectories

public static void scrubDataDirectories(java.lang.String table,
                                        java.lang.String columnFamily)

Removes unnecessary files from the cf directory at startup: these include temp files, orphans, zero-length files and compacted sstables. Files that cannot be recognized will be ignored.

initRowCache

public void initRowCache()

submitRowCacheWrite

public java.util.concurrent.Future<?> submitRowCacheWrite()

submitKeyCacheWrite

public java.util.concurrent.Future<?> submitKeyCacheWrite()

getColumnFamilyName

public java.lang.String getColumnFamilyName()

Specified by:

getColumnFamilyName in interface ColumnFamilyStoreMBean

Returns:

the name of the column family

getFlushPath

public java.lang.String getFlushPath()

getTempSSTablePath

public java.lang.String getTempSSTablePath(java.lang.String directory)

forceFlushIfExpired

public void forceFlushIfExpired()

forceFlush

public java.util.concurrent.Future<?> forceFlush()

Description copied from interface: ColumnFamilyStoreMBean

Triggers an immediate memtable flush.

Specified by:

forceFlush in interface ColumnFamilyStoreMBean

forceBlockingFlush

public void forceBlockingFlush()
                        throws java.util.concurrent.ExecutionException,
                               java.lang.InterruptedException

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

forceFlushBinary

public void forceFlushBinary()

removeDeletedCF

public static ColumnFamily removeDeletedCF(ColumnFamily cf,
                                           int gcBefore)

removeDeleted

public static ColumnFamily removeDeleted(ColumnFamily cf,
                                         int gcBefore)

isKeyInRemainingSSTables

public boolean isKeyInRemainingSSTables(DecoratedKey key,
                                        java.util.Set<SSTable> sstablesToIgnore)

Uses bloom filters to check if key may be present in any sstable in this ColumnFamilyStore, minus a set of provided ones. Because BFs are checked, negative returns ensure that the key is not present in the checked SSTables, but positive ones doesn't ensure key presence.

addSSTable

public void addSSTable(SSTableReader sstable)

forceCleanup

public void forceCleanup()
                  throws java.util.concurrent.ExecutionException,
                         java.lang.InterruptedException

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

isInvalid

public boolean isInvalid()

removeAllSSTables

public void removeAllSSTables()

getMemtableColumnsCount

public int getMemtableColumnsCount()

Description copied from interface: ColumnFamilyStoreMBean

Returns the total number of columns present in the memtable.

Specified by:

getMemtableColumnsCount in interface ColumnFamilyStoreMBean

Returns:

The number of columns.

getMemtableDataSize

public int getMemtableDataSize()

Description copied from interface: ColumnFamilyStoreMBean

Returns the total amount of data stored in the memtable, including column related overhead.

Specified by:

getMemtableDataSize in interface ColumnFamilyStoreMBean

Returns:

The size in bytes.

getMemtableSwitchCount

public int getMemtableSwitchCount()

Description copied from interface: ColumnFamilyStoreMBean

Returns the number of times that a flush has resulted in the memtable being switched out.

Specified by:

getMemtableSwitchCount in interface ColumnFamilyStoreMBean

Returns:

the number of memtable switches

getSSTables

public java.util.Collection<SSTableReader> getSSTables()

getRecentSSTablesPerReadHistogram

public long[] getRecentSSTablesPerReadHistogram()

Specified by:

getRecentSSTablesPerReadHistogram in interface ColumnFamilyStoreMBean

Returns:

a histogram of the number of sstable data files accessed per read: reading this property resets it

getSSTablesPerReadHistogram

public long[] getSSTablesPerReadHistogram()

Specified by:

getSSTablesPerReadHistogram in interface ColumnFamilyStoreMBean

Returns:

a histogram of the number of sstable data files accessed per read

getReadCount

public long getReadCount()

Specified by:

getReadCount in interface ColumnFamilyStoreMBean

Returns:

the number of read operations on this column family

getRecentReadLatencyMicros

public double getRecentReadLatencyMicros()

Specified by:

getRecentReadLatencyMicros in interface ColumnFamilyStoreMBean

Returns:

average latency per read operation since the last call

getLifetimeReadLatencyHistogramMicros

public long[] getLifetimeReadLatencyHistogramMicros()

Specified by:

getLifetimeReadLatencyHistogramMicros in interface ColumnFamilyStoreMBean

Returns:

an array representing the latency histogram

getRecentReadLatencyHistogramMicros

public long[] getRecentReadLatencyHistogramMicros()

Specified by:

getRecentReadLatencyHistogramMicros in interface ColumnFamilyStoreMBean

Returns:

an array representing the latency histogram

getTotalReadLatencyMicros

public long getTotalReadLatencyMicros()

Specified by:

getTotalReadLatencyMicros in interface ColumnFamilyStoreMBean

Returns:

total read latency (divide by getReadCount() for average)

getPendingTasks

public int getPendingTasks()

Specified by:

getPendingTasks in interface ColumnFamilyStoreMBean

Returns:

the estimated number of tasks pending for this column family

getWriteCount

public long getWriteCount()

Specified by:

getWriteCount in interface ColumnFamilyStoreMBean

Returns:

the number of write operations on this column family

getTotalWriteLatencyMicros

public long getTotalWriteLatencyMicros()

Specified by:

getTotalWriteLatencyMicros in interface ColumnFamilyStoreMBean

Returns:

total write latency (divide by getReadCount() for average)

getRecentWriteLatencyMicros

public double getRecentWriteLatencyMicros()

Specified by:

getRecentWriteLatencyMicros in interface ColumnFamilyStoreMBean

Returns:

average latency per write operation since the last call

getLifetimeWriteLatencyHistogramMicros

public long[] getLifetimeWriteLatencyHistogramMicros()

Specified by:

getLifetimeWriteLatencyHistogramMicros in interface ColumnFamilyStoreMBean

Returns:

an array representing the latency histogram

getRecentWriteLatencyHistogramMicros

public long[] getRecentWriteLatencyHistogramMicros()

Specified by:

getRecentWriteLatencyHistogramMicros in interface ColumnFamilyStoreMBean

Returns:

an array representing the latency histogram

getColumnFamily

public ColumnFamily getColumnFamily(DecoratedKey key,
                                    QueryPath path,
                                    java.nio.ByteBuffer start,
                                    java.nio.ByteBuffer finish,
                                    boolean reversed,
                                    int limit)

getColumnFamily

public ColumnFamily getColumnFamily(QueryFilter filter)

get a list of columns starting from a given column, in a specified order. only the latest version of a column is returned.

Returns:

null if there is no data and no tombstones; otherwise a ColumnFamily

gcBefore

public int gcBefore()

getRangeSlice

public java.util.List<Row> getRangeSlice(java.nio.ByteBuffer superColumn,
                                         AbstractBounds range,
                                         int maxResults,
                                         IFilter columnFilter)
                                  throws java.util.concurrent.ExecutionException,
                                         java.lang.InterruptedException

Fetch a range of rows and columns from memtables/sstables.

Parameters:

superColumn - optional SuperColumn to slice subcolumns of; null to slice top-level columns

range - Either a Bounds, which includes start key, or a Range, which does not.

maxResults - Maximum rows to return

columnFilter - description of the columns we're interested in for each row

Returns:

true if we found all keys we were looking for, otherwise false

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

scan

public java.util.List<Row> scan(IndexClause clause,
                                AbstractBounds range,
                                IFilter dataFilter)

getComparator

public AbstractType getComparator()

snapshot

public void snapshot(java.lang.String snapshotName)

Take a snap shot of this columnfamily store.

Parameters:

snapshotName - the name of the associated with the snapshot

hasUnreclaimedSpace

public boolean hasUnreclaimedSpace()

getTotalDiskSpaceUsed

public long getTotalDiskSpaceUsed()

Specified by:

getTotalDiskSpaceUsed in interface ColumnFamilyStoreMBean

Returns:

total disk space used by SSTables belonging to this CF, including obsolete ones waiting to be GC'd

getLiveDiskSpaceUsed

public long getLiveDiskSpaceUsed()

Specified by:

getLiveDiskSpaceUsed in interface ColumnFamilyStoreMBean

Returns:

disk space used by SSTables belonging to this CF

getLiveSSTableCount

public int getLiveSSTableCount()

Specified by:

getLiveSSTableCount in interface ColumnFamilyStoreMBean

Returns:

the number of SSTables on disk for this CF

getRawCachedRow

public ColumnFamily getRawCachedRow(DecoratedKey key)

raw cached row -- does not fetch the row if it is not present. not counted in cache statistics.

forceMajorCompaction

public void forceMajorCompaction()
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.ExecutionException

Description copied from interface: ColumnFamilyStoreMBean

force a major compaction of this column family

Specified by:

forceMajorCompaction in interface ColumnFamilyStoreMBean

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

invalidateRowCache

public void invalidateRowCache()

Description copied from interface: ColumnFamilyStoreMBean

invalidate the row cache; for use after bulk loading via BinaryMemtable

Specified by:

invalidateRowCache in interface ColumnFamilyStoreMBean

invalidateKeyCache

public void invalidateKeyCache()

Description copied from interface: ColumnFamilyStoreMBean

invalidate the key cache; for use after invalidating row cache

Specified by:

invalidateKeyCache in interface ColumnFamilyStoreMBean

getRowCacheCapacity

public int getRowCacheCapacity()

getKeyCacheCapacity

public int getKeyCacheCapacity()

getRowCacheSize

public int getRowCacheSize()

getKeyCacheSize

public int getKeyCacheSize()

all

public static java.lang.Iterable<ColumnFamilyStore> all()

allKeySamples

public java.lang.Iterable<DecoratedKey> allKeySamples()

getMemtablesPendingFlush

public java.util.Set<Memtable> getMemtablesPendingFlush()

truncate

public java.util.concurrent.Future<?> truncate()
                                        throws java.io.IOException

Truncate practically deletes the entire column family's data

Returns:

a Future to the delete operation. Call the future's get() to make sure the column family has been deleted

Throws:

java.io.IOException

renameSSTables

public void renameSSTables(java.lang.String newCfName)
                    throws java.io.IOException

Throws:

java.io.IOException

getBloomFilterFalsePositives

public long getBloomFilterFalsePositives()

Specified by:

getBloomFilterFalsePositives in interface ColumnFamilyStoreMBean

getRecentBloomFilterFalsePositives

public long getRecentBloomFilterFalsePositives()

Specified by:

getRecentBloomFilterFalsePositives in interface ColumnFamilyStoreMBean

getBloomFilterFalseRatio

public double getBloomFilterFalseRatio()

Specified by:

getBloomFilterFalseRatio in interface ColumnFamilyStoreMBean

getRecentBloomFilterFalseRatio

public double getRecentBloomFilterFalseRatio()

Specified by:

getRecentBloomFilterFalseRatio in interface ColumnFamilyStoreMBean

getIndexedColumns

public java.util.SortedSet<java.nio.ByteBuffer> getIndexedColumns()

getIndexedColumnFamilyStore

public ColumnFamilyStore getIndexedColumnFamilyStore(java.nio.ByteBuffer column)

newIndexedColumnFamily

public ColumnFamily newIndexedColumnFamily(java.nio.ByteBuffer column)

getIndexKeyFor

public DecoratedKey<LocalToken> getIndexKeyFor(java.nio.ByteBuffer name,
                                               java.nio.ByteBuffer value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMinimumCompactionThreshold

public int getMinimumCompactionThreshold()

Description copied from interface: ColumnFamilyStoreMBean

Gets the minimum number of sstables in queue before compaction kicks off

Specified by:

getMinimumCompactionThreshold in interface ColumnFamilyStoreMBean

setMinimumCompactionThreshold

public void setMinimumCompactionThreshold(int minCompactionThreshold)

Description copied from interface: ColumnFamilyStoreMBean

Sets the minimum number of sstables in queue before compaction kicks off

Specified by:

setMinimumCompactionThreshold in interface ColumnFamilyStoreMBean

getMaximumCompactionThreshold

public int getMaximumCompactionThreshold()

Description copied from interface: ColumnFamilyStoreMBean

Gets the maximum number of sstables in queue before compaction kicks off

Specified by:

getMaximumCompactionThreshold in interface ColumnFamilyStoreMBean

setMaximumCompactionThreshold

public void setMaximumCompactionThreshold(int maxCompactionThreshold)

Description copied from interface: ColumnFamilyStoreMBean

Sets the maximum number of sstables in queue before compaction kicks off

Specified by:

setMaximumCompactionThreshold in interface ColumnFamilyStoreMBean

disableAutoCompaction

public void disableAutoCompaction()

Description copied from interface: ColumnFamilyStoreMBean

Disable automatic compaction.

Specified by:

disableAutoCompaction in interface ColumnFamilyStoreMBean

getMemtableFlushAfterMins

public int getMemtableFlushAfterMins()

Specified by:

getMemtableFlushAfterMins in interface ColumnFamilyStoreMBean

setMemtableFlushAfterMins

public void setMemtableFlushAfterMins(int time)

Specified by:

setMemtableFlushAfterMins in interface ColumnFamilyStoreMBean

getMemtableThroughputInMB

public int getMemtableThroughputInMB()

Specified by:

getMemtableThroughputInMB in interface ColumnFamilyStoreMBean

setMemtableThroughputInMB

public void setMemtableThroughputInMB(int size)

Specified by:

setMemtableThroughputInMB in interface ColumnFamilyStoreMBean

getMemtableOperationsInMillions

public double getMemtableOperationsInMillions()

Specified by:

getMemtableOperationsInMillions in interface ColumnFamilyStoreMBean

setMemtableOperationsInMillions

public void setMemtableOperationsInMillions(double ops)

Specified by:

setMemtableOperationsInMillions in interface ColumnFamilyStoreMBean

estimateKeys

public long estimateKeys()

Specified by:

estimateKeys in interface ColumnFamilyStoreMBean

getEstimatedRowSizeHistogram

public long[] getEstimatedRowSizeHistogram()

Specified by:

getEstimatedRowSizeHistogram in interface ColumnFamilyStoreMBean

getEstimatedColumnCountHistogram

public long[] getEstimatedColumnCountHistogram()

Specified by:

getEstimatedColumnCountHistogram in interface ColumnFamilyStoreMBean

isIndexBuilt

public boolean isIndexBuilt()

Check if index is already built for current store

Returns:

true if built, false otherwise

getBuiltIndexes

public java.util.List<java.lang.String> getBuiltIndexes()

Returns a list of the names of the built column indexes for current store

Specified by:

getBuiltIndexes in interface ColumnFamilyStoreMBean

Returns:

list of the index names

isIndex

public boolean isIndex()

true if this CFS contains secondary index data

reduceCacheSizes

public void reduceCacheSizes()

sets each cache's maximum capacity to 75% of its current size