全部產品
Search
文件中心

Tablestore:讀取單行資料

更新時間:Mar 31, 2026

本文介紹如何通過 Python SDK 讀取Table Store資料表的單行資料。

注意事項

讀取資料時需要提供包含自增主鍵列值在內的完整主索引值。

前提條件

初始化Tablestore Client

方法說明

def get_row(self, table_name, primary_key, columns_to_get=None,
            column_filter=None, max_version=1, time_range=None,
            start_column=None, end_column=None, token=None,
            transaction_id=None):

參數說明

名稱

類型

說明

table_name(必選)

str

資料表名稱。

primary_key(必選)

List[Tuple]

主鍵資訊,包括主鍵列名稱和主索引值。

  • 主鍵列資料類型包括 STRING、INTEGER 和 BINARY。

  • 主鍵個數和類型必須與資料表的主鍵保持一致。

max_version(可選)

int

最大版本數,預設值為1。

  • 必須設定最大版本數和版本範圍的其中一個。

  • 如果符合查詢條件的資料版本數量超過設定的最大版本數,按從新到舊的順序返回指定版本數量的資料。

time_range(可選)

Tuple

資料版本範圍。

  • 必須設定最大版本數和版本範圍的其中一個。

  • Table Store資料表的每個屬性列可以有不同的資料版本,設定版本範圍後,僅返回版本範圍內的資料。

columns_to_get(可選)

List[str]

指定讀取的資料列,可以是主鍵列或屬性列。

  • 不設定columns_to_get時,返回整行資料。

  • 設定columns_to_get時,如果讀取的行資料不包含任何指定的資料列,將返回 null。

column_filter(可選)

ColumnCondition

過濾條件,詳情請參見過濾器

  • 如果同時設定columns_to_get和column_filter,先按columns_to_get篩選合格資料行,再按column_filter條件過濾資料。

transaction_id(可選)

str

局部事務ID,用於唯一標識局部事務,詳情請參見局部事務

範例程式碼

以下範例程式碼讀取了主索引值為 row1 的單行資料。

try:
    # 構造主鍵
    primary_key = [('id', 'row1')]

    # 調用 get_row 方法讀取行資料
    consumed, return_row, next_token = client.get_row('test_table', primary_key)
    print('Read CU Cost: %s' % consumed.read)
    print('Write CU Cost: %s' % consumed.write)
    print('Row Data: %s %s' % (return_row.primary_key, return_row.attribute_columns))
except Exception as e:
    print("Get row failed with error: %s" % e)
  • 設定讀取的資料版本範圍,結果只返回版本範圍內的資料。

    # 設定查詢的資料版本範圍為目前時間往前一天
    time_range = (int(time.time() * 1000 - 86400 * 1000), int(time.time() * 1000))
    
    # 調用 get_row 方法讀取行資料
    consumed, return_row, next_token = client.get_row('test_table', primary_key, time_range=time_range)
  • 指定讀取的屬性列。

    columns_to_get = ['col2']
    
    # 調用 get_row 方法讀取行資料
    consumed, return_row, next_token = client.get_row('test_table', primary_key, columns_to_get=columns_to_get)

相關文檔