Node.js SDK for Tablestore を使用して一致クエリを実行する - Tablestore

一致クエリを使用して、おおよその一致に基づいてテーブル内のデータをクエリできます。Tablestore は、TEXT フィールドの値と、指定したアナライザータイプに基づいて一致クエリを実行するために使用するキーワードをトークン化します。このようにして、Tablestore はトークンに基づいて一致クエリを実行できます。あいまいなトークン化が使用される TEXT フィールドには、あいまいクエリで高パフォーマンスを確保するために、一致フレーズクエリを使用することをお勧めします。

前提条件

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

パラメーター

パラメーター	説明
tableName	データテーブルの名前。
indexName	検索インデックスの名前。
offset	現在のクエリの開始位置。
limit	現在のクエリで返される最大行数。特定のデータなしで、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。
queryType	クエリのタイプ。一致クエリを使用するには、このパラメーターを TableStore.QueryType.MATCH_QUERY に設定します。
fieldName	一致させるフィールドの名前。一致クエリは TEXT フィールドに適用されます。
text	一致クエリを実行するときにフィールドの値と一致させるために使用されるキーワード。一致させるフィールドが TEXT フィールドの場合、キーワードは、検索インデックスの作成時に指定したアナライザータイプに基づいて複数のトークンにトークン化されます。検索インデックスの作成時にアナライザータイプを指定しない場合は、単一単語トークン化が実行されます。たとえば、一致させるフィールドが TEXT フィールドで、アナライザータイプを単一単語トークン化に設定し、「this is」を検索キーワードとして使用する場合、「...、this is tablestore」、「is this tablestore」、「tablestore is cool」、「this」、「is」などのクエリ結果を取得できます。
operator	論理演算子。デフォルトでは、OR が論理演算子として使用されます。これは、フィールド値に少なくとも最小一致トークン数が含まれている場合、行がクエリ条件を満たすことを指定します。 operator パラメーターを AND に設定すると、フィールド値にすべての一致トークンが含まれている場合にのみ、行はクエリ条件を満たします。
minimumShouldMatch	フィールドの値に含まれる最小一致トークン数。行の fieldName パラメーターで指定されたフィールドの値に少なくとも最小一致トークン数が含まれている場合にのみ、行が返されます。説明 minimumShouldMatch パラメーターは、OR 論理演算子と一緒に使用する必要があります。
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」と一致する行をクエリする方法の例を示しています。

/**
 * テーブル内の Col_Keyword 列の値が「hangzhou」と一致する行をクエリします。Tablestore は、クエリ条件を満たす行の総数と、これらの行の一部に関する具体的なデータを返します。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータなしで、クエリ条件を満たす行数のみをクエリするには、limit パラメーターを 0 に設定します。
        query: { // クエリタイプを MatchQuery に設定します。
            queryType: TableStore.QueryType.MATCH_QUERY,
            query: {
                fieldName: "Col_Keyword", // 一致させるフィールドの名前を指定します。
                text: "hangzhou" // フィールドの値と一致させるために使用されるキーワードを指定します。
            }
        },
        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

参考資料

検索インデックスでは、次のクエリタイプがサポートされています。用語クエリ、複数用語クエリ、すべて一致クエリ、一致クエリ、一致フレーズクエリ、プレフィックスクエリ、範囲クエリ、ワイルドカードクエリ、ブールクエリ、地理クエリ、ネストされたクエリ、ベクトルクエリ、存在クエリ。ビジネス要件に基づいてクエリタイプを選択できます。
クエリ条件を満たす行をソートまたはページ分割する場合は、ソートおよびページ分割機能を使用できます。詳細については、ソートとページ分割を参照してください。
特定の列に基づいて結果セットを折りたたむ場合は、折りたたみ（重複排除）機能を使用できます。このようにして、指定されたタイプのデータはクエリ結果に一度だけ表示されます。詳細については、折りたたみ（重複排除）を参照してください。
データテーブルのデータ（極値、合計、行の総数など）を分析する場合は、集計操作を実行するか、SQL ステートメントを実行できます。詳細については、集計とSQL クエリを参照してください。
行をソートする必要なく、クエリ条件を満たすすべての行をすばやく取得する場合は、ParallelScan および ComputeSplits 操作を呼び出して並列スキャン機能を使用できます。詳細については、並列スキャンを参照してください。