Uses of Class org.apache.cassandra.io.sstable.Descriptor (apache-cassandra API)
Date: 2018-02-14

## Uses of Class
org.apache.cassandra.io.sstable.Descriptor

- Packages that use Descriptor
  Package | Description
  --- | ---
  org.apache.cassandra.cache |
  org.apache.cassandra.config |
  org.apache.cassandra.db |
  org.apache.cassandra.db.compaction |
  org.apache.cassandra.index |
  org.apache.cassandra.index.sasi |
  org.apache.cassandra.index.sasi.disk |
  org.apache.cassandra.io.sstable |
  org.apache.cassandra.io.sstable.format |
  org.apache.cassandra.io.sstable.format.big |
  org.apache.cassandra.io.sstable.metadata |
  org.apache.cassandra.io.util |
  org.apache.cassandra.tools |
  org.apache.cassandra.utils |

- - ### Uses of Descriptor in org.apache.cassandra.cache

    Fields in org.apache.cassandra.cache declared as Descriptor
    Modifier and Type | Field and Description
    --- | ---
    `Descriptor` | KeyCacheKey.`desc`

    Constructors in org.apache.cassandra.cache with parameters of type Descriptor
    Constructor and Description
    `KeyCacheKey(Pair<java.lang.String,java.lang.String> ksAndCFName, Descriptor desc, java.nio.ByteBuffer key)`

  - ### Uses of Descriptor in org.apache.cassandra.config

    Methods in org.apache.cassandra.config with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `CFMetaData` | Schema.`getCFMetaData(Descriptor descriptor)`

  - ### Uses of Descriptor in org.apache.cassandra.db

    Methods in org.apache.cassandra.db that return Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `Descriptor` | Directories.`find(java.lang.String filename)`

    Methods in org.apache.cassandra.db that return types with arguments of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Map<Descriptor,java.util.Set<Component>>` | Directories.SSTableLister.`list()`

    Methods in org.apache.cassandra.db with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `SSTableMultiWriter` | ColumnFamilyStore.`createSSTableMultiWriter(Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, LifecycleTransaction txn)`
    `SSTableMultiWriter` | ColumnFamilyStore.`createSSTableMultiWriter(Descriptor descriptor, long keyCount, long repairedAt, MetadataCollector metadataCollector, SerializationHeader header, LifecycleTransaction txn)`
    `static java.io.File` | Directories.`getBackupsDirectory(Descriptor desc)`
    `static java.io.File` | Directories.`getSnapshotDirectory(Descriptor desc, java.lang.String snapshotName)`

  - ### Uses of Descriptor in org.apache.cassandra.db.compaction

    Methods in org.apache.cassandra.db.compaction with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `SSTableMultiWriter` | AbstractCompactionStrategy.`createSSTableMultiWriter(Descriptor descriptor, long keyCount, long repairedAt, MetadataCollector meta, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `SSTableMultiWriter` | CompactionStrategyManager.`createSSTableMultiWriter(Descriptor descriptor, long keyCount, long repairedAt, MetadataCollector collector, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`

    Method parameters in org.apache.cassandra.db.compaction with type arguments of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `java.util.concurrent.Future<?>` | CompactionManager.`submitUserDefined(ColumnFamilyStore cfs, java.util.Collection<Descriptor> dataFiles, int gcBefore)`

  - ### Uses of Descriptor in org.apache.cassandra.index

    Methods in org.apache.cassandra.index with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `default SSTableFlushObserver` | Index.`getFlushObserver(Descriptor descriptor, OperationType opType)` Get flush observer to observe partition/cell events generated by flushing SSTable (memtable flush or compaction).

  - ### Uses of Descriptor in org.apache.cassandra.index.sasi

    Methods in org.apache.cassandra.index.sasi with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `SSTableFlushObserver` | SASIIndex.`getFlushObserver(Descriptor descriptor, OperationType opType)`
    `protected static PerSSTableIndexWriter` | SASIIndex.`newWriter(AbstractType<?> keyValidator, Descriptor descriptor, java.util.Map<ColumnDefinition,ColumnIndex> indexes, OperationType opType)`

  - ### Uses of Descriptor in org.apache.cassandra.index.sasi.disk

    Methods in org.apache.cassandra.index.sasi.disk that return Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `Descriptor` | PerSSTableIndexWriter.`getDescriptor()`

    Constructors in org.apache.cassandra.index.sasi.disk with parameters of type Descriptor
    Constructor and Description
    `PerSSTableIndexWriter(AbstractType<?> keyValidator, Descriptor descriptor, OperationType source, java.util.Map<ColumnDefinition,ColumnIndex> supportedIndexes)`

  - ### Uses of Descriptor in org.apache.cassandra.io.sstable

    Fields in org.apache.cassandra.io.sstable declared as Descriptor
    Modifier and Type | Field and Description
    --- | ---
    `Descriptor` | SSTable.`descriptor`

    Methods in org.apache.cassandra.io.sstable that return Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static Descriptor` | Descriptor.`fromFilename(java.lang.String filename)`
    `static Descriptor` | Descriptor.`fromFilename(java.lang.String filename, boolean skipComponent)`
    `static Descriptor` | Descriptor.`fromFilename(java.lang.String filename, SSTableFormat.Type formatType)`
    `Descriptor` | Descriptor.`withDigestComponent(Component newDigestComponent)`
    `Descriptor` | Descriptor.`withFormatType(SSTableFormat.Type newType)`
    `Descriptor` | Descriptor.`withGeneration(int newGeneration)`

    Methods in org.apache.cassandra.io.sstable that return types with arguments of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static Pair<Descriptor,Component>` | Component.`fromFilename(java.io.File directory, java.lang.String name)` `Filename of the form "<ksname>/<cfname>-[tmp-][<version>-]<gen>-<component>",`
    `static Pair<Descriptor,java.lang.String>` | Descriptor.`fromFilename(java.io.File directory, java.lang.String name)`
    `static Pair<Descriptor,java.lang.String>` | Descriptor.`fromFilename(java.io.File directory, java.lang.String name, boolean skipComponent)` Filename of the form is vary by version: <ksname>-<cfname>-(tmp-)?<version>-<gen>-<component> for cassandra 2.0 and before (<tmp marker>-)?<version>-<gen>-<component> for cassandra 3.0 and later If this is for SSTable of secondary index, directory should ends with index name for 2.1+.
    `static Pair<Descriptor,Component>` | SSTable.`tryComponentFromFilename(java.io.File dir, java.lang.String name)`

    Methods in org.apache.cassandra.io.sstable with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `protected static void` | SSTable.`appendTOC(Descriptor descriptor, java.util.Collection<Component> components)` Appends new component names to the TOC component.
    `static java.util.Set<Component>` | SSTable.`componentsFor(Descriptor desc)` Discovers existing components for the descriptor.
    `static SSTableTxnWriter` | SSTableTxnWriter.`create(CFMetaData cfm, Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes)`
    `static SSTableTxnWriter` | SSTableTxnWriter.`create(ColumnFamilyStore cfs, Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header)`
    `static SSTableMultiWriter` | SimpleSSTableMultiWriter.`create(Descriptor descriptor, long keyCount, long repairedAt, CFMetaData cfm, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static boolean` | SSTable.`delete(Descriptor desc, java.util.Set<Component> components)` We use a ReferenceQueue to manage deleting files that have been compacted and for which no more SSTable references exist.
    `static java.util.Set<Component>` | SSTable.`discoverComponentsFor(Descriptor desc)`
    `protected static java.util.Set<Component>` | SSTable.`readTOC(Descriptor descriptor)` Reads the list of components from the TOC component.

    Constructors in org.apache.cassandra.io.sstable with parameters of type Descriptor
    Constructor and Description
    `KeyIterator(Descriptor desc, CFMetaData metadata)`
    `SSTable(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, DiskOptimizationStrategy optimizationStrategy)`

  - ### Uses of Descriptor in org.apache.cassandra.io.sstable.format

    Methods in org.apache.cassandra.io.sstable.format with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static SSTableWriter` | SSTableWriter.`create(CFMetaData metadata, Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, java.lang.Long keyCount, java.lang.Long repairedAt, CFMetaData metadata, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel, SerializationHeader header, java.util.Collection<Index> indexes, LifecycleTransaction txn)`
    `static SSTableReader` | SSTableReader.`internalOpen(Descriptor desc, java.util.Set<Component> components, CFMetaData metadata, FileHandle ifile, FileHandle dfile, IndexSummary isummary, IFilter bf, long maxDataAge, StatsMetadata sstableMetadata, SSTableReader.OpenReason openReason, SerializationHeader header)` Open a RowIndexedReader which already has its state initialized (by SSTableWriter).
    `static void` | SSTableReader.`logOpenException(Descriptor descriptor, java.io.IOException e)`
    `static SSTableReader` | SSTableReader.`open(Descriptor descriptor)`
    `static SSTableReader` | SSTableReader.`open(Descriptor desc, CFMetaData metadata)`
    `abstract SSTableWriter` | SSTableWriter.Factory.`open(Descriptor descriptor, long keyCount, long repairedAt, CFMetaData metadata, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<SSTableFlushObserver> observers, LifecycleTransaction txn)`
    `static SSTableReader` | SSTableReader.`open(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata)`
    `static SSTableReader` | SSTableReader.`open(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, boolean validate, boolean trackHotness)`
    `abstract SSTableReader` | SSTableReader.Factory.`open(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, java.lang.Long maxDataAge, StatsMetadata sstableMetadata, SSTableReader.OpenReason openReason, SerializationHeader header)`
    `static SSTableReader` | SSTableReader.`openForBatch(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata)` Open SSTable reader to be used in batch mode(such as sstableloader).
    `static SSTableReader` | SSTableReader.`openNoValidation(Descriptor descriptor, CFMetaData metadata)`
    `static SSTableReader` | SSTableReader.`openNoValidation(Descriptor descriptor, java.util.Set<Component> components, ColumnFamilyStore cfs)`
    `static void` | SSTableWriter.`rename(Descriptor tmpdesc, Descriptor newdesc, java.util.Set<Component> components)`
    `static void` | SSTableReader.`saveSummary(Descriptor descriptor, DecoratedKey first, DecoratedKey last, IndexSummary summary)` Save index summary to Summary.db file.

    Method parameters in org.apache.cassandra.io.sstable.format with type arguments of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static java.util.Collection<SSTableReader>` | SSTableReader.`openAll(java.util.Set<java.util.Map.Entry<Descriptor,java.util.Set<Component>>> entries, CFMetaData metadata)`

    Constructors in org.apache.cassandra.io.sstable.format with parameters of type Descriptor
    Constructor and Description
    `SSTableReader(Descriptor desc, java.util.Set<Component> components, CFMetaData metadata, long maxDataAge, StatsMetadata sstableMetadata, SSTableReader.OpenReason openReason, SerializationHeader header)`
    `SSTableWriter(Descriptor descriptor, long keyCount, long repairedAt, CFMetaData metadata, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<SSTableFlushObserver> observers)`

  - ### Uses of Descriptor in org.apache.cassandra.io.sstable.format.big

    Constructors in org.apache.cassandra.io.sstable.format.big with parameters of type Descriptor
    Constructor and Description
    `BigTableWriter(Descriptor descriptor, long keyCount, long repairedAt, CFMetaData metadata, MetadataCollector metadataCollector, SerializationHeader header, java.util.Collection<SSTableFlushObserver> observers, LifecycleTransaction txn)`

  - ### Uses of Descriptor in org.apache.cassandra.io.sstable.metadata

    Methods in org.apache.cassandra.io.sstable.metadata with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Map<MetadataType,MetadataComponent>` | IMetadataSerializer.`deserialize(Descriptor descriptor, java.util.EnumSet<MetadataType> types)` Deserialize specified metadata components from given descriptor.
    `java.util.Map<MetadataType,MetadataComponent>` | LegacyMetadataSerializer.`deserialize(Descriptor descriptor, java.util.EnumSet<MetadataType> types)` Deprecated. Legacy serializer deserialize all components no matter what types are specified.
    `java.util.Map<MetadataType,MetadataComponent>` | MetadataSerializer.`deserialize(Descriptor descriptor, java.util.EnumSet<MetadataType> types)`
    `java.util.Map<MetadataType,MetadataComponent>` | MetadataSerializer.`deserialize(Descriptor descriptor, FileDataInput in, java.util.EnumSet<MetadataType> types)`
    `MetadataComponent` | IMetadataSerializer.`deserialize(Descriptor descriptor, MetadataType type)` Deserialized only metadata component specified from given descriptor.
    `MetadataComponent` | MetadataSerializer.`deserialize(Descriptor descriptor, MetadataType type)`
    `void` | IMetadataSerializer.`mutateLevel(Descriptor descriptor, int newLevel)` Mutate SSTable level
    `void` | MetadataSerializer.`mutateLevel(Descriptor descriptor, int newLevel)`
    `void` | IMetadataSerializer.`mutateRepairedAt(Descriptor descriptor, long newRepairedAt)` Mutate repairedAt time
    `void` | MetadataSerializer.`mutateRepairedAt(Descriptor descriptor, long newRepairedAt)`

  - ### Uses of Descriptor in org.apache.cassandra.io.util

    Methods in org.apache.cassandra.io.util with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static DataIntegrityMetadata.ChecksumValidator` | DataIntegrityMetadata.`checksumValidator(Descriptor desc)`
    `static DataIntegrityMetadata.FileDigestValidator` | DataIntegrityMetadata.`fileDigestValidator(Descriptor desc)`

    Constructors in org.apache.cassandra.io.util with parameters of type Descriptor
    Constructor and Description
    `ChecksumValidator(Descriptor descriptor)`
    `FileDigestValidator(Descriptor descriptor)`

  - ### Uses of Descriptor in org.apache.cassandra.tools

    Methods in org.apache.cassandra.tools with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static CFMetaData` | SSTableExport.`metadataFromSSTable(Descriptor desc)` Construct table schema from info stored in SSTable's Stats.db

  - ### Uses of Descriptor in org.apache.cassandra.utils

    Methods in org.apache.cassandra.utils with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static IPartitioner` | FBUtilities.`newPartitioner(Descriptor desc)` Create a new instance of a partitioner defined in an SSTable Descriptor

Copyright © 2018 The Apache Software Foundation