Tablestore:フィルターの使用

単一列の値フィルター

SingleColumnValueFilter のコンストラクターには、以下のパラメーターが含まれています。

正規表現フィルター

SingleColumnValueRegexFilter のコンストラクターには、次のパラメーターが含まれています。 正規表現ルールを指定する場合、対象の属性列は String 型である必要があります。

複合フィルター

CompositeColumnValueFilter のコンストラクターとサブフィルターリストには、次のパラメーターが含まれています。addFilter() を呼び出してサブフィルターを追加します。複合フィルターは、最大 32 個のサブ条件をサポートします。

属性列のページネーションフィルター

ColumnPaginationFilter のコンストラクターには、次のパラメーターが含まれています。offset が省略された場合、デフォルト値は 0 です。

正規表現で抽出した部分文字列の比較

列の値から部分文字列を抽出し、その部分文字列をターゲット値と比較するには、RegexRule を使用します。 次の例では、col2 に正規表現 1([a-z]+)5 を適用し、最初のグループをキャプチャして、文字列 aaa と比較します。

RangeRowQueryCriteria criteria = new RangeRowQueryCriteria("filter_demo");

PrimaryKeyBuilder startBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
startBuilder.addPrimaryKeyColumn("id", PrimaryKeyValue.fromString("row1"));
criteria.setInclusiveStartPrimaryKey(startBuilder.build());

PrimaryKeyBuilder endBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
endBuilder.addPrimaryKeyColumn("id", PrimaryKeyValue.INF_MAX);
criteria.setExclusiveEndPrimaryKey(endBuilder.build());

criteria.setMaxVersions(1);

// 正規表現 "1([a-z]+)5" は最初のグループをキャプチャします。castType=VT_STRING は結果を文字列として比較します。
RegexRule regexRule = new RegexRule("1([a-z]+)5", RegexRule.CastType.VT_STRING);
SingleColumnValueRegexFilter filter = new SingleColumnValueRegexFilter(
        "col2",
        regexRule,
        SingleColumnValueRegexFilter.CompareOperator.EQUAL,
        ColumnValue.fromString("aaa"));
criteria.setFilter(filter);

GetRangeResponse response = client.getRange(new GetRangeRequest(criteria));
System.out.println("Matched rows: " + response.getRows().size());

論理演算子による複数フィルターの組み合わせ

複数のフィルターを論理演算子で組み合わせるには、CompositeColumnValueFilter を使用します。 複合フィルターはネストできます。 次の例では、条件 (col1 == "val1" OR cast<String>(reg(col2)) >= "aaa") AND col3 == "val3" を構築します。

RangeRowQueryCriteria criteria = new RangeRowQueryCriteria("filter_demo");

PrimaryKeyBuilder startBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
startBuilder.addPrimaryKeyColumn("id", PrimaryKeyValue.fromString("row1"));
criteria.setInclusiveStartPrimaryKey(startBuilder.build());

PrimaryKeyBuilder endBuilder = PrimaryKeyBuilder.createPrimaryKeyBuilder();
endBuilder.addPrimaryKeyColumn("id", PrimaryKeyValue.INF_MAX);
criteria.setExclusiveEndPrimaryKey(endBuilder.build());

criteria.setMaxVersions(1);

// リーフ 1: col1 == "val1"
SingleColumnValueFilter leaf1 = new SingleColumnValueFilter(
        "col1",
        SingleColumnValueFilter.CompareOperator.EQUAL,
        ColumnValue.fromString("val1"));

// リーフ 2: cast<String>(reg(col2)) >= "aaa"
RegexRule regexRule = new RegexRule("1([a-z]+)5", RegexRule.CastType.VT_STRING);
SingleColumnValueRegexFilter leaf2 = new SingleColumnValueRegexFilter(
        "col2",
        regexRule,
        SingleColumnValueRegexFilter.CompareOperator.GREATER_EQUAL,
        ColumnValue.fromString("aaa"));

// OR の組み合わせ: リーフ 1 OR リーフ 2
CompositeColumnValueFilter orFilter = new CompositeColumnValueFilter(
        CompositeColumnValueFilter.LogicOperator.OR);
orFilter.addFilter(leaf1);
orFilter.addFilter(leaf2);

// リーフ 3: col3 == "val3"
SingleColumnValueFilter leaf3 = new SingleColumnValueFilter(
        "col3",
        SingleColumnValueFilter.CompareOperator.EQUAL,
        ColumnValue.fromString("val3"));

// AND の組み合わせ: (リーフ 1 OR リーフ 2) AND リーフ 3
CompositeColumnValueFilter andFilter = new CompositeColumnValueFilter(
        CompositeColumnValueFilter.LogicOperator.AND);
andFilter.addFilter(orFilter);
andFilter.addFilter(leaf3);

criteria.setFilter(andFilter);

GetRangeResponse response = client.getRange(new GetRangeRequest(criteria));
System.out.println("Matched rows: " + response.getRows().size());

欠損列と履歴バージョンの評価の制御

setPassIfMissing は対象列を含まない行が返されるかどうかを制御し、setLatestVersionsOnly は履歴バージョンも評価されるかどうかを制御します。

SingleColumnValueFilter filter = new SingleColumnValueFilter(
        "col1",
        SingleColumnValueFilter.CompareOperator.EQUAL,
        ColumnValue.fromString("val1"));

// col1 を含まない行をスキップします (デフォルト：そのような行を含める)。
filter.setPassIfMissing(false);
// すべてのバージョンを評価し、いずれかのバージョンが一致すれば行を返します (デフォルト：最新バージョンのみを評価)。
filter.setLatestVersionsOnly(false);

criteria.setFilter(filter);

属性列のページ取得

ColumnPaginationFilter を使用して、オフセットから始まる指定された数の属性列を返します。次の例では、最初の属性列をスキップし、次の 2 つの属性列を返します。

PrimaryKey primaryKey = PrimaryKeyBuilder.createPrimaryKeyBuilder()
        .addPrimaryKeyColumn("id", PrimaryKeyValue.fromString("row1"))
        .build();

SingleRowQueryCriteria criteria = new SingleRowQueryCriteria("filter_demo", primaryKey);
criteria.setMaxVersions(1);
criteria.setFilter(new ColumnPaginationFilter(2, 1));

GetRowResponse response = client.getRow(new GetRowRequest(criteria));
for (Column column : response.getRow().getColumns()) {
    System.out.println(column.getName());
}