RowFilter

com.google.bigtable.v2.data.RowFilter
See theRowFilter companion object
final case class RowFilter(filter: Filter, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RowFilter]

Takes a row as input and produces an alternate view of the row based on specified rules. For example, a RowFilter might trim down a row to include just the cells from columns matching a given regular expression, or might return all the cells of a row but not their values. More complicated filters can be composed out of these components to express requests such as, "within every column of a particular family, give just the two most recent cells which are older than timestamp X."

There are two broad categories of RowFilters (true filters and transformers), as well as two ways to compose simple filters into more complex ones (chains and interleaves). They work as follows:

  • True filters alter the input row by excluding some of its cells wholesale from the output row. An example of a true filter is the value_regex_filter, which excludes cells whose values don't match the specified pattern. All regex true filters use RE2 syntax (https://github.com/google/re2/wiki/Syntax) in raw byte mode (RE2::Latin1), and are evaluated as full matches. An important point to keep in mind is that RE2(.) is equivalent by default to RE2([^&92;n]), meaning that it does not match newlines. When attempting to match an arbitrary byte, you should therefore use the escape sequence &92;C, which may need to be further escaped as &92;&92;C in your client language.

  • Transformers alter the input row by changing the values of some of its cells in the output, without excluding them completely. Currently, the only supported transformer is the strip_value_transformer, which replaces every cell's value with the empty string.

  • Chains and interleaves are described in more detail in the RowFilter.Chain and RowFilter.Interleave documentation.

The total serialized size of a RowFilter message must not exceed 20480 bytes, and RowFilters may not be nested within each other (in Chains or Interleaves) to a depth of more than 20.

Attributes

Companion
object
Source
RowFilter.scala
Graph
Supertypes
trait Updatable[RowFilter]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

Attributes

Source
RowFilter.scala
def companion: RowFilter.type

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def getBlockAllFilter: Boolean

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
RowFilter.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def getPassAllFilter: Boolean

Attributes

Source
RowFilter.scala
def getRowKeyRegexFilter: ByteString

Attributes

Source
RowFilter.scala
def getRowSampleFilter: Double

Attributes

Source
RowFilter.scala
def getSink: Boolean

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def getValueRegexFilter: ByteString

Attributes

Source
RowFilter.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
RowFilter.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
RowFilter.scala
def withApplyLabelTransformer(`__v`: String): RowFilter

Attributes

Source
RowFilter.scala
def withBlockAllFilter(`__v`: Boolean): RowFilter

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def withChain(`__v`: Chain): RowFilter

Attributes

Source
RowFilter.scala
def withColumnQualifierRegexFilter(`__v`: ByteString): RowFilter

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def withFamilyNameRegexFilter(`__v`: String): RowFilter

Attributes

Source
RowFilter.scala
def withFilter(`__v`: Filter): RowFilter

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def withPassAllFilter(`__v`: Boolean): RowFilter

Attributes

Source
RowFilter.scala
def withRowKeyRegexFilter(`__v`: ByteString): RowFilter

Attributes

Source
RowFilter.scala
def withRowSampleFilter(`__v`: Double): RowFilter

Attributes

Source
RowFilter.scala
def withSink(`__v`: Boolean): RowFilter

Attributes

Source
RowFilter.scala
def withStripValueTransformer(`__v`: Boolean): RowFilter

Attributes

Source
RowFilter.scala
def withUnknownFields(`__v`: UnknownFieldSet): RowFilter

Attributes

Source
RowFilter.scala

Attributes

Source
RowFilter.scala
def withValueRegexFilter(`__v`: ByteString): RowFilter

Attributes

Source
RowFilter.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
RowFilter.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: Lens[RowFilter, RowFilter] => () => RowFilter*): A

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala