OTSClient は Tablestore のクライアントです。OTSClient は、テーブルの管理、単一行または複数行に対する読み取りおよび書き込み操作の実行に使用できるさまざまなメソッドを提供します。PHP SDK for Tablestore を使用してリクエストを開始するには、OTSClient インスタンスを初期化し、ビジネス要件に基づいて OTSClientConfig のデフォルト設定を変更する必要があります。
使用上の注意
HTTPS 経由で Tablestore リソースにアクセスする場合は、OpenSSL PHP 拡張機能をインストールする必要があります。
準備
OTSClient インスタンスを初期化する前に、Tablestore インスタンスのエンドポイントを取得し、Tablestore SDK for PHP をインストールし、アクセス認証情報を設定する必要があります。
Tablestore インスタンスのエンドポイントの取得
Tablestore インスタンスを作成した後、インスタンスのエンドポイントを取得する必要があります。その後、エンドポイントを使用してインスタンスにアクセスできます。
エンドポイントは、リージョン内の Tablestore インスタンスにアクセスするために使用されるドメイン名です。たとえば、https://sun.cn-hangzhou.ots.aliyuncs.com は、HTTPS 経由で中国 (杭州) リージョン内の sun という名前のインスタンスにアクセスするために使用されるパブリックエンドポイントです。詳細については、エンドポイント を参照してください。
Tablestore サービスがアクティブ化されていない場合は、アクティブ化します。詳細については、Tablestore のアクティブ化 を参照してください。
Tablestore インスタンスを作成します。詳細については、インスタンスの作成 を参照してください。
作成したインスタンスのエンドポイントを取得します。
Tablestore コンソール にログインします。
概要ページで、作成したインスタンスを見つけ、インスタンスの名前をクリックします。
インスタンスアクセス URL セクションの インスタンスの詳細 タブで、インスタンスのエンドポイントを表示します。
PHP SDK for Tablestore のインストールTablestore
アクセス認証情報の設定
OTSClient インスタンスの初期化
PHP SDK for Tablestore を使用するには、最初に OTSClient インスタンスを作成する必要があります。その後、OTSClient インスタンスの操作を呼び出して Tablestore にアクセスできます。
例
アクセスキーペアの使用
サンプルコードを実行する前に、OTS_AK_ENV および OTS_SK_ENV 環境変数が設定されていることを確認してください。詳細については、アクセス認証情報の設定 を参照してください。
// AccessKey ID と AccessKey Secret を環境変数から取得します。
$accessKeyId = getenv('OTS_AK_ENV');
$accessKeySecret = getenv('OTS_SK_ENV');
$otsClient = new Aliyun\OTS\OTSClient(array(
'EndPoint' => "<yourEndpoint>", // Tablestore インスタンスのエンドポイントを指定します。
'AccessKeyID' => $accessKeyId, // AccessKey ID を指定します。
'AccessKeySecret' => $accessKeySecret, // AccessKey Secret を指定します。
'InstanceName' => "<yourInstance>" // Tablestore インスタンス名を指定します。
));次の表にパラメーターを示します。
パラメーター | 例 | 説明 |
EndPoint | https://myinstance.cn-hangzhou.ots.aliyuncs.com | Tablestore インスタンスにアクセスするために使用されるエンドポイント。詳細については、Tablestore インスタンスのエンドポイントの取得 を参照してください。 |
AccessKeyID | getenv('OTS_AK_ENV') | 環境変数から取得したアクセスキーペア。環境変数が設定されていることを確認してください。 |
getenv('OTS_SK_ENV') | 環境変数から取得したアクセスキーペア。環境変数が設定されていることを確認してください。 | |
InstanceName | myinstance | インスタンスの名前。詳細については、インスタンス を参照してください。 |
ConnectionTimeout | 2.0 | Tablestore への接続に許容される最大レイテンシ（秒）。デフォルト値：2.0。 |
SocketTimeout | 2.0 | 各リクエストのレスポンスに許容される最大レイテンシ（秒）。デフォルト値：2.0。 大量のデータが転送される場合は、このパラメーターを大きな値に設定することをお勧めします。 |
RetryPolicy | DefaultRetryPolicy | 再試行ポリシー。デフォルト値：DefaultRetryPolicy。 再試行ポリシーを無効にするには、このパラメーターを null に設定します。 |
DebugLogHandler | defaultOTSDebugLogHandler | デバッグログを処理する関数。通常の要求と応答のログを表示するために使用されます。デフォルト値：defaultOTSDebugLogHandler。 この関数を無効にするには、このパラメーターを null に設定します。 |
ErrorLogHandler | defaultOTSErrorLogHandler | エラーログを処理する関数。Tablestore サーバーから返されたエラーのログを表示するために使用されます。デフォルト値：defaultOTSErrorLogHandler。 この関数を無効にするには、このパラメーターを null に設定します。 |
STS の使用
サンプルコードを実行する前に、OTS_AK_ENV、OTS_SK_ENV、および OTS_SESSION_TOKEN 環境変数が設定されていることを確認してください。詳細については、アクセス認証情報の設定 を参照してください。
// AccessKey ID、AccessKey Secret、Security Token を環境変数から取得します。
$accessKeyId = getenv('OTS_AK_ENV');
$accessKeySecret = getenv('OTS_SK_ENV');
$securityToken = getenv('OTS_SESSION_TOKEN');
$otsClient = new Aliyun\OTS\OTSClient(array(
'EndPoint' => "<yourEndpoint>", // Tablestore インスタンスのエンドポイントを指定します。
'AccessKeyID' => $accessKeyId, // AccessKey ID を指定します。
'AccessKeySecret' => $accessKeySecret, // AccessKey Secret を指定します。
'InstanceName' => "<yourInstance>", // Tablestore インスタンス名を指定します。
'StsToken' => $securityToken // セキュリティトークンを指定します。
));次の表にパラメーターを示します。
パラメーター | 例 | 説明 |
EndPoint | https://myinstance.cn-hangzhou.ots.aliyuncs.com | Tablestore インスタンスにアクセスするために使用されるエンドポイント。詳細については、Tablestore インスタンスのエンドポイントの取得 を参照してください。 |
AccessKeyID | getenv('OTS_AK_ENV') | 環境変数から取得したアクセスキーペアとセキュリティトークン。環境変数が設定されていることを確認してください。 |
getenv('OTS_SK_ENV') | 環境変数から取得したアクセスキーペアとセキュリティトークン。環境変数が設定されていることを確認してください。 | |
getenv('OTS_SESSION_TOKEN') | 環境変数から取得したアクセスキーペアとセキュリティトークン。環境変数が設定されていることを確認してください。 | |
InstanceName | myinstance | インスタンスの名前。詳細については、インスタンス を参照してください。 |
ConnectionTimeout | 2.0 | Tablestore への接続に許容される最大レイテンシ（秒）。デフォルト値：2.0。 |
SocketTimeout | 2.0 | 各リクエストのレスポンスに許容される最大レイテンシ（秒）。デフォルト値：2.0。 大量のデータが転送される場合は、このパラメーターを大きな値に設定することをお勧めします。 |
RetryPolicy | DefaultRetryPolicy | 再試行ポリシー。デフォルト値：DefaultRetryPolicy。 再試行ポリシーを無効にするには、このパラメーターを null に設定します。 |
DebugLogHandler | defaultOTSDebugLogHandler | デバッグログを処理する関数。通常の要求と応答のログを表示するために使用されます。デフォルト値：defaultOTSDebugLogHandler。 この関数を無効にするには、このパラメーターを null に設定します。 |
ErrorLogHandler | defaultOTSErrorLogHandler | エラーログを処理する関数。Tablestore サーバーから返されたエラーのログを表示するために使用されます。デフォルト値：defaultOTSErrorLogHandler。 この関数を無効にするには、このパラメーターを null に設定します。 |