Package org.apache.cassandra.io.sstable.format

Interface SSTableFormat<R extends SSTableReader,W extends SSTableWriter>

All Known Implementing Classes:

AbstractSSTableFormat, BigFormat, BtiFormat

public interface SSTableFormat<R extends SSTableReader,W extends SSTableWriter>

Provides the accessors to data on disk.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SSTableFormat.Components
static interface	SSTableFormat.Factory
static interface	SSTableFormat.KeyCacheValueSerializer<R extends SSTableReader,T extends AbstractRowIndexEntry>
static interface	SSTableFormat.SSTableReaderFactory<R extends SSTableReader,B extends SSTableReader.Builder<R,B>>
static interface	SSTableFormat.SSTableWriterFactory<W extends SSTableWriter,B extends SSTableWriter.Builder<W,B>>

Method Summary

Modifier and Type	Method	Description
Set<Component>	allComponents()	All the components that the writter can produce when saving an sstable, as well as all the components that the reader can read.
Set<Component>	batchComponents()	Returns components required by offline compaction tasks - like splitting sstables.
void	delete(Descriptor descriptor)	Deletes the existing components of the sstables represented by the provided descriptor.
void	deleteOrphanedComponents(Descriptor descriptor, Set<Component> components)
Set<Component>	generatedOnLoadComponents()	Returns a set of components that can be automatically generated when loading sstable and thus are not mandatory.
MetricsProviders	getFormatSpecificMetricsProviders()
SSTableFormat.KeyCacheValueSerializer<R,?>	getKeyCacheValueSerializer()
Version	getLatestVersion()
SSTableFormat.SSTableReaderFactory<R,?>	getReaderFactory()
IScrubber	getScrubber(ColumnFamilyStore cfs, LifecycleTransaction transaction, OutputHandler outputHandler, IScrubber.Options options)	Returns a new scrubber for an sstable.
Version	getVersion(String version)
SSTableFormat.SSTableWriterFactory<W,?>	getWriterFactory()
Set<Component>	mutableComponents()	Returns a set of the components that can be changed after an sstable was written.
String	name()
Set<Component>	primaryComponents()
Set<Component>	uploadComponents()	Returns the components which should be selected for upload by the sstable loader.

Method Details

name

String name()

getLatestVersion

Version getLatestVersion()

getVersion

Version getVersion(String version)

getWriterFactory

SSTableFormat.SSTableWriterFactory<W,?> getWriterFactory()

getReaderFactory

SSTableFormat.SSTableReaderFactory<R,?> getReaderFactory()

allComponents

Set<Component> allComponents()

All the components that the writter can produce when saving an sstable, as well as all the components that the reader can read.

primaryComponents

Set<Component> primaryComponents()

batchComponents

Set<Component> batchComponents()

Returns components required by offline compaction tasks - like splitting sstables.

uploadComponents

Set<Component> uploadComponents()

Returns the components which should be selected for upload by the sstable loader.

mutableComponents

Set<Component> mutableComponents()

Returns a set of the components that can be changed after an sstable was written.

generatedOnLoadComponents

Set<Component> generatedOnLoadComponents()

Returns a set of components that can be automatically generated when loading sstable and thus are not mandatory.

getKeyCacheValueSerializer

SSTableFormat.KeyCacheValueSerializer<R,?> getKeyCacheValueSerializer()

getScrubber

IScrubber getScrubber(ColumnFamilyStore cfs,
 LifecycleTransaction transaction,
 OutputHandler outputHandler,
 IScrubber.Options options)

Returns a new scrubber for an sstable. Note that the transaction must contain only one reader and the reader must match the provided cfs.

getFormatSpecificMetricsProviders

MetricsProviders getFormatSpecificMetricsProviders()

deleteOrphanedComponents

void deleteOrphanedComponents(Descriptor descriptor,
 Set<Component> components)

delete

void delete(Descriptor descriptor)

Deletes the existing components of the sstables represented by the provided descriptor. The method is also responsible for cleaning up the in-memory resources occupied by the stuff related to that sstables, such as row key cache entries.