すべてのプロダクト
Search
ドキュメントセンター

Tablestore:すべて一致クエリ

最終更新日:Dec 28, 2024

すべて一致クエリ機能を使用して、テーブル内のすべての行を照合し、テーブル内の行の総数をクエリしたり、複数のランダムな行を返したりできます。

前提条件

パラメーター

パラメーター

説明

tableName

データテーブルの名前。

indexName

検索インデックスの名前。

offset

現在のクエリが開始される位置。

limit

現在のクエリで返す行の最大数。

特定のデータなしで、クエリ条件を満たす行の数のみをクエリするには、limit パラメーターを 0 に設定します。

query

クエリのタイプ。すべて一致クエリを使用するには、このパラメーターを TableStore.QueryType.MATCH_ALL_QUERY に設定します。

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 に設定すると、プライマリキー列のみが返されます。

次のサンプルコードは、すべて一致クエリを使用してテーブル内の行の総数をクエリする方法の例を示しています。

/**
 * テーブル内の行の総数をクエリするために、すべて一致クエリを実行します。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータなしで、クエリ条件を満たす行の数のみをクエリするには、limit パラメーターを 0 に設定します。
        query: {
            queryType: TableStore.QueryType.MATCH_ALL_QUERY
        },
        getTotalCount: true // クエリ条件を満たす行の総数を返すかどうかを指定します。デフォルト値: false。
    },
    columnToGet: { // 返す列を指定します。このパラメーターを RETURN_SPECIFIED に設定して指定した列を返すか、RETURN_ALL に設定してすべての列を返すか、RETURN_ALL_FROM_INDEX に設定して検索インデックス内のすべての列を返すか、RETURN_NONE に設定してプライマリキー列のみを返すことができます。
        returnType: TableStore.ColumnReturnType.RETURN_SPECIFIED,
        returnNames: ["Col_1", "Col_2", "Col_3"]
    }
}, function (err, data) {
    if (err) {
        console.log('error:', err);
        return;
    }
    console.log('success:', JSON.stringify(data, null, 2));
});

FAQ

テーブル内の行の総数をクエリするにはどうすればよいですか?

参照