Package org.apache.cassandra.db.filter

Class RowFilter

java.lang.Object
org.apache.cassandra.db.filter.RowFilter
All Implemented Interfaces:
Iterable<RowFilter.Expression>
public class RowFilter extends Object implements Iterable<RowFilter.Expression>
A filter on which rows a given query should include or exclude.

This corresponds to the restrictions on rows that are not handled by the query ClusteringIndexFilter. Some of the expressions of this filter may be handled by a 2ndary index, and the rest is simply filtered out from the result set (the later can only happen if the query was using ALLOW FILTERING).

  • Field Details

  • Constructor Details

  • Method Details

    • create

      public static RowFilter create(boolean needsReconciliation)
      Parameters:
      needsReconciliation - whether or not this filter belongs to a read that requires coordinator reconciliation
      Returns:
      a new RowFilter with an empty RowFilter.Expression list

    • none

      public static RowFilter none()

    • add

      public RowFilter.SimpleExpression add(ColumnMetadata def, Operator op, ByteBuffer value)

    • addMapEquality

      public void addMapEquality(ColumnMetadata def, ByteBuffer key, Operator op, ByteBuffer value)

    • addCustomIndexExpression

      public void addCustomIndexExpression(TableMetadata metadata, IndexMetadata targetIndex, ByteBuffer value)

    • getExpressions

      public List<RowFilter.Expression> getExpressions()

    • needsReconciliation

      public boolean needsReconciliation()
      Returns:
      true if this filter belongs to a read that requires reconciliation at the coordinator
      See Also:

    • isStrict

      public boolean isStrict()
      If this filter belongs to a read that requires reconciliation at the coordinator, and it contains an intersection on two or more non-key (and therefore mutable) columns, we cannot strictly apply it to local, unrepaired rows. When this occurs, we must downgrade the intersection of expressions to a union and leave the coordinator to filter strictly before sending results to the client.
      Returns:
      true if strict filtering is safe
      See Also:

    • isMutableIntersection

      public boolean isMutableIntersection()
      Returns:
      true if this filter contains an intersection on either any static column or two regular mutable columns

    • hasExpressionOnClusteringOrRegularColumns

      public boolean hasExpressionOnClusteringOrRegularColumns()
      Checks if some of the expressions apply to clustering or regular columns.
      Returns:
      true if some of the expressions apply to clustering or regular columns, false otherwise.

    • filter

      protected Transformation<BaseRowIterator<?>> filter(TableMetadata metadata, long nowInSec)
      Note that the application of this transformation does not yet take isStrict() into account. This means that even when strict filtering is not safe, expressions will be applied as intersections rather than unions. The filter will always be evaluated strictly in conjunction with replica filtering protection at the coordinator, however, even after CASSANDRA-19007 is addressed.
      See Also:

    • filter

      public UnfilteredPartitionIterator filter(UnfilteredPartitionIterator iter, long nowInSec)
      Filters the provided iterator so that only the row satisfying the expression of this filter are included in the resulting iterator.
      Parameters:
      iter - the iterator to filter
      nowInSec - the time of query in seconds.
      Returns:
      the filtered iterator.

    • filter

      public PartitionIterator filter(PartitionIterator iter, TableMetadata metadata, long nowInSec)
      Filters the provided iterator so that only the row satisfying the expression of this filter are included in the resulting iterator.
      Parameters:
      iter - the iterator to filter
      nowInSec - the time of query in seconds.
      Returns:
      the filtered iterator.

    • isSatisfiedBy

      public boolean isSatisfiedBy(TableMetadata metadata, DecoratedKey partitionKey, Row row, long nowInSec)
      Whether the provided row in the provided partition satisfies this filter.
      Parameters:
      metadata - the table metadata.
      partitionKey - the partition key for partition to test.
      row - the row to test.
      nowInSec - the current time in seconds (to know what is live and what isn't).
      Returns:
      true if row in partition partitionKey satisfies this row filter.

    • partitionKeyRestrictionsAreSatisfiedBy

      public boolean partitionKeyRestrictionsAreSatisfiedBy(DecoratedKey key, AbstractType<?> keyValidator)
      Returns true if all of the expressions within this filter that apply to the partition key are satisfied by the given key, false otherwise.

    • clusteringKeyRestrictionsAreSatisfiedBy

      public boolean clusteringKeyRestrictionsAreSatisfiedBy(Clustering<?> clustering)
      Returns true if all of the expressions within this filter that apply to the clustering key are satisfied by the given Clustering, false otherwise.

    • without

      public RowFilter without(RowFilter.Expression expression)
      Returns this filter but without the provided expression. This method *assumes* that the filter contains the provided expression.

    • without

      public RowFilter without(ColumnMetadata column, Operator op, ByteBuffer value)
      Returns a copy of this filter but without the provided expression. If this filter doesn't contain the specified expression this method will just return an identical copy of this filter.

    • hasNonKeyExpression

      public boolean hasNonKeyExpression()

    • hasStaticExpression

      public boolean hasStaticExpression()

    • withoutExpressions

      public RowFilter withoutExpressions()

    • withNewExpressions

      protected RowFilter withNewExpressions(List<RowFilter.Expression> expressions)

    • isEmpty

      public boolean isEmpty()

    • iterator

      public Iterator<RowFilter.Expression> iterator()
      Specified by:
      iterator in interface Iterable<RowFilter.Expression>

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toCQLString

      public String toCQLString()
      Returns a CQL representation of this row filter.
      Returns:
      a CQL representation of this row filter