表格存储 PHP SDK 支持宽表模型操作。
快速接入
快速接入表格存储 PHP SDK,完成环境准备、SDK 安装和客户端初始化。
准备环境
已安装 64 位的 PHP 5.5 及以上版本。可通过
php -v命令查看当前的 PHP 版本。说明表格存储的整型为 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 或下载源码方式安装表格存储 PHP SDK。
通过 Composer 方式
Composer 方式安装 SDK 的步骤如下:
在项目根目录运行
composer require aliyun/aliyun-tablestore-sdk-php,或在 composer.json 中声明表格存储 PHP SDK 依赖。说明如果使用 Composer 出现网络错误,可以使用 Composer 中国区的镜像。在命令行中执行
composer config -g repo.packagist composer https://developer.aliyun.com/composer。{ "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 依赖后无需再次引入。
通过源码包
通过以下方式下载源码包:
表格存储 PHP SDK 提供示例程序,涵盖宽表模型的常见操作。通过以下方式获取示例程序:
下载并解压表格存储 PHP SDK 开发包后,在
examples目录中查看示例程序。访问表格存储 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历史迭代版本。
常见问题
相关文档
表格存储的错误处理方式见错误处理。