プレフィックスクエリの実行（Tablestore SDK for Node.jsを使用） - Tablestore

プレフィックスクエリを実行して、指定したプレフィックスに一致するデータをクエリできます。列のタイプがTEXTの場合、Tablestoreは文字列をトークン化し、トークンを使用してキーワードを照合します。行内の少なくとも1つのトークンが指定されたプレフィックスと一致する場合、行はクエリ条件を満たします。

前提条件

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

パラメータ

パラメータ	説明
tableName	データテーブルの名前。
indexName	検索インデックスの名前。
offset	現在のクエリの開始位置。
limit	現在のクエリで返す最大行数。特定のデータなしで、クエリ条件を満たす行数のみをクエリするには、limitパラメータを0に設定します。
queryType	クエリタイプ。このパラメータをTableStore.QueryType.PREFIX_QUERYに設定します。
fieldName	クエリする列の名前。
prefix	プレフィックスクエリを実行するときに、列の値と照合するために使用されるプレフィックス。列のタイプがTEXTの場合、Tablestoreは文字列をトークン化し、トークンを使用してキーワードを照合します。行内の少なくとも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列の値のプレフィックスが「hang」である行をクエリする方法の例を示しています。

/**
 * テーブルで、Col_Keywordの値に"hang"というプレフィックスが含まれる行（例："hangzhou"）を検索します。
 */
client.search({
    tableName: TABLE_NAME,
    indexName: INDEX_NAME,
    searchQuery: {
        offset: 0,
        limit: 10, // 特定のデータなしで、クエリ条件を満たす行数のみをクエリするには、limitパラメータを0に設定します。
        query: { // クエリタイプをTableStore.QueryType.PREFIX_QUERYに設定します。
            queryType: TableStore.QueryType.PREFIX_QUERY,
            query: {
                fieldName: "Col_Keyword",
                prefix: "hang" // プレフィックスを"hang"に設定して、"hangzhou"や"hangzhoushi"などの列値と照合します。
            }
        },
        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

参考資料

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