Class: Google::Cloud::Bigtable::RowFilter::SimpleFilter

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/row_filter/simple_filter.rb

Overview

SimpleFilter

Instance Method Summary collapse

Instance Method Details

#block ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.

Returns:



61
62
63
64
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 61

def block
  @grpc.block_all_filter = true
  self
end

#cells_per_column(limit) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only the most recent N cells within each column. For example, if N=2, this filter would match column foo:bar at timestamps 10 and 9, skip all earlier cells in foo:bar, and then begin matching again in column foo:bar2. If duplicate cells are present, as is possible when using an interleave, each copy of the cell is counted separately.

Parameters:

  • limit (String) —

    Max cell match per column limit

Returns:



217
218
219
220
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 217

def cells_per_column limit
  @grpc.cells_per_column_limit_filter = limit
  self
end

#cells_per_row(limit) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only the first N cells of each row. If duplicate cells are present, as is possible when using an Interleave, each copy of the cell is counted separately.

Parameters:

  • limit (String) —

    Max cell match per row limit

Returns:



201
202
203
204
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 201

def cells_per_row limit
  @grpc.cells_per_row_limit_filter = limit
  self
end

#cells_per_row_offset(offset) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Skips the first N cells of each row, matching all subsequent cells. If duplicate cells are present, as is possible when using an interleave, each copy of the cell is counted separately.

Parameters:

  • offset (Integer) —

    Offset value.

Returns:



188
189
190
191
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 188

def cells_per_row_offset offset
  @grpc.cells_per_row_offset_filter = offset
  self
end

#column_range(range) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only cells from columns within the given range.

Parameters:

Returns:



267
268
269
270
271
272
273
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 267

def column_range range
  unless range.instance_of? Google::Cloud::Bigtable::ColumnRange
    raise RowFilterError, "Range type mustbe ColumnRange"
  end
  @grpc.column_range_filter = range.to_grpc
  self
end

#family(regex) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only cells from columns whose families satisfy the given RE2 regex. For technical reasons, the regex must not contain the : character, even if it is not being used as a literal. Note that, since column families cannot contain the new line character \n, it is sufficient to use . as a full wildcard when matching column family names.

Parameters:

  • regex (String) —

    Regex to match family name.

Returns:



122
123
124
125
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 122

def family regex
  @grpc.family_name_regex_filter = regex
  self
end

#key(regex) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only cells from rows whose keys satisfy the given RE2 regex. In other words, passes through the entire row when the key matches, and otherwise produces an empty row. Note that, since row keys can contain arbitrary bytes, the \C escape sequence must be used if a true wildcard is desired. The . character will not match the new line character \n, which may be present in a binary key.

For Regex syntax:

Parameters:

  • regex (String) —

    Regex to match row keys.

Returns:

See Also:



91
92
93
94
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 91

def key regex
  @grpc.row_key_regex_filter = regex
  self
end

#label(value) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Applies the given label to all cells in the output row. This allows the client to determine which results were produced from which part of the filter.

Values must be at most 15 characters in length, and match the RE2 pattern [a-z0-9\\-]+

Due to a technical limitation, it is not possible to apply multiple labels to a cell. As a result, a chain may have no more than one sub-filter that contains an apply_label_transformer. It is okay for an interleave to contain multiple apply_label_transformers, as they will be applied to separate copies of the input.

Parameters:

  • value (String) —

    Label name

Returns:



175
176
177
178
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 175

def label value
  @grpc.apply_label_transformer = value
  self
end

#pass ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches all cells, regardless of input. Functionally equivalent to leaving filter unset, but included for completeness.

Returns:



50
51
52
53
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 50

def pass
  @grpc.pass_all_filter = true
  self
end

#qualifier(regex) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only cells from columns whose qualifiers satisfy the given RE2 regex. Note that, since column qualifiers can contain arbitrary bytes, the \C escape sequence must be used if a true wildcard is desired. The . character will not match the new line character \n, which may be present in a binary qualifier.

Parameters:

  • regex (String) —

    Regex to match column qualifier name.

Returns:



138
139
140
141
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 138

def qualifier regex
  @grpc.column_qualifier_regex_filter = regex
  self
end

#sample(probability) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.

Parameters:

  • probability (Float)

Returns:



103
104
105
106
107
108
109
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 103

def sample probability
  if probability >= 1 || probability <= 0
    raise RowFilterError, "Probability must be greater than 0 and less than 1.0."
  end
  @grpc.row_sample_filter = probability
  self
end

#sink ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Outputs all cells directly to the output of the read rather than to any parent filter.

Returns:



39
40
41
42
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 39

def sink
  @grpc.sink = true
  self
end

#strip_value ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Replaces each cell's value with an empty string.

Returns:



71
72
73
74
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 71

def strip_value
  @grpc.strip_value_transformer = true
  self
end

#timestamp_range(from, to) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Creates a timestamp-range filter.

Matches only cells with timestamps within the given range. Specifies a contiguous range of timestamps.

Parameters:

  • from (Integer) —

    Inclusive lower bound. If left empty, interpreted as 0.

  • to (Integer) —

    Exclusive upper bound. If left empty, interpreted as infinity.

Returns:



232
233
234
235
236
237
238
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 232

def timestamp_range from, to
  range_grpc = Google::Bigtable::V2::TimestampRange.new
  range_grpc.start_timestamp_micros = from if from
  range_grpc.end_timestamp_micros = to if to
  @grpc.timestamp_range_filter = range_grpc
  self
end

#value(regex) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only cells with values that satisfy the given regular expression. Note that, since cell values can contain arbitrary bytes, the \C escape sequence must be used if a true wildcard is desired. The . character will not match the new line character \n, which may be present in a binary value.

Parameters:

  • regex (String) —

    Regex to match cell value.

Returns:



153
154
155
156
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 153

def value regex
  @grpc.value_regex_filter = regex
  self
end

#value_range(range) ⇒ Google::Cloud::Bigtable::RowFilter::SimpleFilter

Matches only cells with values that fall within the given range.

See ValueRange#from and { Google::Cloud::Bigtable::ValueRange#to} for range option inclusive/exclusive options

  • The value at which to start the range. If neither field is set, interpreted as an empty string, inclusive.
  • The value at which to end the range. If neither field is set, interpreted as an infinite string, exclusive.

Parameters:

Returns:



253
254
255
256
257
258
259
 
# File 'lib/google/cloud/bigtable/row_filter/simple_filter.rb', line 253

def value_range range
  unless range.instance_of? Google::Cloud::Bigtable::ValueRange
    raise RowFilterError, "Range type mustbe ValueRange"
  end
  @grpc.value_range_filter = range.to_grpc
  self
end