Class: Google::Cloud::Bigtable::RowFilter::InterleaveFilter

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

Overview

InterleaveFilter

A RowFilter that sends each row to each of several component RowFilters and interleaves the results.

The elements of "filters" all process a copy of the input row, and the results are pooled, sorted, and combined into a single output row. If multiple cells are produced with the same column and timestamp, they will all appear in the output row in an unspecified mutual order. Consider the following example, with three filters:

                             input row
                                 |
       -----------------------------------------------------
       |                         |                         |
      f(0)                      f(1)                      f(2)
       |                         |                         |
1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
       |                         |                         |
       -----------------------------------------------------
                                 |
1:                      foo,bar,10,z   # could have switched with #2
2:                      foo,bar,10,x   # could have switched with #1
3:                      foo,blah,11,z
4:                      far,bar,7,a
5:                      far,blah,5,x   # identical to #6
6:                      far,blah,5,x   # identical to #5

All interleaved filters are executed atomically.

Examples:

Create an interleave filter with a simple filter.


interleave = Google::Cloud::Bigtable::RowFilter.interleave

# Add filters to interleave filter
interleave.key("user-*")
interleave.sink

# OR
interleave.key("user-*").sink

Create a complex interleave filter.


interleave = Google::Cloud::Bigtable::RowFilter.interleave

chain_1 = Google::Cloud::Bigtable::RowFilter.chain
chain_1.label("users").qualifier("name").cells_per_row(5)

# Add to main chain filter
interleave.chain(chain_1).value("xyz*").key("user-*")

Instance Method Summary collapse

Instance Method Details

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

Adds a block-all filter instance.

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

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.block

Returns:



225
226
227
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 225

def block
  add RowFilter.block
end

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

Adds a cells-per-column filter instance.

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.

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_column(5)

Parameters:

  • limit (String) —

    Max cell match per column limit

Returns:



464
465
466
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 464

def cells_per_column limit
  add RowFilter.cells_per_column(limit)
end

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

Adds a cells-per-row-limit filter instance.

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.

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row(5)

Parameters:

  • limit (String) —

    Max cell match per row limit

Returns:



442
443
444
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 442

def cells_per_row limit
  add RowFilter.cells_per_row(limit)
end

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

Adds a cell-per-row-offset filter instance to skip the first N cells.

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.

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.cells_per_row_offset(3)

Parameters:

  • offset (Integer) —

    Offset value.

Returns:



423
424
425
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 423

def cells_per_row_offset offset
  add RowFilter.cells_per_row_offset(offset)
end

#chain(filter) ⇒ Google::Cloud::Bigtable::RowFilter::InterleaveFilter

Adds a chain filter instance.

A Chain RowFilter that sends rows through several RowFilters in sequence.

See Google::Cloud::Bigtable::RowFilter::InterleaveFilter.

The elements of "filters" are chained together to process the input row: in row -> f(0) -> intermediate row -> f(1) -> ... -> f(N) -> out row The full chain is executed atomically.

Examples:

Create a chain filter and add an interleave filter.


chain = Google::Cloud::Bigtable::RowFilter.chain

# Add filters to chain filter
chain.key("user-*").cells_per_row(5)

filter = Google::Cloud::Bigtable::RowFilter.interleave.chain(chain)

Parameters:

Returns:

Raises:



106
107
108
109
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 106

def chain filter
  raise RowFilterError, "Filter type must be ChainFilter" unless filter.instance_of? ChainFilter
  add filter
end

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

Adds a column-range filter instance.

Matches only cells from columns within the given range.

Examples:

require "google/cloud/bigtable"

range = Google::Cloud::Bigtable::ColumnRange.new("cf").from("field0").to("field5")

filter = Google::Cloud::Bigtable::RowFilter.interleave.column_range(range)

Parameters:

Returns:



547
548
549
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 547

def column_range range
  add RowFilter.column_range(range)
end

#condition(filter) ⇒ Google::Cloud::Bigtable::RowFilter::InterleaveFilter

Adds a condition filter instance.

A RowFilter that evaluates one of two possible RowFilters, depending on whether or not a predicate RowFilter outputs any cells from the input row.

IMPORTANT NOTE: The predicate filter does not execute atomically with the true and false filters, which may lead to inconsistent or unexpected results. Additionally, condition filters have poor performance, especially when filters are set for the false condition.

Cannot be used within the predicate_filter, true_filter, or false_filter.

Examples:


predicate = Google::Cloud::Bigtable::RowFilter.key("user-*")

label = Google::Cloud::Bigtable::RowFilter.label("user")
strip_value = Google::Cloud::Bigtable::RowFilter.strip_value

condition_filter = Google::Cloud::Bigtable::RowFilter.
  condition(predicate).on_match(label).otherwise(strip_value)

filter = Google::Cloud::Bigtable::RowFilter.interleave.condition(condition_filter)

Parameters:

Returns:

Raises:



190
191
192
193
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 190

def condition filter
  raise RowFilterError, "Filter type must be ConditionFilter" unless filter.instance_of? ConditionFilter
  add filter
end

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

Adds a family-name-match filter using a regular expression.

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.

For Regex syntax:

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.family("cf-*")

Parameters:

  • regex (String) —

    Regex to match family name.

Returns:

See Also:

  • Google::Cloud::Bigtable::RowFilter::InterleaveFilter.https:https:#githubhttps:#github.com/google/re2/wiki/Syntax


327
328
329
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 327

def family regex
  add RowFilter.family(regex)
end

#filters ⇒ Array<SimpleFilter|ChainFilter|InterleaveFilter|ConditionFilter>

Returns a frozen copy of the filters array.

Returns:



570
571
572
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 570

def filters
  @filters.dup.freeze
end

#interleave(filter) ⇒ Google::Cloud::Bigtable::RowFilter::InterleaveFilter

Adds an interleave filter.

A RowFilter that sends each row to each of several component RowFilters and interleaves the results.

The elements of "filters" all process a copy of the input row, and the results are pooled, sorted, and combined into a single output row. If multiple cells are produced with the same column and timestamp, they will all appear in the output row in an unspecified mutual order. Consider the following example, with three filters:

                             input row
                                 |
       -----------------------------------------------------
       |                         |                         |
      f(0)                      f(1)                      f(2)
       |                         |                         |
1: foo,bar,10,x             foo,bar,10,z              far,bar,7,a
2: foo,blah,11,z            far,blah,5,x              far,blah,5,x
       |                         |                         |
       -----------------------------------------------------
                                 |
1:                      foo,bar,10,z   # could have switched with #2
2:                      foo,bar,10,x   # could have switched with #1
3:                      foo,blah,11,z
4:                      far,bar,7,a
5:                      far,blah,5,x   # identical to #6
6:                      far,blah,5,x   # identical to #5

All interleaved filters are executed atomically.

Examples:

Add an interleave filter to a chain filter.


interleave = Google::Cloud::Bigtable::RowFilter.interleave

# Add filters to an interleave filter.
interleave.key("user-*").cells_per_column(3)

filter = Google::Cloud::Bigtable::RowFilter.interleave.interleave(interleave)

Parameters:

Returns:

Raises:



156
157
158
159
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 156

def interleave filter
  raise RowFilterError, "Filter type must be InterleaveFilter" unless filter.instance_of? InterleaveFilter
  add filter
end

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

Adds a row-key filter instance to match key using a regular expression.

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:

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.key("user-*")

Parameters:

  • regex (String) —

    Regex to match row keys.

Returns:

See Also:

  • Google::Cloud::Bigtable::RowFilter::InterleaveFilter.https:https:#githubhttps:#github.com/google/re2/wiki/Syntax


283
284
285
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 283

def key regex
  add RowFilter.key(regex)
end

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

Adds a label filter instance to apply a label based on the result of read rows.

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 which contains a 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.

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.label("user-detail")

Parameters:

  • value (String) —

    Label name

Returns:



404
405
406
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 404

def label value
  add RowFilter.label(value)
end

#length ⇒ Integer

Returns the number of filters in the interleave.

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.key("user-1*").label("user")
filter.length # 2

Returns:

  • (Integer) 


561
562
563
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 561

def length
  @filters.length
end

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

Adds a pass filter instance.

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

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.pass

Returns:



208
209
210
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 208

def pass
  add RowFilter.pass
end

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

Adds a column-qualifier-match filter using a regular expression.

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.

For Regex syntax:

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.qualifier("user-name*")

Parameters:

  • regex (String) —

    Regex to match column qualifier name.

Returns:

See Also:

  • Google::Cloud::Bigtable::RowFilter::InterleaveFilter.https:https:#githubhttps:#github.com/google/re2/wiki/Syntax


352
353
354
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 352

def qualifier regex
  add RowFilter.qualifier(regex)
end

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

Adds a sample-probability filter instance.

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

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.sample(0.5)

Parameters:

  • probability (Float) —

    Probability value Probability must be greather then 0 and less then 1.0

Returns:



302
303
304
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 302

def sample probability
  add RowFilter.sample(probability)
end

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

Adds a sink filter instance.

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

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.sink

Returns:



241
242
243
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 241

def sink
  add RowFilter.sink
end

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

Adds a strip-value filter instance.

Replaces each cell's value with an empty string.

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.strip_value

Returns:



257
258
259
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 257

def strip_value
  add RowFilter.strip_value
end

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

Adds a timestamp-range filter instance.

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

Examples:


timestamp_micros = (Time.now.to_f * 1000000).round(-3)
from = timestamp_micros - 300000000
to = timestamp_micros

filter = Google::Cloud::Bigtable::RowFilter.interleave.timestamp_range(from: from, to: to)

Parameters:

  • from (Integer) (defaults to: nil) —

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

  • to (Integer) (defaults to: nil) —

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

Returns:



489
490
491
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 489

def timestamp_range from: nil, to: nil
  add RowFilter.timestamp_range(from: from, to: to)
end

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

Adds a value-match filter using a regular expression.

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.

For Regex syntax:

Examples:


filter = Google::Cloud::Bigtable::RowFilter.interleave.value("abc*")

Parameters:

  • regex (String) —

    Regex to match cell value.

Returns:

See Also:

  • Google::Cloud::Bigtable::RowFilter::InterleaveFilter.https:https:#githubhttps:#github.com/google/re2/wiki/Syntax


376
377
378
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 376

def value regex
  add RowFilter.value(regex)
end

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

Adds a value-range filter instance.

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.

Examples:

Start to end range

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new
table = bigtable.table("my-instance", "my-table")

range = table.new_value_range.from("value-001").to("value-005")
filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range(range)

Start exlusive to infinite end range

require "google/cloud/bigtable"

bigtable = Google::Cloud::Bigtable.new
table = bigtable.table("my-instance", "my-table")

range = table.new_value_range.from("value-001", inclusive: false)
filter = Google::Cloud::Bigtable::RowFilter.interleave.value_range(range)

Parameters:

Returns:



527
528
529
 
# File 'lib/google/cloud/bigtable/row_filter/interleave_filter.rb', line 527

def value_range range
  add RowFilter.value_range(range)
end