スカラー検索は、オブジェクトのメタデータを使用して、バケット内の多数のオブジェクトからオブジェクト名、ETag、ストレージタイプ、サイズ、最終更新日時などの特定の条件を満たすオブジェクトをすばやく見つけるのに役立つ OSS インデックス機能です。このトピックでは、PHP SDK V2 を使用してスカラー検索を実行する方法について説明します。
注意事項
このトピックのサンプルコードでは、中国 (杭州) リージョン ID
cn-hangzhouを例として使用しています。デフォルトでは、パブリックエンドポイントが使用されます。同じリージョン内の他の Alibaba Cloud サービスから OSS にアクセスする場合は、内部エンドポイントを使用できます。OSS がサポートするリージョンとエンドポイント間のマッピングの詳細については、「OSS のリージョンとエンドポイント」をご参照ください。このトピックでは、環境変数からアクセス資格情報を読み取る方法の例を示します。アクセス資格情報の設定方法のその他の例については、「アクセス資格情報の設定」をご参照ください。
PHP SDK を使用して OSS リクエストを送信するには、OSSClient を初期化する必要があります。このトピックでは、デフォルト設定を使用して OSSClient を作成する方法の例を示します。クライアントの設定方法のその他の例については、「クライアントの設定」をご参照ください。
サンプルコード
スカラー検索機能の有効化
次のコードは、バケットのスカラー検索機能を有効にする方法の例を示しています。この機能を有効にすると、OSS はバケットのメタデータインデックスを作成し、バケット内のすべてのオブジェクトのメタデータインデックスを作成します。メタデータインデックスが作成された後、OSS はバケット内の新しいファイルに対してほぼリアルタイムの増分追跡とスキャンを実行し、新しいファイルのメタデータインデックスを作成します。
<?php
// 依存関係ライブラリが正しくロードされるように、オートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// コマンドライン引数の説明を定義します。
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 他のサービスが OSS へのアクセスに使用できるエンドポイント。このパラメーターはオプションです。
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// コマンドライン引数を解析します。
$options = getopt("", $longopts);
// 必須の引数が指定されているかどうかを確認します。
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 引数のヘルプ情報を取得します。
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 必須の引数が指定されていない場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
// 環境変数から資格情報情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// SDK のデフォルト設定を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 資格情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}
// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);
// OpenMetaQueryRequest オブジェクトを作成して、バケットのスカラー検索機能を有効にします。
$request = new Oss\Models\OpenMetaQueryRequest(
bucket: $bucket
);
// スカラー検索機能を有効にする操作を実行します。
$result = $client->openMetaQuery($request);
// スカラー検索機能を有効にした結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 はリクエストが成功したことを示します。
'request id:' . $result->requestId . PHP_EOL // リクエスト ID。リクエストのデバッグまたは追跡に使用されます。
);
メタデータインデックスライブラリ情報の取得
次のコードは、指定されたバケットのメタデータインデックス情報を取得する方法の例を示しています。
<?php
// 依存関係ライブラリが正しくロードされるように、オートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// コマンドライン引数の説明を定義します。
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 他のサービスが OSS へのアクセスに使用できるエンドポイント。このパラメーターはオプションです。
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// コマンドライン引数を解析します。
$options = getopt("", $longopts);
// 必須の引数が指定されているかどうかを確認します。
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 引数のヘルプ情報を取得します。
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 必須の引数が指定されていない場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
// 環境変数から資格情報情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// SDK のデフォルト設定を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 資格情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}
// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);
// GetMetaQueryStatusRequest オブジェクトを作成して、バケットのメタデータクエリステータスを取得します。
$request = new Oss\Models\GetMetaQueryStatusRequest(
bucket: $bucket
);
// メタデータクエリステータスを取得する操作を実行します。
$result = $client->getMetaQueryStatus($request);
// メタデータクエリステータスを取得した結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 はリクエストが成功したことを示します。
'request id:' . $result->requestId . PHP_EOL . // リクエスト ID。リクエストのデバッグまたは追跡に使用されます。
'meta query status:' . var_export($result->metaQueryStatus, true) . PHP_EOL // メタデータクエリ機能のステータス (有効または無効など)。
);
指定された条件を満たすオブジェクトのクエリ
次のコードは、スカラー検索機能を使用して指定された条件を満たすオブジェクトをクエリし、指定されたフィールドとソート方法に基づいてオブジェクト情報をリストする方法の例を示しています。
<?php
// 依存関係ライブラリが正しくロードされるように、オートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// コマンドライン引数の説明を定義します。
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 他のサービスが OSS へのアクセスに使用できるエンドポイント。このパラメーターはオプションです。
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// コマンドライン引数を解析します。
$options = getopt("", $longopts);
// 必須の引数が指定されているかどうかを確認します。
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 引数のヘルプ情報を取得します。
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 必須の引数が指定されていない場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
// 環境変数から資格情報情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// SDK のデフォルト設定を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 資格情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}
// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);
// DoMetaQueryRequest オブジェクトを作成して、メタデータクエリ操作を実行します。
$request = new \AlibabaCloud\Oss\V2\Models\DoMetaQueryRequest(
bucket: $bucket,
metaQuery: new \AlibabaCloud\Oss\V2\Models\MetaQuery(
maxResults: 5, // 返される結果の最大数。
query: "{'Field': 'Size','Value': '1048576','Operation': 'gt'}", // クエリ条件: サイズが 1 MB を超えるオブジェクト。
sort: 'Size', // オブジェクトサイズでソートします。
order: \AlibabaCloud\Oss\V2\Models\MetaQueryOrderType::ASC, // 昇順でソートします。
aggregations: new \AlibabaCloud\Oss\V2\Models\MetaQueryAggregations( // 集約操作
aggregations: [
new \AlibabaCloud\Oss\V2\Models\MetaQueryAggregation(
field: 'Size', // オブジェクトサイズフィールド。
operation: 'sum' // 集約操作: 合計。
),
new \AlibabaCloud\Oss\V2\Models\MetaQueryAggregation(
field: 'Size', // オブジェクトサイズフィールド。
operation: 'max' // 集約操作: 最大値。
),
]
)
)
);
// メタデータクエリ操作を実行します。
$result = $client->doMetaQuery($request);
// メタデータクエリの結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 はリクエストが成功したことを示します。
'request id:' . $result->requestId . PHP_EOL . // リクエスト ID。リクエストのデバッグまたは追跡に使用されます。
'result:' . var_export($result, true) . PHP_EOL // クエリ結果。一致したオブジェクトとその集約データが含まれます。
);
スカラー検索機能の無効化
次のコードは、指定されたバケットのスカラー検索機能を無効にする方法の例を示しています。
<?php
// 依存関係ライブラリが正しくロードされるように、オートローダーファイルをインポートします。
require_once __DIR__ . '/../vendor/autoload.php';
use AlibabaCloud\Oss\V2 as Oss;
// コマンドライン引数の説明を定義します。
$optsdesc = [
"region" => ['help' => 'The region in which the bucket is located.', 'required' => True], // バケットが配置されているリージョン。このパラメーターは必須です。
"endpoint" => ['help' => 'The domain names that other services can use to access OSS.', 'required' => False], // 他のサービスが OSS へのアクセスに使用できるエンドポイント。このパラメーターはオプションです。
"bucket" => ['help' => 'The name of the bucket', 'required' => True], // バケットの名前。このパラメーターは必須です。
];
// 引数の説明を getopt で必要なロングオプション形式に変換します。
// 各引数の後のコロン (:) は、引数に値が必要であることを示します。
$longopts = \array_map(function ($key) {
return "$key:";
}, array_keys($optsdesc));
// コマンドライン引数を解析します。
$options = getopt("", $longopts);
// 必須の引数が指定されているかどうかを確認します。
foreach ($optsdesc as $key => $value) {
if ($value['required'] === True && empty($options[$key])) {
$help = $value['help']; // 引数のヘルプ情報を取得します。
echo "Error: the following arguments are required: --$key, $help" . PHP_EOL;
exit(1); // 必須の引数が指定されていない場合は、プログラムを終了します。
}
}
// 解析された引数から値を抽出します。
$region = $options["region"]; // バケットが配置されているリージョン。
$bucket = $options["bucket"]; // バケットの名前。
// 環境変数から資格情報情報をロードします。
// EnvironmentVariableCredentialsProvider を使用して、環境変数から Access Key ID と Access Key Secret を読み取ります。
$credentialsProvider = new Oss\Credentials\EnvironmentVariableCredentialsProvider();
// SDK のデフォルト設定を使用します。
$cfg = Oss\Config::loadDefault();
$cfg->setCredentialsProvider($credentialsProvider); // 資格情報プロバイダーを設定します。
$cfg->setRegion($region); // バケットが配置されているリージョンを設定します。
if (isset($options["endpoint"])) {
$cfg->setEndpoint($options["endpoint"]); // エンドポイントが指定されている場合は、エンドポイントを設定します。
}
// OSS クライアントインスタンスを作成します。
$client = new Oss\Client($cfg);
// CloseMetaQueryRequest オブジェクトを作成して、バケットの検索機能を無効にします。
$request = new \AlibabaCloud\Oss\V2\Models\CloseMetaQueryRequest(
bucket: $bucket
);
// 検索機能を無効にする操作を実行します。
$result = $client->closeMetaQuery($request);
// 検索機能を無効にした結果を出力します。
printf(
'status code:' . $result->statusCode . PHP_EOL . // HTTP ステータスコード。たとえば、200 はリクエストが成功したことを示します。
'request id:' . $result->requestId . PHP_EOL // リクエスト ID。リクエストのデバッグまたは追跡に使用されます。
);