Python SDK を使用した時系列テーブル設定の更新 - Tablestore

注意事項

時系列モデル機能は、Tablestore Python SDK 6.1.0 以降で利用できます。サポートされているバージョンの Python SDK を使用していることを確認してください。

説明
Python SDK のリリース履歴の詳細については、「Python SDK リリース履歴」をご参照ください。
同一の呼び出しで、時系列テーブルの設定 (timeseries_table_options) とタイムラインメタデータの設定 (timeseries_meta_options) を同時に変更することはできません。1 回の呼び出しで変更できるのは、いずれか一方のみです。

前提条件

Tablestore クライアントの初期化が完了していること。

パラメーター

パラメーター

説明

table_meta (必須)

時系列テーブルの構造。以下のパラメーターが含まれます。

timeseries_table_name (必須)：時系列テーブルの名前。
timeseries_table_options (任意)：時系列テーブルの設定。以下のパラメーターが含まれます。
- time_to_live (必須)：時系列テーブル内のデータの有効期間。データが失効するまでの期間を指定します。単位：秒。
  
  時系列テーブル内のデータの有効期間は最短で 86400 秒 (1 日) です。このパラメーターを -1 に設定することもできます。この場合、データは無期限となります。
timeseries_meta_options (任意)：タイムラインメタデータの設定。以下のパラメーターが含まれます。
- meta_time_to_live (必須)：タイムラインメタデータの有効期間。タイムラインが失効するまでの期間を指定します。単位：秒。
  
  タイムラインメタデータの有効期間は最短で 604800 秒 (7 日) です。このパラメーターを -1 に設定することもできます。この場合、タイムラインは無期限となります。
  
  重要
  タイムラインメタデータの有効期間は、時系列テーブルのデータの有効期間以上である必要があります。
- allow_update_attributes (必須)：タイムラインメタデータの属性の更新を許可するかどうかを指定します。有効な値：
  重要
  - meta_time_to_live が -1 でない場合は、allow_update_attributes を False に設定する必要があります。これにより、タイムラインメタデータの属性を更新できなくなります。
  - allow_update_attributes を True に設定する場合は、meta_time_to_live を -1 (無期限) に設定する必要があります。
  - True：操作を許可します。
  - False：許可しません。

例

次の例は、時系列テーブルの Time-to-Live (TTL) を更新する方法を示しています。

try:
    # 時系列テーブルのデータの有効期間を 604800 秒 (7 日) に設定します。
    tableOption = TimeseriesTableOptions(604800)
    tableMeta = TimeseriesTableMeta("<TIMESERIES_TABLE_NAME>", tableOption)

    # 時系列テーブルを更新する API を呼び出します。
    otsClient.update_timeseries_table(tableMeta)
    print("update timeseries table success.")
except Exception as e:
    # 例外がスローされた場合、実行は失敗です。例外を処理します。
    print("update timeseries table failed. %s" % e)