Package org.apache.cassandra.index.sai.disk.format

Class IndexDescriptor

java.lang.Object

org.apache.cassandra.index.sai.disk.format.IndexDescriptor

public class IndexDescriptor
extends Object

The IndexDescriptor is an analog of the SSTable Descriptor and provides version specific information about the on-disk state of a StorageAttachedIndex.

The IndexDescriptor is primarily responsible for maintaining a view of the on-disk state of an index for a specific SSTable.

It is responsible for opening files for use by writers and readers.

Its remaining responsibility is to act as a proxy to the OnDiskFormat associated with the index Version.

Field Summary

Fields

Modifier and Type	Field	Description
final ClusteringComparator	clusteringComparator
final PrimaryKey.Factory	primaryKeyFactory
final Descriptor	sstableDescriptor
final Version	version

Method Summary

Modifier and Type	Method	Description
String	componentName(IndexComponent indexComponent)
static IndexDescriptor	create(Descriptor descriptor, IPartitioner partitioner, ClusteringComparator clusteringComparator)
static IndexDescriptor	create(SSTableReader sstable)
void	createComponentOnDisk(IndexComponent component)
void	createComponentOnDisk(IndexComponent component, IndexIdentifier indexIdentifier)
FileHandle	createPerIndexFileHandle(IndexComponent indexComponent, IndexIdentifier indexIdentifier)
FileHandle	createPerIndexFileHandle(IndexComponent indexComponent, IndexIdentifier indexIdentifier, Throwables.DiscreteAction<?> cleanup)
FileHandle	createPerSSTableFileHandle(IndexComponent indexComponent, Throwables.DiscreteAction<?> cleanup)
void	deleteColumnIndex(IndexTermType indexTermType, IndexIdentifier indexIdentifier)
void	deletePerSSTableIndexComponents()
boolean	equals(Object o)
File	fileFor(IndexComponent indexComponent)
File	fileFor(IndexComponent indexComponent, IndexIdentifier indexIdentifier)
Set<Component>	getLivePerIndexComponents(IndexTermType indexTermType, IndexIdentifier indexIdentifier)
Set<Component>	getLivePerSSTableComponents()
boolean	hasClustering()
boolean	hasComponent(IndexComponent indexComponent)
boolean	hasComponent(IndexComponent indexComponent, IndexIdentifier indexIdentifier)
int	hashCode()
boolean	isIndexEmpty(IndexTermType indexTermType, IndexIdentifier indexIdentifier)
boolean	isPerColumnIndexBuildComplete(IndexIdentifier indexIdentifier)
boolean	isPerSSTableIndexBuildComplete()
String	logMessage(String message)
PerColumnIndexWriter	newPerColumnIndexWriter(StorageAttachedIndex index, LifecycleNewTracker tracker, RowMapping rowMapping)
PerSSTableIndexWriter	newPerSSTableIndexWriter()
PrimaryKeyMap.Factory	newPrimaryKeyMapFactory(SSTableReader sstable)
SSTableIndex	newSSTableIndex(SSTableContext sstableContext, StorageAttachedIndex index)
org.apache.lucene.store.IndexInput	openPerIndexInput(IndexComponent indexComponent, IndexIdentifier indexIdentifier)
IndexOutputWriter	openPerIndexOutput(IndexComponent indexComponent, IndexIdentifier indexIdentifier)
IndexOutputWriter	openPerIndexOutput(IndexComponent component, IndexIdentifier indexIdentifier, boolean append)
org.apache.lucene.store.IndexInput	openPerSSTableInput(IndexComponent indexComponent)
IndexOutputWriter	openPerSSTableOutput(IndexComponent component)
IndexOutputWriter	openPerSSTableOutput(IndexComponent component, boolean append)
long	sizeOnDiskOfPerIndexComponent(IndexComponent indexComponent, IndexIdentifier indexIdentifier)
long	sizeOnDiskOfPerIndexComponents(IndexTermType indexTermType, IndexIdentifier indexIdentifier)
long	sizeOnDiskOfPerSSTableComponents()
String	toString()
boolean	validatePerIndexComponents(IndexTermType indexTermType, IndexIdentifier indexIdentifier, IndexValidation validation, boolean validateChecksum, boolean rethrow)
boolean	validatePerSSTableComponents(IndexValidation validation, boolean validateChecksum, boolean rethrow)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

version

public final Version version

sstableDescriptor

public final Descriptor sstableDescriptor

clusteringComparator

public final ClusteringComparator clusteringComparator

primaryKeyFactory

public final PrimaryKey.Factory primaryKeyFactory

Method Details

create

public static IndexDescriptor create(Descriptor descriptor,
 IPartitioner partitioner,
 ClusteringComparator clusteringComparator)

create

public static IndexDescriptor create(SSTableReader sstable)

hasClustering

public boolean hasClustering()

componentName

public String componentName(IndexComponent indexComponent)

newPrimaryKeyMapFactory

public PrimaryKeyMap.Factory newPrimaryKeyMapFactory(SSTableReader sstable)

newSSTableIndex

public SSTableIndex newSSTableIndex(SSTableContext sstableContext,
 StorageAttachedIndex index)

newPerSSTableIndexWriter

public PerSSTableIndexWriter newPerSSTableIndexWriter()
                                               throws IOException

Throws:

IOException

newPerColumnIndexWriter

public PerColumnIndexWriter newPerColumnIndexWriter(StorageAttachedIndex index,
 LifecycleNewTracker tracker,
 RowMapping rowMapping)

isPerSSTableIndexBuildComplete

public boolean isPerSSTableIndexBuildComplete()

isPerColumnIndexBuildComplete

public boolean isPerColumnIndexBuildComplete(IndexIdentifier indexIdentifier)

hasComponent

public boolean hasComponent(IndexComponent indexComponent)

hasComponent

public boolean hasComponent(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier)

fileFor

public File fileFor(IndexComponent indexComponent)

fileFor

public File fileFor(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier)

isIndexEmpty

public boolean isIndexEmpty(IndexTermType indexTermType,
 IndexIdentifier indexIdentifier)

createComponentOnDisk

public void createComponentOnDisk(IndexComponent component)
                           throws IOException

Throws:

IOException

createComponentOnDisk

public void createComponentOnDisk(IndexComponent component,
 IndexIdentifier indexIdentifier)
                           throws IOException

Throws:

IOException

openPerSSTableInput

public org.apache.lucene.store.IndexInput openPerSSTableInput(IndexComponent indexComponent)

openPerIndexInput

public org.apache.lucene.store.IndexInput openPerIndexInput(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier)

openPerSSTableOutput

public IndexOutputWriter openPerSSTableOutput(IndexComponent component)
                                       throws IOException

Throws:

IOException

openPerSSTableOutput

public IndexOutputWriter openPerSSTableOutput(IndexComponent component,
 boolean append)
                                       throws IOException

Throws:

IOException

openPerIndexOutput

public IndexOutputWriter openPerIndexOutput(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier)
                                     throws IOException

Throws:

IOException

openPerIndexOutput

public IndexOutputWriter openPerIndexOutput(IndexComponent component,
 IndexIdentifier indexIdentifier,
 boolean append)
                                     throws IOException

Throws:

IOException

createPerSSTableFileHandle

public FileHandle createPerSSTableFileHandle(IndexComponent indexComponent,
 Throwables.DiscreteAction<?> cleanup)

createPerIndexFileHandle

public FileHandle createPerIndexFileHandle(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier)

createPerIndexFileHandle

public FileHandle createPerIndexFileHandle(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier,
 Throwables.DiscreteAction<?> cleanup)

getLivePerSSTableComponents

public Set<Component> getLivePerSSTableComponents()

getLivePerIndexComponents

public Set<Component> getLivePerIndexComponents(IndexTermType indexTermType,
 IndexIdentifier indexIdentifier)

sizeOnDiskOfPerSSTableComponents

public long sizeOnDiskOfPerSSTableComponents()

sizeOnDiskOfPerIndexComponents

public long sizeOnDiskOfPerIndexComponents(IndexTermType indexTermType,
 IndexIdentifier indexIdentifier)

sizeOnDiskOfPerIndexComponent

public long sizeOnDiskOfPerIndexComponent(IndexComponent indexComponent,
 IndexIdentifier indexIdentifier)

validatePerIndexComponents

public boolean validatePerIndexComponents(IndexTermType indexTermType,
 IndexIdentifier indexIdentifier,
 IndexValidation validation,
 boolean validateChecksum,
 boolean rethrow)

validatePerSSTableComponents

public boolean validatePerSSTableComponents(IndexValidation validation,
 boolean validateChecksum,
 boolean rethrow)

deletePerSSTableIndexComponents

public void deletePerSSTableIndexComponents()

deleteColumnIndex

public void deleteColumnIndex(IndexTermType indexTermType,
 IndexIdentifier indexIdentifier)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

logMessage

public String logMessage(String message)