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

用語クエリを使用して、指定したフィールドの値と完全に一致するデータをクエリできます。用語クエリは、文字列一致条件に基づくクエリに似ています。列の型が TEXT の場合、Tablestore は文字列をトークン化し、トークンを使用してキーワードを照合します。行内のトークンの少なくとも 1 つがキーワードと完全に一致する場合、行はクエリ条件を満たします。用語クエリを実行するときに列の値を照合するために使用されるキーワードはトークン化されません。

前提条件

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

パラメーター

パラメーター	説明
tableName	データテーブルの名前。
indexName	検索インデックスの名前。
offset	現在のクエリが開始される位置。
limit	現在のクエリで返される行の最大数。特定のデータなしで、クエリ条件を満たす行の数のみをクエリするには、limit パラメーターを 0 に設定します。
queryType	クエリタイプ。このパラメーターを TableStore.QueryType.TERM_QUERY に設定します。
fieldName	クエリする列の名前。
term	用語クエリを実行するときに列の値を照合するために使用されるキーワード。この単語はトークン化されません。代わりに、単語全体が列値の照合に使用されます。列の型が TEXT の場合、Tablestore は文字列をトークン化し、トークンを使用してキーワードを照合します。行内のトークンの少なくとも 1 つがキーワードと完全に一致する場合、行はクエリ条件を満たします。たとえば、行の TEXT 型の列の値が "tablestore is cool" の場合、値は "tablestore"、"is"、および "cool" にトークン化できます。列の値を照合するためのキーワードとして "tablestore"、"is"、または "cool" を指定すると、行はクエリ条件を満たします。
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" と完全に一致する行をテーブルから検索します。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータなしで、クエリ条件を満たす行の数のみをクエリするには、limit パラメーターを 0 に設定します。
        query: { // クエリタイプを TableStore.QueryType.TERM_QUERY に設定します。
            queryType: TableStore.QueryType.TERM_QUERY,
            query: {
                fieldName: "Col_Keyword",
                term: "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 オペレーションを呼び出して並列スキャン機能を使用できます。詳細については、並列スキャンを参照してください。