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

OpenSearch:反復スクロールクエリの実装のためのデモコード

最終更新日:Dec 28, 2024

環境変数の設定

ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数を設定します。

重要
  • Alibaba CloudアカウントのAccessKeyペアは、すべてのAPI操作へのアクセスに使用できます。 API操作の呼び出しや日常的なO&Mの実行には、Resource Access Management (RAM) ユーザーを使用することをお勧めします。 RAMユーザーの使用方法については、RAMユーザーの作成 を参照してください。

  • AccessKeyペアの作成方法については、AccessKeyペアの作成 を参照してください。

  • RAMユーザーのAccessKeyペアを使用する場合は、Alibaba Cloudアカウントを使用して、必要な権限がAliyunServiceRoleForOpenSearchロールに付与されていることを確認してください。 詳細については、AliyunServiceRoleForOpenSearch および アクセス許可ルール を参照してください。

  • プロジェクトコードなど、他の人が簡単にアクセスできる資料にAccessKeyペアを含めないことをお勧めします。 そうしないと、AccessKeyペアが漏洩し、アカウント内のリソースが安全でなくなる可能性があります。

  • Linux および macOS

    次のコマンドを実行します。 <access_key_id> および <access_key_secret> を、使用するRAMユーザーのAccessKey IDとAccessKeyシークレットに置き換えます。

    export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id> 
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
  • Windows

    1. 環境変数ファイルを作成し、ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET 環境変数をファイルに追加し、環境変数をAccessKey IDとAccessKeyシークレットに設定します。

    2. AccessKeyペアを有効にするには、Windowsを再起動します。

OpenSearch SDK for Java V4.0.0 を使用した反復スクロールクエリの実装のためのデモコード

反復スクロールクエリを使用すると、各スクロールクエリにスクロールIDを指定する必要がなくなります。 スクロールクエリは、aggregate、distinct、またはrank句をサポートしておらず、単一のフィールドに基づくソートのみをサポートしています。

: ステータス情報ではなく、エラーコードとメッセージに基づいてエラーが発生したかどうかを判断します。 エラーの詳細については、エラーコード を参照してください。

OpenSearch SDK for Java が提供するデモコード

package com.aliyun.opensearch;

import com.aliyun.opensearch.sdk.dependencies.com.google.common.collect.Lists;
import com.aliyun.opensearch.sdk.generated.OpenSearch;
import com.aliyun.opensearch.sdk.generated.search.*;
import com.aliyun.opensearch.search.DeepPageingIterator;
import java.nio.charset.Charset;

public class testScrollIterator {

    // スクロールクエリは、aggregate、distinct、またはrank句をサポートしておらず、単一のフィールドに基づくソートのみをサポートしています。
    private static String appName = "管理するOpenSearchアプリケーションの名前";
    private static String tableName = "データをアップロードするテーブルの名前";
    private static String host = "お住まいの地域のOpenSearch APIのエンドポイント";


    public static void main(String[] args) {
      
      	// AccessKeyペアを指定します。
      	// 環境変数からAccessKey IDとAccessKeyシークレットを取得します。 サンプルコードを実行する前に、環境変数を設定する必要があります。
        String accesskey = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
        String secret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");

        // ファイルのエンコーディング形式とデフォルトのエンコーディング形式を取得します。
        System.out.println(String.format("file.encoding: %s", System.getProperty("file.encoding")));
        System.out.println(String.format("defaultCharset: %s", Charset.defaultCharset().name()));


        // OpenSearchオブジェクトを作成します。
        OpenSearch openSearch = new OpenSearch(accesskey, secret, host);

        // OpenSearchオブジェクトをパラメーターとして使用して、OpenSearchClientオブジェクトを作成します。
        OpenSearchClient serviceClient = new OpenSearchClient(openSearch);

        // OpenSearchClientオブジェクトをパラメーターとして使用して、SearcherClientオブジェクトを作成します。
        SearcherClient searcherClient = new SearcherClient(serviceClient);

        // Configオブジェクトを作成し、config句を使用して、アプリケーション名、ページング関連のパラメーター、返される結果のデータ形式などのパラメーターを設定します。
        Config config = new Config(Lists.newArrayList(appName));

        config.setStart(start); // config句で指定したstartパラメーターは、スクロールクエリには適用されません。 デフォルト値の0が使用されます。
        config.setHits(5);// 各ページに表示するドキュメントの数を指定します。 この例では、数は5に設定されています。

        // 返される結果のデータ形式を指定します。 サポートされている形式はJSONとFULLJSONです。 この例では、データ形式はFULLJSONに設定されています。
        config.setSearchFormat(SearchFormat.FULLJSON);

        // 検索結果に返されるフィールドを指定します。
        config.setFetchFields(Lists.newArrayList("id", "name", "phone", "int_arr", "literal_arr", "float_arr", "cate_id"));
        // 注:Configクラスのrerank_sizeパラメーターは、RankクラスのsetReRankSizeメソッドによって指定されます。

        // SearchParamsオブジェクトを作成します。
        SearchParams searchParams = new SearchParams(config);

        // query句を指定します。 複数のキーワードを指定して、複数のインデックスフィールドに基づいてクエリを実行できます。 この場合、1つのsetQuery呼び出しでインデックスフィールドを指定する必要があります。 各インデックスフィールドを個別のsetQuery呼び出しで指定すると、最後の句が前の句を上書きします。
        searchParams.setQuery("name:'opensearch'");

        // フィルター条件を指定します。
        searchParams.setFilter("cate_id<=3"); // SearchParamsBuilderクラスを使用してフィルター条件を設定することもできます。

       	// ソート条件を指定します。
        Sort sorter = new Sort();
        sorter.addToSortFields(new SortField("id", Order.DECREASE)); // ドキュメントのソート基準となるフィールドとソート方法を指定します。 この例では、ドキュメントはidフィールドに基づいて降順にソートされます。
 
         // Sortオブジェクトをクエリパラメーターとして追加します。
        searchParams.setSort(sorter);     
      
        // 反復スクロールクエリを実装するために、DeepPagingオブジェクトを作成します。
        DeepPaging deep =new DeepPaging();

        // DeepPagingオブジェクトをクエリパラメーターとして追加します。
        searchParams.setDeepPaging(deep);

        // DeepPageingIteratorクラスを使用して、反復スクロールクエリを実装します。 これにより、スクロールIDを指定する必要がなくなります。
        DeepPageingIterator pagesIterator = new DeepPageingIterator(searcherClient, searchParams);

        // 反復間隔をミリ秒単位で設定します。 デフォルトの間隔は100ミリ秒です。 これにより、ページング速度が適切になり、OpenSearchサービスに大きな負荷がかかりません。 必要に応じて反復間隔を設定できます。
        pagesIterator.setPagingIntervals(80); // 反復間隔(ミリ秒単位)。

        // ステータス情報ではなく、エラーコードとメッセージに基づいてエラーが発生したかどうかを判断します。 エラーの詳細については、「エラーコード」のトピックを参照してください。
        try{

            System.out.println("test");
            while (pagesIterator.hasNext()) {
                System.out.println("デバッグ情報:" + pagesIterator.next());
            }

        }catch(Exception ex){
            System.out.println("エラーメッセージ:" + ex.getMessage());
        }

    }
}