Tablestore:Initialize a Tablestore client

Obtain information about the instance that you want to access

• Region ID: the ID of the region in which the instance resides. For example, the ID of the China (Hangzhou) region is cn-hangzhou. For more information about regions, see Regions.

• Instance name and endpoint: Each Tablestore instance has an endpoint. You must specify an endpoint before you can perform operations on the data and tables in Tablestore. You can perform the following steps to obtain the endpoint of an instance:

  1. Log on to the Tablestore console.

  2. In the top navigation bar, select a resource group and a region.

  3. On the Overview page, click the name of the instance that you want to manage or click Manage Instance in the Actions column of the instance.

  4. On the Instance Details tab, view the name and endpoints of the instance.

     Important

     By default, Internet-based access is disabled for a newly created instance. If you want to access resources in an instance over the Internet, you must enable Internet-based access for the instance. For more information, see Enable Internet-based access for an instance.

Install Tablestore SDK for Python

Run the following command to use pip to install Tablestore SDK for Python:

sudo pip install tablestore

For information about how to install Tablestore SDK for Java, see Install Tablestore SDK for Python.

Configure access credentials

To use Tablestore SDK for Java to initiate a request to access Tablestore, you must configure access credentials. Alibaba Cloud verifies your identity and access permissions based on the access credentials.

In the examples in this topic, the AccessKey pair of an Alibaba Cloud account is used to describe how to configure access credentials. For more information, see How do I obtain an AccessKey pair?

If you save access credentials to the code, information leaks may occur. We recommend that you save access credentials to system environment variables.

# Specify the AccessKey ID.
setx TABLESTORE_ACCESS_KEY_ID your_access_key_id /m
# Specify the AccessKey secret.
setx TABLESTORE_ACCESS_KEY_SECRET your_access_key_secret /m

# Specify the AccessKey ID.
export TABLESTORE_ACCESS_KEY_ID=your_access_key_id
# Specify the AccessKey secret.
export TABLESTORE_ACCESS_KEY_SECRET=your_access_key_secret

For information about how to configure access credentials, see Configure access credentials.

Wide Column model

The following sample code provides an example on how to initialize a client, query the list of data tables in an instance, and display the list in the Tablestore console:

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

# Specify the name of the instance.
instance_name = "yourInstanceName"
# Specify the endpoint of the instance.
endpoint = "yourEndpoint"
# Obtain the AccessKey ID and AccessKey secret from the environment variables.
access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

# Initialize a client.
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

# Query the list of data tables in the instance and display the list in the Tablestore console.
resp = client.list_table()
for table_name in resp:
    print(table_name)

You can also use the Credentials tool to read access credential from environment variables. For more information, see Appendix: Use the Credentials tool to read access credentials.

TimeSeries model

The following sample code provides an example on how to initialize a client, query the list of time series tables in an instance, and display the list in the Tablestore console:

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

# Specify the name of the instance.
instance_name = "yourInstanceName"
# Specify the endpoint of the instance.
endpoint = "yourEndpoint"
# Obtain the AccessKey ID and AccessKey secret from the environment variables.
access_key_id = os.getenv("TABLESTORE_ACCESS_KEY_ID")
access_key_secret = os.getenv("TABLESTORE_ACCESS_KEY_SECRET")

# Initialize a client.
client = OTSClient(endpoint, access_key_id, access_key_secret, instance_name)

# Query the list of time series tables in the instance and display the list in the Tablestore console.
response = client.list_timeseries_table()
for tableMeta in response:
    print(tableMeta.timeseries_table_name)