ITableEntity インターフェイス

定義

名前空間:

Microsoft.Azure.Cosmos.Table

アセンブリ:

Microsoft.Azure.Cosmos.Table.dll

パッケージ:

Microsoft.Azure.Cosmos.Table v1.0.8

テーブルのエンティティ型に必要なインターフェイスです。 ITableEntity インターフェイスには、必須のエンティティ プロパティの getter メソッドと setter メソッドに加え、プロパティ ディクショナリを使用したあらゆるエンティティ プロパティのシリアル化と逆シリアル化に必要な ReadEntity(IDictionary<String,EntityProperty>, OperationContext) メソッドと WriteEntity(OperationContext) メソッドが宣言されています。 クラスの作成時に ITableEntity を実装することによって、プロパティの格納、取得、シリアル化、逆シリアル化をカスタマイズしたり、テーブル エンティティに使用するカスタム ロジックを追加したりすることができます。

public interface ITableEntity

type ITableEntity = interface

Public Interface ITableEntity

派生

Microsoft.Azure.Cosmos.Table.DynamicTableEntity

Microsoft.Azure.Cosmos.Table.TableEntity

注釈

ストレージ クライアント ライブラリには、シンプルなプロパティ アクセスとシリアル化の機能を備えた ITableEntity の実装が 2 つ用意されています。

DynamicTableEntity は、ITableEntity を実装し、プロパティを格納したり取得したりするためのシンプルなプロパティ ディクショナリを備えています。 プロパティのサブセットだけが (クエリの select 句などにより) 返されるケースや、異なるプロパティを持った複数のエンティティ型がクエリから返される可能性がある状況で、DynamicTableEntity を使用すると、エンティティのプロパティに簡単にアクセスすることができます。 また、この型を使用すると、異種エンティティのテーブルに対して、プロパティ情報を損なうことなく一括更新を実行できます。

TableEntity は、その ITableEntity メソッドと ReadEntity(IDictionary<String,EntityProperty>, OperationContext) メソッドの中で、シリアル化と逆シリアル化にリフレクション ベースの動作を使用した WriteEntity(OperationContext) の実装です。 TableEntity型と名前付けの規則に従うメソッドを持つ派生クラスは、自動的にシリアル化および逆シリアル化されます。 TableEntity派生クラスでは、Microsoft Azure Table サービスでサポートされている型の get-able および set-able パブリック プロパティも提供する必要があります。

プロパティ

ETag	エンティティの現在の ETag を取得または設定します。 更新操作の一部としてエンティティを常に上書きするには、この値を "*" に設定します。
PartitionKey	エンティティのパーティション キーを取得または設定します。
RowKey	エンティティの行キーを取得または設定します。
Timestamp	エンティティのタイムスタンプを取得または設定します。

メソッド

ReadEntity(IDictionary<String,EntityProperty>, OperationContext)	properties ディクショナリ内の EntityProperty データ値からエンティティのプロパティを設定します。
WriteEntity(OperationContext)	エンティティ インスタンスの IDictionary<TKey,TValue> データ値にマッピングされたプロパティ名の EntityProperty をシリアル化します。