Skip to main content

in

The in match filter returns rows that contain a match of one or more specified values.

Syntax#

columnName in valueList
  • columnName - the column the filter will search for matching values.
  • valueList - the set of values to match on. This supports:
    • a comma-separated list of values: A in X, Y, Z. The filter will return true for all rows where the value in column A is equal to X, Y, or Z.
    • a java array: A in X. The filter will return true for all rows where A is equal to at least one element of the java array X.
    • a java.util.Collection: A in X. The filter will return true for all rows where A is equal to at least one element of the collection X.
    • all other types: A in X. The filter will return true for all rows where A is equal to X.

Examples#

The following example returns rows where Color is in a comma-separated list of values.

from deephaven.TableTools import newTable, stringCol, intColfrom deephaven.conversion_utils import NULL_INT
source = newTable(    stringCol("Letter", "A", "C", "F", "B", "E", "D", "A"),    intCol("Number", NULL_INT, 2, 1, NULL_INT, 4, 5, 3),    stringCol("Color", "red", "blue", "orange", "purple", "yellow", "pink", "blue"),    intCol("Code", 12, 13, 11, NULL_INT, 16, 14, NULL_INT),)
result = source.where("Color in `blue`, `orange`")

The following example returns rows where Number is in an array of values.

from deephaven.TableTools import newTable, stringCol, intColfrom deephaven.conversion_utils import NULL_INT
array = [2, 4, 6]
source = newTable(    stringCol("Letter", "A", "C", "F", "B", "E", "D", "A"),    intCol("Number", NULL_INT, 2, 1, NULL_INT, 4, 5, 3),    stringCol("Color", "red", "blue", "orange", "purple", "yellow", "pink", "blue"),    intCol("Code", 12, 13, 11, NULL_INT, 16, 14, NULL_INT),)
result = source.where("Number in array")

The following example returns rows where Number is in an array of values or Code is in an array of values.

from deephaven.TableTools import newTable, stringCol, intColfrom deephaven.conversion_utils import NULL_INT
numberArray = [2, 4, 6]codeArray = [10, 12, 14]

source = newTable(    stringCol("Letter", "A", "C", "F", "B", "E", "D", "A"),    intCol("Number", NULL_INT, 2, 1, NULL_INT, 4, 5, 3),    stringCol("Color", "red", "blue", "orange", "purple", "yellow", "pink", "blue"),    intCol("Code", 12, 13, 11, NULL_INT, 16, 14, NULL_INT),)
result = source.whereOneOf("Number in numberArray", "Code in codeArray")

The following example returns rows where Color is in a collection of values.

from deephaven.TableTools import newTable, stringCol, intColfrom deephaven.conversion_utils import NULL_INT
myList = ["pink", "purple", "blue"]
source = newTable(    stringCol("Letter", "A", "C", "F", "B", "E", "D", "A"),    intCol("Number", NULL_INT, 2, 1, NULL_INT, 4, 5, 3),    stringCol("Color", "red", "blue", "orange", "purple", "yellow", "pink", "blue"),    intCol("Code", 12, 13, 11, NULL_INT, 16, 14, NULL_INT),)
result = source.where("Color in myList")

Related documentation#