Uses of Class org.apache.cassandra.db.filter.ColumnFilter (apache-cassandra API)
Date: 2018-02-14

## Uses of Class
org.apache.cassandra.db.filter.ColumnFilter

- Packages that use ColumnFilter
  Package | Description
  --- | ---
  org.apache.cassandra.config |
  org.apache.cassandra.cql3 |
  org.apache.cassandra.cql3.statements |
  org.apache.cassandra.db |
  org.apache.cassandra.db.columniterator |
  org.apache.cassandra.db.filter |
  org.apache.cassandra.db.partitions |
  org.apache.cassandra.db.rows |
  org.apache.cassandra.io.sstable.format |
  org.apache.cassandra.io.sstable.format.big |
  org.apache.cassandra.service.pager |

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

    Methods in org.apache.cassandra.config that return ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `ColumnFilter` | CFMetaData.`getAllColumnFilter()`

  - ### Uses of ColumnFilter in org.apache.cassandra.cql3

    Methods in org.apache.cassandra.cql3 that return ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `static ColumnFilter` | SuperColumnCompatibility.`getColumnFilter(CFMetaData cfm, QueryOptions queryOptions, SuperColumnCompatibility.SuperColumnRestrictions restrictions)` For _dense_ SuperColumn Families, the supercolumn key column has to be translated to the collection subselection query in order to avoid reading an entire collection and then filtering out the results.

  - ### Uses of ColumnFilter in org.apache.cassandra.cql3.statements

    Methods in org.apache.cassandra.cql3.statements that return ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `ColumnFilter` | SelectStatement.`queriedColumns()` The columns to fetch internally for this SELECT statement (which can be more than the one selected by the user as it also include any restricted column in particular).

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

    Methods in org.apache.cassandra.db that return ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `ColumnFilter` | ReadCommand.`columnFilter()` A filter on which (non-PK) columns must be returned by the query.
    `protected ColumnFilter` | AbstractReadCommandBuilder.`makeColumnFilter()`

    Methods in org.apache.cassandra.db with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `static PartitionRangeReadCommand` | PartitionRangeReadCommand.`create(boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DataRange dataRange)`
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter)` Creates a new read command on a single partition.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter, IndexMetadata indexMetadata)` Creates a new read command on a single partition.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter)` Creates a new read command on a single partition.
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(CFMetaData metadata, int nowInSec, DecoratedKey key, ColumnFilter columnFilter, ClusteringIndexFilter filter)` Creates a new read command on a single partition.
    `abstract ReadCommand` | ReadCommand.SelectionDeserializer.`deserialize(DataInputPlus in, int version, boolean isDigest, int digestVersion, boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, IndexMetadata index)`
    `SerializationHeader` | SerializationHeader.Serializer.`deserializeForMessaging(DataInputPlus in, CFMetaData metadata, ColumnFilter selection, boolean hasStatic)`
    `Memtable.MemtableUnfilteredPartitionIterator` | Memtable.`makePartitionIterator(ColumnFilter columnFilter, DataRange dataRange, boolean isForThrift)`
    `UnfilteredRowIterator` | StorageHook.`makeRowIterator(ColumnFamilyStore cfs, SSTableReader sstable, DecoratedKey key, Slices slices, ColumnFilter selectedColumns, boolean reversed, boolean isForThrift, SSTableReadsListener listener)`
    `UnfilteredRowIteratorWithLowerBound` | StorageHook.`makeRowIteratorWithLowerBound(ColumnFamilyStore cfs, DecoratedKey partitionKey, SSTableReader sstable, ClusteringIndexFilter filter, ColumnFilter selectedColumns, boolean isForThrift, int nowInSec, boolean applyThriftTransformation, SSTableReadsListener listener)`
    `long` | SerializationHeader.Serializer.`serializedSizeForMessaging(SerializationHeader header, ColumnFilter selection, boolean hasStatic)`
    `void` | SerializationHeader.Serializer.`serializeForMessaging(SerializationHeader header, ColumnFilter selection, DataOutputPlus out, boolean hasStatic)`

    Constructors in org.apache.cassandra.db with parameters of type ColumnFilter
    Constructor and Description
    `MemtableUnfilteredPartitionIterator(ColumnFamilyStore cfs, java.util.Iterator<java.util.Map.Entry<PartitionPosition,AtomicBTreePartition>> iter, boolean isForThrift, int minLocalDeletionTime, ColumnFilter columnFilter, DataRange dataRange)`
    `ReadCommand(ReadCommand.Kind kind, boolean isDigestQuery, int digestVersion, boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, IndexMetadata index)`

  - ### Uses of ColumnFilter in org.apache.cassandra.db.columniterator

    Fields in org.apache.cassandra.db.columniterator declared as ColumnFilter
    Modifier and Type | Field and Description
    --- | ---
    `protected ColumnFilter` | AbstractSSTableIterator.`columns`

    Constructors in org.apache.cassandra.db.columniterator with parameters of type ColumnFilter
    Constructor and Description
    `AbstractSSTableIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry, Slices slices, ColumnFilter columnFilter, boolean isForThrift, FileHandle ifile)`
    `SSTableIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry, Slices slices, ColumnFilter columns, boolean isForThrift, FileHandle ifile)`
    `SSTableReversedIterator(SSTableReader sstable, FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry, Slices slices, ColumnFilter columns, boolean isForThrift, FileHandle ifile)`

  - ### Uses of ColumnFilter in org.apache.cassandra.db.filter

    Methods in org.apache.cassandra.db.filter that return ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `static ColumnFilter` | ColumnFilter.`all(CFMetaData metadata)` A filter that includes all columns for the provided table.
    `ColumnFilter` | ColumnFilter.Builder.`build()`
    `ColumnFilter` | ColumnFilter.Serializer.`deserialize(DataInputPlus in, int version, CFMetaData metadata)`
    `static ColumnFilter` | ColumnFilter.`selection(CFMetaData metadata, PartitionColumns queried)` A filter that fetches all columns for the provided table, but returns only the queried ones.
    `static ColumnFilter` | ColumnFilter.`selection(PartitionColumns columns)` A filter that only fetches/queries the provided columns.

    Methods in org.apache.cassandra.db.filter with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `UnfilteredRowIterator` | ClusteringIndexFilter.`filterNotIndexed(ColumnFilter columnFilter, UnfilteredRowIterator iterator)` Returns an iterator that only returns the rows of the provided iterator that this filter selects.
    `UnfilteredRowIterator` | ClusteringIndexNamesFilter.`filterNotIndexed(ColumnFilter columnFilter, UnfilteredRowIterator iterator)`
    `UnfilteredRowIterator` | ClusteringIndexSliceFilter.`filterNotIndexed(ColumnFilter columnFilter, UnfilteredRowIterator iterator)`
    `UnfilteredRowIterator` | ClusteringIndexFilter.`getUnfilteredRowIterator(ColumnFilter columnFilter, Partition partition)` Given a partition, returns a row iterator for the rows of this partition that are selected by this filter.
    `UnfilteredRowIterator` | ClusteringIndexNamesFilter.`getUnfilteredRowIterator(ColumnFilter columnFilter, Partition partition)`
    `UnfilteredRowIterator` | ClusteringIndexSliceFilter.`getUnfilteredRowIterator(ColumnFilter columnFilter, Partition partition)`
    `void` | ColumnFilter.Serializer.`serialize(ColumnFilter selection, DataOutputPlus out, int version)`
    `long` | ColumnFilter.Serializer.`serializedSize(ColumnFilter selection, int version)`

  - ### Uses of ColumnFilter in org.apache.cassandra.db.partitions

    Methods in org.apache.cassandra.db.partitions with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `UnfilteredPartitionIterator` | UnfilteredPartitionIterators.Serializer.`deserialize(DataInputPlus in, int version, CFMetaData metadata, ColumnFilter selection, SerializationHelper.Flag flag)`
    `static PartitionUpdate` | PartitionUpdate.`fromIterator(RowIterator iterator, ColumnFilter filter)` Turns the given iterator into an update.
    `static PartitionUpdate` | PartitionUpdate.`fromIterator(UnfilteredRowIterator iterator, ColumnFilter filter)` Turns the given iterator into an update.
    `SearchIterator<Clustering,Row>` | AbstractBTreePartition.`searchIterator(ColumnFilter columns, boolean reversed)`
    `SearchIterator<Clustering,Row>` | AtomicBTreePartition.`searchIterator(ColumnFilter columns, boolean reversed)`
    `SearchIterator<Clustering,Row>` | Partition.`searchIterator(ColumnFilter columns, boolean reversed)` Returns an iterator that allows to search specific rows efficiently.
    `void` | UnfilteredPartitionIterators.Serializer.`serialize(UnfilteredPartitionIterator iter, ColumnFilter selection, DataOutputPlus out, int version)`
    `UnfilteredRowIterator` | AbstractBTreePartition.`unfilteredIterator(AbstractBTreePartition.Holder current, ColumnFilter selection, Slices slices, boolean reversed)`
    `UnfilteredRowIterator` | AtomicBTreePartition.`unfilteredIterator(AbstractBTreePartition.Holder current, ColumnFilter selection, Slices slices, boolean reversed)`
    `UnfilteredRowIterator` | AbstractBTreePartition.`unfilteredIterator(ColumnFilter selection, Slices slices, boolean reversed)`
    `UnfilteredRowIterator` | AtomicBTreePartition.`unfilteredIterator(ColumnFilter selection, Slices slices, boolean reversed)`
    `UnfilteredRowIterator` | Partition.`unfilteredIterator(ColumnFilter columns, Slices slices, boolean reversed)` Returns an UnfilteredRowIterator over the rows/RT contained by this partition selected by the provided slices.

  - ### Uses of ColumnFilter in org.apache.cassandra.db.rows

    Methods in org.apache.cassandra.db.rows with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `UnfilteredRowIterator` | UnfilteredRowIteratorSerializer.`deserialize(DataInputPlus in, int version, CFMetaData metadata, ColumnFilter selection, SerializationHelper.Flag flag)`
    `UnfilteredRowIteratorSerializer.Header` | UnfilteredRowIteratorSerializer.`deserializeHeader(CFMetaData metadata, ColumnFilter selection, DataInputPlus in, int version, SerializationHelper.Flag flag)`
    `Row` | BTreeRow.`filter(ColumnFilter filter, CFMetaData metadata)`
    `Row` | Row.`filter(ColumnFilter filter, CFMetaData metadata)` Returns a copy of this row that: 1) only includes the data for the column included by `filter`.
    `Row` | BTreeRow.`filter(ColumnFilter filter, DeletionTime activeDeletion, boolean setActiveDeletionToRow, CFMetaData metadata)`
    `Row` | Row.`filter(ColumnFilter filter, DeletionTime activeDeletion, boolean setActiveDeletionToRow, CFMetaData metadata)` Returns a copy of this row that: 1) only includes the data for the column included by `filter`.
    `ComplexColumnData` | ComplexColumnData.`filter(ColumnFilter filter, DeletionTime activeDeletion, CFMetaData.DroppedColumn dropped, LivenessInfo rowLiveness)`
    `void` | UnfilteredRowIteratorSerializer.`serialize(UnfilteredRowIterator iterator, ColumnFilter selection, DataOutputPlus out, int version)`
    `void` | UnfilteredRowIteratorSerializer.`serialize(UnfilteredRowIterator iterator, ColumnFilter selection, DataOutputPlus out, int version, int rowEstimate)`
    `void` | UnfilteredRowIteratorSerializer.`serialize(UnfilteredRowIterator iterator, SerializationHeader header, ColumnFilter selection, DataOutputPlus out, int version, int rowEstimate)`
    `long` | UnfilteredRowIteratorSerializer.`serializedSize(UnfilteredRowIterator iterator, ColumnFilter selection, int version, int rowEstimate)`
    `Row` | BTreeRow.`withOnlyQueriedData(ColumnFilter filter)`
    `ComplexColumnData` | ComplexColumnData.`withOnlyQueriedData(ColumnFilter filter)`
    `Row` | Row.`withOnlyQueriedData(ColumnFilter filter)` Returns a copy of this row which only include the data queried by `filter`, excluding anything _fetched_ for internal reasons but not queried by the user (see `ColumnFilter` for details).
    `static RowIterator` | RowIterators.`withOnlyQueriedData(RowIterator iterator, ColumnFilter filter)` Filter the provided iterator to only include cells that are selected by the user.
    `static UnfilteredRowIterator` | UnfilteredRowIterators.`withOnlyQueriedData(UnfilteredRowIterator iterator, ColumnFilter filter)` Filter the provided iterator to exclude cells that have been fetched but are not queried by the user (see ColumnFilter for detailes).

    Constructors in org.apache.cassandra.db.rows with parameters of type ColumnFilter
    Constructor and Description
    `RowAndDeletionMergeIterator(CFMetaData metadata, DecoratedKey partitionKey, DeletionTime partitionLevelDeletion, ColumnFilter selection, Row staticRow, boolean isReversed, EncodingStats stats, java.util.Iterator<Row> rows, java.util.Iterator<RangeTombstone> ranges, boolean removeShadowedData)`
    `SerializationHelper(CFMetaData metadata, int version, SerializationHelper.Flag flag, ColumnFilter columnsToFetch)`
    `UnfilteredRowIteratorWithLowerBound(DecoratedKey partitionKey, SSTableReader sstable, ClusteringIndexFilter filter, ColumnFilter selectedColumns, boolean isForThrift, int nowInSec, boolean applyThriftTransformation, SSTableReadsListener listener)`
    `WithOnlyQueriedData(ColumnFilter filter)`

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

    Methods in org.apache.cassandra.io.sstable.format with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `ISSTableScanner` | SSTableReader.`getScanner(ColumnFilter columns, DataRange dataRange, boolean isForThrift, SSTableReadsListener listener)`
    `abstract ISSTableScanner` | SSTableReader.`getScanner(ColumnFilter columns, DataRange dataRange, com.google.common.util.concurrent.RateLimiter limiter, boolean isForThrift, SSTableReadsListener listener)`
    `abstract UnfilteredRowIterator` | SSTableReader.`iterator(DecoratedKey key, Slices slices, ColumnFilter selectedColumns, boolean reversed, boolean isForThrift, SSTableReadsListener listener)`
    `abstract UnfilteredRowIterator` | SSTableReader.`iterator(FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry, Slices slices, ColumnFilter selectedColumns, boolean reversed, boolean isForThrift)`

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

    Methods in org.apache.cassandra.io.sstable.format.big with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `ISSTableScanner` | BigTableReader.`getScanner(ColumnFilter columns, DataRange dataRange, com.google.common.util.concurrent.RateLimiter limiter, boolean isForThrift, SSTableReadsListener listener)`
    `static ISSTableScanner` | BigTableScanner.`getScanner(SSTableReader sstable, ColumnFilter columns, DataRange dataRange, com.google.common.util.concurrent.RateLimiter limiter, boolean isForThrift, SSTableReadsListener listener)`
    `UnfilteredRowIterator` | BigTableReader.`iterator(DecoratedKey key, Slices slices, ColumnFilter selectedColumns, boolean reversed, boolean isForThrift, SSTableReadsListener listener)`
    `UnfilteredRowIterator` | BigTableReader.`iterator(FileDataInput file, DecoratedKey key, RowIndexEntry indexEntry, Slices slices, ColumnFilter selectedColumns, boolean reversed, boolean isForThrift)`

  - ### Uses of ColumnFilter in org.apache.cassandra.service.pager

    Methods in org.apache.cassandra.service.pager with parameters of type ColumnFilter
    Modifier and Type | Method and Description
    --- | ---
    `static int` | QueryPagers.`countPaged(CFMetaData metadata, DecoratedKey key, ColumnFilter columnFilter, ClusteringIndexFilter filter, DataLimits limits, ConsistencyLevel consistencyLevel, ClientState state, int pageSize, int nowInSec, boolean isForThrift, long queryStartNanoTime)` Convenience method that count (live) cells/rows for a given slice of a row, but page underneath.

Copyright © 2018 The Apache Software Foundation