Node.js 用 Tablestore SDK を使用した terms クエリの実行 - Tablestore

Terms クエリは、term クエリに似ています。Terms クエリは複数のキーワードをサポートします。キーワードの少なくとも 1 つがフィールド値と完全に一致する場合、データ行が返されます。Terms クエリは、SQL ステートメントの IN 演算子と同じ方法で使用できます。

前提条件

OTSClient インスタンスが初期化されていること。詳細については、OTSClient インスタンスの初期化を参照してください。
データテーブルが作成され、データがデータテーブルに書き込まれていること。詳細については、データテーブルの作成およびデータの書き込みを参照してください。
データテーブルの検索インデックスが作成されていること。詳細については、検索インデックスの作成を参照してください。

パラメーター

パラメーター	説明
tableName	データテーブルの名前。
indexName	検索インデックスの名前。
offset	現在のクエリが開始される位置。
limit	現在のクエリで返される最大行数。特定のデータなしで、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。
queryType	クエリのタイプ。Terms クエリを使用するには、このパラメーターを TableStore.QueryType.TERMS_QUERY に設定します。
fieldName	一致させるフィールドの名前。
terms	Terms クエリを実行するときにフィールドの値と一致させるために使用されるキーワード。キーワードの少なくとも 1 つがフィールド値と完全に一致する場合、データ行が返されます。
getTotalCount	クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値：false。このパラメーターを true に設定すると、クエリのパフォーマンスが低下します。
columnToGet	クエリ条件を満たす各行のすべての列を返すかどうかを指定します。このパラメーターには、returnType と returnNames を設定できます。 returnType を TableStore.ColumnReturnType.RETURN_SPECIFIED に設定する場合は、returnNames を設定して返す列を指定する必要があります。 returnType パラメーターを TableStore.ColumnReturnType.RETURN_ALL に設定すると、すべての列が返されます。 returnType パラメーターを TableStore.ColumnReturnType.RETURN_ALL_FROM_INDEX に設定すると、検索インデックス内のすべての列が返されます。 returnType パラメーターを TableStore.ColumnReturnType.RETURN_NONE に設定すると、プライマリキー列のみが返されます。

例

次のサンプルコードは、Col_Keyword 列の値が「hangzhou」または「shanghai」と完全に一致する行をクエリする方法の例を示しています。

/**
 * Col_Keyword 列の値が "hangzhou" または "shanghai" と完全に一致する行をテーブルから検索します。
 * TermsQuery は複数の terms をサポートしています。少なくとも 1 つの term に一致するクエリ結果を取得できます。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータなしで、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。
        query: { // クエリタイプを TableStore.QueryType.TERMS_QUERY に設定します。
            queryType: TableStore.QueryType.TERMS_QUERY,
            query: {
                fieldName: "Col_Keyword",
                terms: ["hangzhou", "shanghai"]
            }
        },
        getTotalCount: true // クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値：false。
    },
    columnToGet: { // 返す列を指定します。パラメーターを RETURN_SPECIFIED に設定して指定した列を返すか、RETURN_ALL に設定してすべての列を返すか、RETURN_ALL_FROM_INDEX に設定して検索インデックス内のすべての列を返すか、RETURN_NONE に設定してプライマリキー列のみを返すことができます。
        returnType: TableStore.ColumnReturnType.RETURN_ALL
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

FAQ

参照

検索インデックスでは、次のクエリタイプがサポートされています。term クエリ、terms クエリ、match all クエリ、match クエリ、match phrase クエリ、prefix クエリ、range クエリ、wildcard クエリ、Boolean クエリ、geo クエリ、nested クエリ、ベクトルクエリ、exists クエリ。ビジネス要件に基づいてクエリタイプを選択してデータをクエリできます。
クエリ条件を満たす行をソートまたはページ分割する場合は、ソートおよびページング機能を使用できます。詳細については、ソートとページングを参照してください。
特定の列に基づいて結果セットを折りたたむ場合は、折りたたみ (重複排除) 機能を使用できます。このようにして、指定されたタイプのデータはクエリ結果に一度だけ表示されます。詳細については、折りたたみ (重複排除) を参照してください。
データテーブルのデータ (極値、合計、行の総数など) を分析する場合は、集計操作を実行するか、SQL ステートメントを実行できます。詳細については、集計および SQL クエリを参照してください。
行をソートする必要なく、クエリ条件を満たすすべての行をすばやく取得する場合は、ParallelScan および ComputeSplits 操作を呼び出して並列スキャン機能を使用できます。詳細については、並列スキャンを参照してください。