Todos os produtos
Search
Central de documentação

Tablestore:PHP SDK

Última atualização: Jul 03, 2026

Use o Tablestore SDK for PHP para realizar operações do modelo de coluna larga.

Guia de início rápido

Prepare o ambiente, instale o SDK e inicialize um cliente.

Preparar o ambiente

  • PHP 5.5 ou superior (64 bits). Execute php -v para verificar a versão.

    Nota

    O Tablestore usa inteiros de 64 bits. O PHP de 32 bits só consegue representá-los como valores string e não tem suporte. No Windows, versões do PHP anteriores à 7 não oferecem suporte real a inteiros de 64 bits. Use o PHP 7 ou superior.

  • Se usar HTTPS, instale a extensão OpenSSL do PHP.

  • Uma IDE PHP, como o Eclipse for PHP.

  • A extensão cURL (recomendada). Execute php -m para confirmar a instalação.

Instalar o SDK

Instale o SDK via Composer ou a partir de um pacote de código-fonte.

Composer

Para instalar com o Composer:

  1. Execute composer require aliyun/aliyun-tablestore-sdk-php na raiz do projeto ou adicione a dependência ao arquivo composer.json.

    {
        "require": {
            "aliyun/aliyun-tablestore-sdk-php": "^5.1"
        }
    }
  2. Execute composer install. A estrutura de diretórios resultante será:

     .
     ├── app.php
     ├── composer.json
     ├── composer.lock
     └── vendor

    O diretório vendor/ contém as bibliotecas instaladas. Inclua o autoloader na aplicação:

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

    Ignore esta etapa se o projeto já incluir o arquivo autoload.php.

Pacote de código-fonte

Baixe o pacote de código-fonte:

O SDK inclui programas de exemplo para operações comuns do modelo de coluna larga:

  • Baixe e extraia o pacote do SDK. Os exemplos estão no diretório examples.

  • Navegue pelo repositório aliyun-tablestore-php-sdk no GitHub.

Configurar credenciais de acesso

Crie uma AccessKey para sua conta Alibaba Cloud ou usuário RAM e configure-a como variável de ambiente para evitar codificar credenciais diretamente no código.

Reinicie a IDE, o terminal, outros aplicativos de desktop e serviços em segundo plano após a configuração para carregar as variáveis de ambiente atualizadas. Para obter mais informações sobre outros tipos de credenciais de acesso, consulte Configurar credenciais de acesso .

Linux

  1. Adicione as variáveis de ambiente ao arquivo ~/.bashrc:

    echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
    echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc
  2. Aplique as alterações:

    source ~/.bashrc
  3. Verifique as variáveis de ambiente:

    echo $TABLESTORE_ACCESS_KEY_ID
    echo $TABLESTORE_ACCESS_KEY_SECRET

macOS

  1. Verifique o shell padrão:

    echo $SHELL
  2. Configure conforme o tipo de shell:

    Zsh

    1. Adicione as variáveis de ambiente ao arquivo ~/.zshrc:

      echo "export TABLESTORE_ACCESS_KEY_ID='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
      echo "export TABLESTORE_ACCESS_KEY_SECRET='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc
    2. Aplique as alterações:

      source ~/.zshrc
    3. Verifique as variáveis de ambiente:

      echo $TABLESTORE_ACCESS_KEY_ID
      echo $TABLESTORE_ACCESS_KEY_SECRET

    Bash

    1. Adicione as variáveis de ambiente ao arquivo ~/.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. Aplique as alterações:

      source ~/.bash_profile
    3. Verifique as variáveis de ambiente:

      echo $TABLESTORE_ACCESS_KEY_ID
      echo $TABLESTORE_ACCESS_KEY_SECRET

Windows

CMD

  1. Defina as variáveis de ambiente no CMD:

    setx TABLESTORE_ACCESS_KEY_ID "YOUR_ACCESS_KEY_ID"
    setx TABLESTORE_ACCESS_KEY_SECRET "YOUR_ACCESS_KEY_SECRET"
  2. Reinicie o CMD e verifique:

    echo %TABLESTORE_ACCESS_KEY_ID%
    echo %TABLESTORE_ACCESS_KEY_SECRET%

PowerShell

  1. Execute no 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)
  2. Verifique as variáveis de ambiente:

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

Inicializar um cliente

Inicialize um cliente Tablestore e liste as tabelas para validar a conexão.

Importante

O acesso pela rede pública vem desativado por padrão em novas instâncias. Para acessar recursos da instância pela rede pública, ative o acesso público em Network Management da instância.

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

use Aliyun\OTS\OTSClient as OTSClient;

// Replace yourInstanceName with the actual instance name.
$instanceName = "yourInstanceName";
// Replace yourEndpoint with the actual instance endpoint.
$endpoint = "yourEndpoint";
// Read the AccessKey ID and AccessKey secret from environment variables.
$accessKeyId = getenv('TABLESTORE_ACCESS_KEY_ID');
$accessKeySecret = getenv('TABLESTORE_ACCESS_KEY_SECRET');

// Initialize the Tablestore client.
$client = new OTSClient(array(
    'EndPoint' => $endpoint,
    'AccessKeyID' => $accessKeyId,
    'AccessKeySecret' => $accessKeySecret,
    'InstanceName' => $instanceName,
));

// List all tables in the instance and print the result to the console.
$response = $client->listTable (array ());
print json_encode ($response);

Compatibilidade de versões

A versão mais recente é a 5.x.x. Compatibilidade:

  • Compatível com o SDK 4.x.x.

  • Incompatível com o SDK 2.x.x.

Para consultar o histórico de versões do SDK, veja Versões históricas do PHP SDK.

Perguntas frequentes

Referências

Para obter informações sobre tratamento de erros no Tablestore, consulte Tratamento de erros.