PHP SDK - Tablestore - Tablestore - Alibaba Cloud ドキュメントセンター

Tablestore SDK for PHP は、ワイドカラムモデルの操作をサポートします。

クイックスタート

環境を準備し、SDK をインストールしてクライアントを初期化することで、Tablestore SDK for PHP の使用を開始できます。

環境の準備

64 ビット版の PHP 5.5 以降がインストールされていること。PHP のバージョンを確認するには、php -v コマンドを実行します。

説明
Tablestore の整数は 64 ビットです。32 ビット版の PHP では、64 ビット整数を string 値としてしか表現できないため、32 ビット版の PHP はサポートされていません。Windows では、PHP 7 より前のバージョンは真の 64 ビット整数を使用しません。適切な 64 ビット整数サポートとパフォーマンス向上のため、PHP 7 以降にアップグレードしてください。
HTTPS を使用する場合は、OpenSSL PHP 拡張をインストールします。
Eclipse for PHP などの PHP 開発ツールがインストールされていること。
CURL 拡張のインストールを推奨します。php -m コマンドを実行して、CURL 拡張がインストール済みかどうかを確認できます。

SDK のインストール

Tablestore SDK for PHP は、Composer またはソースパッケージからインストールできます。

Composer

Composer を使用して SDK をインストールする手順は次のとおりです。

プロジェクトのルートディレクトリで composer require aliyun/aliyun-tablestore-sdk-php コマンドを実行するか、composer.json に Tablestore SDK for PHP の依存関係を宣言します。
```
{
    "require": {
        "aliyun/aliyun-tablestore-sdk-php": "^5.1"
    }
}
```
composer install コマンドを実行して依存関係をインストールします。インストール後のディレクトリ構造は次のとおりです。
```
 .
 ├── app.php
 ├── composer.json
 ├── composer.lock
 └── vendor
```
この構造において、app.php はご利用のアプリケーションであり、vendor/ ディレクトリには必要なライブラリが含まれます。app.php に依存関係をインクルードします。
```
require_once __DIR__ . '/vendor/autoload.php';
```
説明
プロジェクトにすでに autoload.php が含まれている場合、SDK の依存関係を追加した後でも再度インクルードする必要はありません。

ソースパッケージ

次のいずれかのソースからソースパッケージをダウンロードします。

GitHub にアクセスし、必要なバージョンを選択してソースアーカイブをダウンロードします。
SDK ソースパッケージをダウンロードします。

Tablestore SDK for PHP には、一般的なワイドカラムモデル操作をカバーするサンプルプログラムが含まれています。サンプルプログラムは次のいずれかの方法で取得できます。

Tablestore SDK for PHP パッケージをダウンロードして展開し、examples ディレクトリ内のサンプルプログラムをご利用ください。
Tablestore SDK for PHP の GitHub リポジトリ aliyun-tablestore-php-sdk を参照してください。

アクセス認証情報の設定

Alibaba Cloud アカウントまたは RAM ユーザーの AccessKey を作成します。その後、以下のように AccessKey を環境変数に設定してください。環境変数に AccessKey を設定すると、コード内に機密情報をハードコードしないため、セキュリティが向上します。

設定完了後は、IDE、コマンドラインインターフェイス、その他のデスクトップアプリケーション、バックグラウンドサービスなど、ご利用の開発環境を再起動またはリフレッシュする必要があります。これにより、最新のシステム環境変数がロードされます。その他の種類のアクセス認証情報については、「アクセス認証情報の設定」をご参照ください。

Linux

次のコマンドを実行して、環境変数の設定を ~/.bashrc ファイルに追加します。

echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc

次のコマンドを実行して、変更を適用します。
```
source ~/.bashrc
```
次のコマンドを実行して、環境変数が有効になっていることを確認します。
```
echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET
```

macOS

ターミナルで次のコマンドを実行して、デフォルトのシェルタイプを確認します。
```
echo $SHELL
```
デフォルトのシェルタイプに応じて、次の操作を実行します。
Zsh
1. 次のコマンドを実行して、環境変数の設定を ~/.zshrc ファイルに追加します。
```
echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc
```
2. 次のコマンドを実行して、変更を適用します。
```
source ~/.zshrc
```
3. 次のコマンドを実行して、環境変数が有効になっていることを確認します。
```
echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET
```
Bash
1. 次のコマンドを実行して、環境変数の設定を ~/.bash_profile ファイルに追加します。
```
echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bash_profile
echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bash_profile
```
2. 次のコマンドを実行して、変更を適用します。
```
source ~/.bash_profile
```
3. 次のコマンドを実行して、環境変数が有効になっていることを確認します。
```
echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET
```

Windows

CMD

コマンドプロンプト (CMD) で次のコマンドを実行して、環境変数を設定します。

setx TABLESTORE_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
setx TABLESTORE_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"

CMD を再起動し、次のコマンドを実行して、環境変数が有効になっていることを確認します。
```
echo %TABLESTORE_ACCESS_KEY_ID%
echo %TABLESTORE_ACCESS_KEY_SECRET%
```

PowerShell

PowerShell で次のコマンドを実行します。

[Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
[Environment]::SetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", "YOUR_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

次のコマンドを実行して、環境変数が有効になっていることを確認します。

[Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_ID", [EnvironmentVariableTarget]::User)
[Environment]::GetEnvironmentVariable("TABLESTORE_ACCESS_KEY_SECRET", [EnvironmentVariableTarget]::User)

クライアントの初期化

Tablestore クライアントを初期化し、インスタンス内のテーブル一覧を取得して接続を確認します。

重要

新規インスタンスでは、デフォルトでパブリックネットワークからのアクセスが無効になっています。パブリックネットワーク経由でインスタンスリソースにアクセスするには、インスタンスの ネットワーク管理 でパブリックアクセスを有効化してください。

require_once __DIR__ . '/vendor/autoload.php';

use Aliyun\OTS\OTSClient as OTSClient;

// yourInstanceName 填写实例名称
$instanceName = "yourInstanceName";
// yourEndpoint 填写实例访问地址
$endpoint = "yourEndpoint";
// 获取系统变量里的 AccessKey ID 和 AccessKey Secret
$accessKeyId = getenv('TABLESTORE_ACCESS_KEY_ID');
$accessKeySecret = getenv('TABLESTORE_ACCESS_KEY_SECRET');

// 初始化 Tablestore Client
$client = new OTSClient(array(
    'EndPoint' => $endpoint,
    'AccessKeyID' => $accessKeyId,
    'AccessKeySecret' => $accessKeySecret,
    'InstanceName' => $instanceName,
));

// 列出实例中的数据表列表并打印到控制台
$response = $client->listTable (array ());
print json_encode ($response);

バージョン互換性

最新バージョンは 5.x.x です。以前のバージョンとの互換性は次のとおりです。

SDK 4.x.x と互換があります。
SDK 2.x.x とは互換がありません。

SDK のバージョン履歴については、「PHP SDK の過去のバージョン」をご参照ください。

よくある質問

参考資料

Tablestore のエラー処理に関する詳細については、「エラー処理」をご参照ください。