scroll搜尋Demo - OpenSearch

配置環境變數

配置環境變數ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET。

重要

阿里雲帳號AccessKey擁有所有API的存取權限，建議您使用RAM使用者進行API訪問或日常營運，具體操作，請參見建立RAM使用者。
建立AccessKey ID和AccessKey Secret，請參考建立AccessKey。
如果您使用的是RAM使用者的AccessKey，請確保主帳號已授權AliyunServiceRoleForOpenSearch服務關聯角色，請參考OpenSearch-行業演算法版服務關聯角色，相關文檔參考訪問鑒權規則。
請不要將AccessKey ID和AccessKey Secret儲存到工程代碼裡，否則可能導致AccessKey泄露，威脅您帳號下所有資源的安全。

Linux和macOS系統配置方法：
執行以下命令，其中， <access_key_id>需替換為您RAM使用者的AccessKey ID，<access_key_secret>替換為您RAM使用者的AccessKey Secret。
```
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 Secret。
2. 重啟Windows系統生效。

建立Config配置標頭檔

Config 頁面中的內容將作為後續的查詢推送文檔的標頭檔，其中包含AK，host，應用程式名稱，下拉名稱及 options 選項，等重要參數資訊

<?php
//引入標頭檔
require_once("../OpenSearch/Autoloader/Autoloader.php");
use OpenSearch\Client\OpenSearchClient;

// 使用者識別資訊
// 從環境變數讀取配置的AccessKey ID和AccessKey Secret，
// 運行程式碼範例前必須先配置環境變數，參考文檔上面“配置環境變數”步驟
// 替換對應的access key id
$accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');
//替換對應的access secret
$secret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
//替換為對應地區api訪問地址，可參考應用控制台,基本資料中api地址
$endPoint = '<region endPoint>';
//替換為應用程式名稱
$appName = '<app name>';
//替換為下拉提示名稱
$suggestName = '<suggest name>';
//開啟偵錯模式
$options = array('debug' => true);
//建立OpenSearchClient用戶端對象
$client = new OpenSearchClient($accessKeyId, $secret, $endPoint, $options);

開始scroll搜尋

下列展示了scroll的搜尋功能執行個體代碼

<?php
header("Content-Type:text/html;charset=utf-8");
//引入標頭檔
require_once("Config.inc.php");
use OpenSearch\Client\SearchClient;
use OpenSearch\Util\SearchParamsBuilder;

$searchClient = new SearchClient($client);
//建立參數對象，並指定對應參數
$params = new SearchParamsBuilder();
//設定每次scroll查詢召迴文檔數，無需設定start參數
$params->setHits(1);
//設定應用程式名稱
$params->setAppName('替換為應用程式名稱');
//設定查詢query
$params->setQuery("name:'搜尋'");
//設定返回格式為FULLJSON,目前scroll只支援返回JSON和FULLJSON格式
$params->setFormat("fulljson");

//V3 版 PHP SDK 中的 scroll查詢方法，只支援單欄位排序，且只能是int欄位類型，通常是設定主索引值進行生序或降序，設定該排序後，可以避免查詢期間因為資料發生變更而導致文檔排序發生變化出現重複召迴文檔
$params->addSort('id', SearchParamsBuilder::SORT_INCREASE);

//設定文檔過濾條件
$params->setFilter('id>0');

//設定需返回哪些欄位
$params->setFetchFields(array('id','name','phone','int_arr','literal_arr','float_arr','cate_id'));

//設定下次scroll發送請求逾時時間，用於scroll方法查詢，此處為第一次訪問，用於擷取scrollId
 $params->setScrollExpire('3m');
//執行查詢並返回資訊
$ret = $searchClient->execute($params->build())->result;

for($i=0;$i<json_decode($ret)->result->viewtotal;$i++){
    //通過上面第一次查詢返回的scrollId，作為查詢參數擷取資料
    $params->setScrollId(json_decode($ret)->result->scroll_id);
    //再次執行查詢並返回資訊
    $ret = $searchClient->execute($params->build())->result;
    //列印返回資訊的內容
    print_r($ret.'<br/><br/>');
}