テーブル設定の更新 - Tablestore Python SDK - Tablestore - Alibaba Cloud ドキュメントセンター

Tablestore Python SDK を使用して、テーブルの TTL、バージョン、更新モード、および予約済みスループットの設定を更新します。

前提条件

Tablestore Python SDK をインストールし、クライアントを初期化します。

関数の説明

update_table メソッドを呼び出して、テーブル設定を更新します。table_options と reserved_throughput のうち、少なくとも 1 つを指定する必要があります。

def update_table(
    self,
    table_name,
    table_options=None,
    reserved_throughput=None,
)

次の例では、example_table の TTL を 7 日に変更し、update_row メソッドによる更新を無効にします。

table_options = TableOptions(
    time_to_live=604800,
    max_version=1,
    max_time_deviation=86400,
    allow_update=False,
)

client.update_table(
    "example_table",
    table_options=table_options,
)

パラメーター

update_table メソッドには、次のパラメーターが含まれます。

名前	型	説明
table_name (必須)	`str`	テーブルの名前。
table_options (任意)	`TableOptions`	更新するテーブル設定。このパラメーターと `reserved_throughput` のうち、少なくとも 1 つを指定する必要があります。
reserved_throughput (任意)	`ReservedThroughput`	更新する予約済みスループット。このパラメーターと `table_options` のうち、少なくとも 1 つを指定する必要があります。

テーブル設定

table_options パラメーターは TableOptions 型で、次のパラメーターが含まれます。

名前	型	説明
time_to_live (任意)	`int`	データの TTL を秒単位で示します。値が `-1` の場合、データは期限切れになりません。別の値を指定する場合、最小値は `86400` (1 日) です。期限切れになったデータは自動的に削除されます。検索インデックスまたはセカンダリインデックスを使用するには、このパラメーターを `-1` に設定するか、`allow_update` を `False` に設定します。
max_version (任意)	`int`	各属性列で保持する最大バージョン数。検索インデックスまたはセカンダリインデックスを使用するには、このパラメーターを `1` に設定します。
max_time_deviation (任意)	`int`	最大バージョン偏差 (秒)。書き込むデータのタイムスタンプと現在のシステム時刻との差は、最大バージョン偏差の範囲内である必要があります。有効なバージョン範囲は `[max(data write time - maximum version deviation, data write time - TTL), data write time + maximum version deviation)` です。
allow_update (任意)	`bool`	`update_row` を呼び出してデータを更新できるかどうかを指定します。このパラメーターを `False` に設定した場合、`update_row` を呼び出してデータを更新することはできません。

予約済みスループット

reserved_throughput パラメーターは ReservedThroughput 型で、次のパラメーターが含まれます。

名前	型	説明
capacity_unit (必須)	`CapacityUnit`	CU 単位の予約済みスループット。0 以外の値をサポートするのは、CU モードの高性能インスタンスのみです。

レスポンス

UpdateTableResponse には、次の情報が含まれます。

フィールド	型	説明
table_options	`TableOptions`	更新後のテーブル設定。
reserved_throughput_details	`ReservedThroughputDetails`	現在の予約済みスループット、および直近の増加時刻と減少時刻。

例

予約済みスループットの更新

次の例では、example_table の予約済みスループットを 0 CU に設定します。

reserved_throughput = ReservedThroughput(
    CapacityUnit(read=0, write=0)
)

client.update_table(
    "example_table",
    reserved_throughput=reserved_throughput,
)