TableBatch クラス

  • リファレンス

これは、ストレージ テーブル サービスのバッチ操作に使用されるクラスです。

同じテーブルに存在し、かつ同じパーティション グループに属しているエンティティについて、Table service はバッチ トランザクションをサポートします。 1 つのトランザクション内で複数の操作がサポートされます。 バッチには最大 100 個のエンティティを含めることができます。そのペイロードの合計サイズは 4 MB 以下です。

継承
builtins.object
TableBatch

コンストラクター

TableBatch(require_encryption=False, key_encryption_key=None, encryption_resolver=None)

パラメーター

名前 説明
require_encryption
既定値: False
key_encryption_key
既定値: None
encryption_resolver
既定値: None

メソッド

delete_entity

エンティティの削除操作をバッチに追加します。 削除の詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.delete_entity> 。

バッチがコミットされるまで、操作は実行されません。
insert_entity

エンティティの挿入操作をバッチに追加します。 挿入の詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.insert_entity> 。

バッチがコミットされるまで、操作は実行されません。
insert_or_merge_entity

エンティティの挿入またはマージ操作をバッチに追加します。 挿入操作またはマージ操作の詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.insert_or_merge_entity> 。

バッチがコミットされるまで、操作は実行されません。
insert_or_replace_entity

エンティティの挿入または置換操作をバッチに追加します。 挿入操作または置換操作の詳細については、以下を参照してください <xref:azure.storage.table.tableservice.TableService.insert_or_replace_entity> 。

バッチがコミットされるまで、操作は実行されません。
merge_entity

マージ エンティティ操作をバッチに追加します。 マージの詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.merge_entity> 。

バッチがコミットされるまで、操作は実行されません。
update_entity

更新エンティティ操作をバッチに追加します。 更新プログラムの詳細については、 を参照してください <xref:azure.storage.table.tableservice.TableService.update_entity> 。

バッチがコミットされるまで、操作は実行されません。

delete_entity

エンティティの削除操作をバッチに追加します。 削除の詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.delete_entity> 。

バッチがコミットされるまで、操作は実行されません。

delete_entity(partition_key, row_key, if_match='*')

パラメーター

名前 説明
partition_key
必須
str

エンティティの PartitionKey。
row_key
必須
str

エンティティの RowKey。
if_match
str

クライアントでは、オプティミスティック コンカレンシーを目的としてサービスによって維持される ETag と比較するために、要求でエンティティの ETag を指定する場合があります。 削除操作は、クライアントから送信された ETag がサーバーで維持される値と一致した場合にのみ実行されます。これは、エンティティがクライアントで取得されてから変更されていないことを示します。 無条件削除を強制するには、If-Matchをワイルドカード文字 (*) に設定します。

既定値: *

insert_entity

エンティティの挿入操作をバッチに追加します。 挿入の詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.insert_entity> 。

バッチがコミットされるまで、操作は実行されません。

insert_entity(entity)

パラメーター

名前 説明
entity
必須
<xref:azure.storage.table.models.Entity>

挿入するエンティティ。 dict またはエンティティ オブジェクトを指定できます。 PartitionKey と RowKey を含む必要があります。

insert_or_merge_entity

エンティティの挿入またはマージ操作をバッチに追加します。 挿入操作またはマージ操作の詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.insert_or_merge_entity> 。

バッチがコミットされるまで、操作は実行されません。

insert_or_merge_entity(entity)

パラメーター

名前 説明
entity
必須
<xref:azure.storage.table.models.Entity>

挿入またはマージするエンティティ。 dict またはエンティティ オブジェクトを指定できます。 PartitionKey と RowKey を含む必要があります。

insert_or_replace_entity

エンティティの挿入または置換操作をバッチに追加します。 挿入操作または置換操作の詳細については、以下を参照してください <xref:azure.storage.table.tableservice.TableService.insert_or_replace_entity> 。

バッチがコミットされるまで、操作は実行されません。

insert_or_replace_entity(entity)

パラメーター

名前 説明
entity
必須
<xref:azure.storage.table.models.Entity>

挿入または置換するエンティティ。 dict またはエンティティ オブジェクトを指定できます。 PartitionKey と RowKey を含む必要があります。

merge_entity

マージ エンティティ操作をバッチに追加します。 マージの詳細については、「」を参照してください <xref:azure.storage.table.tableservice.TableService.merge_entity> 。

バッチがコミットされるまで、操作は実行されません。

merge_entity(entity, if_match='*')

パラメーター

名前 説明
entity
必須
<xref:azure.storage.table.models.Entity>

マージするエンティティ。 dict またはエンティティ オブジェクトを指定できます。 PartitionKey と RowKey を含む必要があります。
if_match
str

クライアントでは、オプティミスティック コンカレンシーを目的としてサービスによって維持される ETag と比較するために、要求でエンティティの ETag を指定する場合があります。 マージ操作は、クライアントによって送信された ETag がサーバーによって保持されている値と一致する場合にのみ実行されます。これは、エンティティがクライアントによって取得されてから変更されていないことを示します。 無条件マージを強制するには、If-Matchをワイルドカード文字 (*) に設定します。

既定値: *

update_entity

更新エンティティ操作をバッチに追加します。 更新プログラムの詳細については、 を参照してください <xref:azure.storage.table.tableservice.TableService.update_entity> 。

バッチがコミットされるまで、操作は実行されません。

update_entity(entity, if_match='*')

パラメーター

名前 説明
entity
必須
<xref:azure.storage.table.models.Entity>

更新するエンティティ。 dict またはエンティティ オブジェクトを指定できます。 PartitionKey と RowKey を含む必要があります。
if_match
str

クライアントでは、オプティミスティック コンカレンシーを目的としてサービスによって維持される ETag と比較するために、要求でエンティティの ETag を指定する場合があります。 更新操作は、クライアントから送信された ETag がサーバーで維持される値と一致した場合にのみ実行されます。これは、エンティティがクライアントで取得されてから変更されていないことを示します。 無条件更新を強制するには、If-Matchをワイルドカード文字 (*) に設定します。

既定値: *