PHP SDK

Table Store PHP SDK 支援寬表模型操作。

快速接入

快速接入Table Store PHP SDK，完成環境準備、SDK 安裝和用戶端初始化。

準備環境

已安裝 64 位元的 PHP 5.5 及以上版本。可通過php -v命令查看當前的 PHP 版本。
說明
Table Store的整型為 64 位元，32 位 PHP 只能用 string 表示 64 位元整型，因此不支援 32 位 PHP。 Windows 系統中 PHP7 之前的版本整型非真正 64 位元，需升級至 PHP7。建議使用 PHP7 以獲得更優效能。
使用 HTTPS 時需安裝 OpenSSL PHP 擴充。
已安裝 PHP 開發工具，例如 Eclipse for PHP。
建議安裝 CURL 擴充。可通過php -m命令查看 CURL 擴充是否已安裝。

安裝 SDK

通過 Composer 或下載源碼方式安裝Table Store PHP SDK。

通過 Composer 方式

Composer 方式安裝 SDK 的步驟如下：

在專案根目錄運行composer require aliyun/aliyun-tablestore-sdk-php，或在 composer.json 中聲明Table Store PHP SDK 依賴。
```
{
    "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 源碼包擷取源碼。

Table Store PHP SDK 提供樣本程式，涵蓋寬表模型的常見操作。通過以下方式擷取樣本程式：

下載並解壓Table Store PHP SDK 開發包後，在 examples 目錄中查看樣本程式。
訪問Table Store PHP SDK 的 GitHub 專案擷取樣本程式，見 aliyun-tablestore-php-sdk。

配置訪問憑證

為阿里雲帳號或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

在終端中執行以下命令，查看預設 Shell 類型。
```
echo $SHELL
```

根據預設 Shell 類型進行操作。

Zsh

執行以下命令來將環境變數設定追加到 ~/.zshrc 檔案中。

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

執行以下命令使變更生效。
```
source ~/.zshrc
```

執行以下命令檢查環境變數是否生效。

echo $TABLESTORE_ACCESS_KEY_ID
echo $TABLESTORE_ACCESS_KEY_SECRET

Bash

執行以下命令來將環境變數設定追加到 ~/.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

執行以下命令使變更生效。
```
source ~/.bash_profile
```

執行以下命令檢查環境變數是否生效。

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)

初始化用戶端

初始化用戶端後，通過列舉執行個體下的資料表驗證串連是否正常。

重要

新建立的執行個體預設未啟用公網訪問功能。如需通過公網訪問執行個體中的資源，在執行個體的網絡管理中開啟公網訪問。

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，對歷史版本的相容性如下：

相容 4.x.x 系列的 SDK。
不相容 2.x.x 系列的 SDK。

SDK 版本迭代詳情見PHP SDK歷史迭代版本。

PHP SDK

快速接入

準備環境

安裝 SDK

通過 Composer 方式

通過源碼包

配置訪問憑證

Linux

macOS

Zsh

Bash

Windows

CMD

PowerShell

初始化用戶端

版本相容性

常見問題

相關文檔