初始化Tablestore Client

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

重要

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

准备工作

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

获取实例信息

  • 地域ID:实例所在的地域ID,例如华东1(杭州)的地域IDcn-hangzhou,更多地域信息请参见地域

  • 实例名称和服务地址Endpoint:每个表格存储实例对应一个服务地址(Endpoint),应用程序进行表和数据操作时需要指定服务地址,获取方式如下。

    1. 登录表格存储控制台

    2. 在页面上方,选择资源组和地域。

    3. 概览页面,单击实例别名或在操作列单击实例管理

    4. 实例详情页签,查看实例的名称和服务地址。

安装Tablestore SDK

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

sudo pip install tablestore

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

配置访问凭证

使用Tablestore SDK发起请求访问表格存储,您需要配置访问凭证,阿里云服务会通过访问凭证验证您的身份信息和访问权限。

本文以阿里云账号的AccessKey为例为您介绍如何配置访问凭证。AccessKey的获取方式,请参见如何获取AccessKey

直接在代码中保存访问凭证容易导致信息泄露,建议您将访问凭证保存在系统环境变量中。

Windows

以管理员身份运行命令提示符,执行以下命令。

# 配置 AccessKey ID
setx TABLESTORE_ACCESS_KEY_ID your_access_key_id /m
# 配置 AccessKey Secret
setx TABLESTORE_ACCESS_KEY_SECRET your_access_key_secret /m

macOS/Linux/Unix

# 配置 AccessKey ID
export TABLESTORE_ACCESS_KEY_ID=your_access_key_id
# 配置 AccessKey Secret
export TABLESTORE_ACCESS_KEY_SECRET=your_access_key_secret

更多关于配置访问凭证的信息,请参见配置访问凭证

初始化Client

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

重要

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

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

宽表模型

以下示例代码用于初始化Tablestore 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")

# 初始化 Tablestore Client
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

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

您也可以借助Credentials工具从环境变量中读取访问凭证。更多信息,请参见附录1:使用Credentials工具读取访问凭证

常见问题

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

  1. 执行如下命令安装alibabacloud_credentials包。

    pip install alibabacloud_credentials
  2. 配置环境变量。

    配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET,分别代表阿里云账号的AccessKey IDAccessKey Secret。

  3. 读取访问凭证。

    以下示例代码使用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