Python初始化Tablestore Client_表格存储(Tablestore)-阿里云帮助中心

Tablestore Client是表格存储的客户端，它提供了一系列的方法，可以用来操作表格存储的表和数据。本文介绍如何在Python中进行Tablestore Client的初始化。

重要

本文以阿里云账号的AccessKey为例为您介绍如何初始化Tablestore Client，如果您想使用RAM用户的访问密钥或STS临时访问凭证进行初始化，请参见使用RAM用户访问密钥访问表格存储和使用STS临时访问凭证访问表格存储。

准备工作

初始化Tablestore Client前，您需要获取实例的相关信息、安装Tablestore SDK并配置访问凭证。

获取实例信息

地域ID：实例所在地域的ID，例如华东1（杭州）的地域ID为cn-hangzhou。
实例名称和访问地址：每个表格存储实例对应一个访问地址（Endpoint），应用程序进行表和数据操作时需要指定访问地址，获取方式如下。
1. 登录表格存储控制台。
2. 在页面上方，选择资源组和地域。
3. 在概览页面，单击实例别名或在操作列单击实例管理。
4. 在实例详情页签，查看实例的名称和访问地址。
  重要
  新创建的实例默认未启用公网访问功能。如果您需要通过公网访问实例中的资源，则必须开启实例的公网访问功能。

安装Tablestore SDK

执行如下命令直接通过pip进行SDK安装。

sudo pip install tablestore

更多关于安装Tablestore SDK的信息，请参见安装Tablestore SDK。

配置访问凭证

您需要为阿里云账号或RAM用户创建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)

初始化Client

您需要先初始化一个Client，然后调用该Client的方法来访问表格存储服务。表格存储Python SDK提供了客户端OTSClient。

重要

如果要使用HTTPS协议访问表格存储资源，推荐您使用Python SDK的最新版本6.x.x，并且确保OpenSSL版本最少为0.9.8j，推荐OpenSSL 1.0.2d。

表格存储Python SDK的发布包中已包含了certifi包，您可以直接安装使用。如果需要更新根证书请从根证书下载最新的根证书。

宽表模型

以下示例代码用于初始化Client，获取实例中的所有数据表名称并打印到控制台。

# -*- coding: utf-8 -*-
import os
from tablestore import OTSClient

# yourInstanceName 填写您的实例名称
instance_name = "yourInstanceName"
# yourEndpoint 填写您的实例访问地址
endpoint = "yourEndpoint"
# 获取环境变量里的 AccessKey ID 和 AccessKey Secret
access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

# 初始化表格存储客户端
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

# 列出实例中的数据表列表并打印到控制台
resp = client.list_table()
for table_name in resp:
    print(table_name)

时序模型

以下示例代码用于初始化Client，获取实例中的所有时序表名称并打印到控制台。

# -*- coding: utf-8 -*-
import os
from tablestore import OTSClient

# yourInstanceName 填写您的实例名称
instance_name = "yourInstanceName"
# yourEndpoint 填写您的实例访问地址
endpoint = "yourEndpoint"
# 获取环境变量里的 AccessKey ID 和 AccessKey Secret
access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

# 初始化表格存储客户端
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

# 列出实例中的时序表列表并打印到控制台
response = client.list_timeseries_table()
for tableMeta in response:
    print(tableMeta.timeseries_table_name)

您也可以使用Credentials工具读取访问凭证。

常见问题

附录：使用Credentials工具读取访问凭证

执行如下命令安装alibabacloud_credentials包。
```
pip install alibabacloud_credentials
```
配置环境变量。
配置环境变量ALIBABA_CLOUD_ACCESS_KEY_ID和ALIBABA_CLOUD_ACCESS_KEY_SECRET，分别代表阿里云账号的AccessKey ID和AccessKey Secret。

读取访问凭证。

以下示例代码使用Credentials工具读取环境变量的访问凭证。

# -*- coding: utf-8 -*-
from alibabacloud_credentials.client import Client as CredClient

# 使用 CredClient 获取环境变量里的 AccessKey ID 和 AccessKey Secret
cred = CredClient()
access_key_id = cred.get_credential().access_key_id
access_key_secret = cred.get_credential().access_key_secret