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

## 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.io.sstable |
  org.apache.cassandra.io.sstable.format |
  org.apache.cassandra.io.sstable.metadata |
  org.apache.cassandra.io.util |
  org.apache.cassandra.streaming |
  org.apache.cassandra.tools |

- - ### 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
    --- | ---
    `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

    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.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
    --- | ---
    `Descriptor` | Descriptor.`asType(Descriptor.Type type)`
    `protected static Descriptor` | AbstractSSTableSimpleWriter.`createDescriptor(java.io.File directory, java.lang.String keyspace, java.lang.String columnFamily, SSTableFormat.Type fmt)`
    `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)`
    `abstract Descriptor` | AbstractSSTableSimpleWriter.`getCurrentDescriptor()`
    `Descriptor` | CQLSSTableWriter.`getCurrentDescriptor()`
    `Descriptor` | SSTableSimpleUnsortedWriter.`getCurrentDescriptor()` Deprecated.
    `Descriptor` | SSTableSimpleWriter.`getCurrentDescriptor()` Deprecated.
    `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 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)`
    `SSTable(Descriptor descriptor, CFMetaData metadata, IPartitioner partitioner)`
    `SSTable(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, IPartitioner partitioner)`
    `SSTableDeletingTask(Descriptor realDescriptor, java.util.Set<Component> components, com.codahale.metrics.Counter totalDiskSpaceUsed, long bytesOnDisk)` realDescriptor is the actual descriptor for the sstable, the descriptor inside referent can be 'faked' as FINAL for early opened files.

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

    Methods in org.apache.cassandra.io.sstable.format that return Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `static Descriptor` | SSTableWriter.`rename(Descriptor tmpdesc, java.util.Set<Component> components)`

    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, IPartitioner partitioner)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, long keyCount, long repairedAt)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, java.lang.Long keyCount, java.lang.Long repairedAt, CFMetaData metadata, IPartitioner partitioner, MetadataCollector metadataCollector)`
    `static SSTableWriter` | SSTableWriter.`create(Descriptor descriptor, long keyCount, long repairedAt, int sstableLevel)`
    `static SSTableReader` | SSTableReader.`internalOpen(Descriptor desc, java.util.Set<Component> components, CFMetaData metadata, IPartitioner partitioner, SegmentedFile ifile, SegmentedFile dfile, IndexSummary isummary, IFilter bf, long maxDataAge, StatsMetadata sstableMetadata, SSTableReader.OpenReason openReason)` 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, IPartitioner partitioner, MetadataCollector metadataCollector)`
    `static SSTableReader` | SSTableReader.`open(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, IPartitioner partitioner)`
    `static SSTableReader` | SSTableReader.`open(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, IPartitioner partitioner, boolean validate, boolean trackHotness)`
    `abstract SSTableReader` | SSTableReader.Factory.`open(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, IPartitioner partitioner, java.lang.Long maxDataAge, StatsMetadata sstableMetadata, SSTableReader.OpenReason openReason)`
    `static SSTableReader` | SSTableReader.`openForBatch(Descriptor descriptor, java.util.Set<Component> components, CFMetaData metadata, IPartitioner partitioner)` Open SSTable reader to be used in batch mode(such as sstableloader).
    `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 Descriptor` | SSTableWriter.`rename(Descriptor tmpdesc, java.util.Set<Component> components)`
    `static void` | SSTableReader.`saveSummary(Descriptor descriptor, DecoratedKey first, DecoratedKey last, SegmentedFile.Builder ibuilder, SegmentedFile.Builder dbuilder, 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, IPartitioner partitioner)`

    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, IPartitioner partitioner, long maxDataAge, StatsMetadata sstableMetadata, SSTableReader.OpenReason openReason)`
    `SSTableWriter(Descriptor descriptor, long keyCount, long repairedAt, CFMetaData metadata, IPartitioner partitioner, MetadataCollector metadataCollector)`

  - ### 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

    Fields in org.apache.cassandra.io.util declared as Descriptor
    Modifier and Type | Field and Description
    --- | ---
    `protected Descriptor` | SequentialWriter.`descriptor`

    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)`
    `static boolean` | MmappedSegmentedFile.`maybeRepair(CFMetaData metadata, Descriptor descriptor, IndexSummary indexSummary, SegmentedFile.Builder ibuilder, SegmentedFile.Builder dbuilder)`
    `SequentialWriter` | SequentialWriter.`setDescriptor(Descriptor descriptor)`
    `void` | DataIntegrityMetadata.ChecksumWriter.`writeFullChecksum(Descriptor descriptor)`

    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.streaming

    Fields in org.apache.cassandra.streaming declared as Descriptor
    Modifier and Type | Field and Description
    --- | ---
    `protected Descriptor` | StreamReader.`desc`

    Methods in org.apache.cassandra.streaming with parameters of type Descriptor
    Modifier and Type | Method and Description
    --- | ---
    `void` | StreamSession.`progress(Descriptor desc, ProgressInfo.Direction direction, long bytes, long total)`

  - ### 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 void` | SSTableExport.`enumeratekeys(Descriptor desc, java.io.PrintStream outs, CFMetaData metadata)` Enumerate row keys from an SSTableReader and write the result to a PrintStream.
    `static void` | SSTableExport.`export(Descriptor desc, java.io.PrintStream outs, java.util.Collection<java.lang.String> toExport, java.lang.String[] excludes, CFMetaData metadata)` Export specific rows from an SSTable and write the resulting JSON to a PrintStream.
    `static void` | SSTableExport.`export(Descriptor desc, java.io.PrintStream outs, java.lang.String[] excludes)` Export an SSTable and write the resulting JSON to a PrintStream.
    `static void` | SSTableExport.`export(Descriptor desc, java.lang.String[] excludes)` Export an SSTable and write the resulting JSON to standard out.

Copyright © 2018 The Apache Software Foundation