データ サービスの更新 (WCF Data Services)

WCF Data Services クライアント ライブラリを使用して Open Data Protocol (OData) フィードを操作する場合、フィード内のエントリがクライアント データ サービス クラスのインスタンスに変換されます。これらのデータ サービス クラスは、DataServiceQuery が属する DataServiceContext を使用して追跡されます。クライアントでは、DataServiceContext にメソッドを使用して報告する、エンティティへの変更が追跡されます。これらのメソッドを使用すると、クライアントは、追加および削除されたエンティティの追跡に加えて、プロパティ値に対して行われた変更やエンティティ インスタンス間のリレーションシップに対して行われた変更を追跡できます。追跡されたこれらの変更は、SaveChanges メソッドが呼び出されたときに、REST ベースの操作としてデータ サービスに送り返されます。

注 :
DataServiceCollection のインスタンスを使用してデータをコントロールにバインドする場合、バインドされたコントロールのデータに対して行われた変更は DataServiceContext に自動的に報告されます。詳細については、「コントロールへのデータのバインド (WCF Data Services)」を参照してください。

エンティティの追加および変更

Visual Studio の [サービス参照の追加] ダイアログを使用して OData フィードへの参照を追加した場合、結果のクライアント データ サービス クラスにはそれぞれ、静的な Create メソッドが作成されます。このメソッドは、null 非許容のエンティティ プロパティごとに 1 つのパラメーターを受け取ります。このメソッドを使用すると、次の例に示すように、エンティティ型クラスのインスタンスを作成できます。

' Create the new product.
Dim newProduct = _
    Product.CreateProduct(0, "White Tea - loose", False)

// Create the new product.
Product newProduct =
    Product.CreateProduct(0, "White Tea - loose", false);

エンティティ インスタンスを追加するには、次の例に示すように、[サービス参照の追加] ダイアログ ボックスによって生成された DataServiceContext クラスで適切な AddTo メソッドを呼び出します。

' Add the new product to the Products entity set.
context.AddToProducts(newProduct)

// Add the new product to the Products entity set.
context.AddToProducts(newProduct);

オブジェクトがコンテキストおよび正しいエンティティ セットに追加されます。AddObject を呼び出すこともできますが、エンティティ セット名を指定する必要があります。追加したエンティティにその他のエンティティへの 1 つ以上のリレーションシップがある場合は、AddRelatedObject メソッドを使用するか、前のメソッドの 1 つを使用してこれらのリンクを明示的に定義することができます。これらの操作の詳細については、このトピックの後半で説明します。

既存のエンティティ インスタンスを変更するには、まずそのエンティティを照会し、このエンティティのプロパティに必要な変更を加えてから、オブジェクトの更新を送信する必要があることをクライアント ライブラリに示すために、次のように DataServiceContext で UpdateObject メソッドを呼び出します。

' Mark the customer as updated.
context.UpdateObject(customerToChange)

// Mark the customer as updated.
context.UpdateObject(customerToChange);

エンティティ インスタンスを削除するには、次の例に示すように、DataServiceContext で DeleteObject メソッドを呼び出します。

' Mark the product for deletion.    
context.DeleteObject(deletedProduct)

// Mark the product for deletion.    
context.DeleteObject(deletedProduct);

詳細については、「方法: エンティティを追加、変更、および削除する (WCF Data Services)」を参照してください。

エンティティのアタッチ

クライアント ライブラリでは、クエリを実行してエンティティを DataServiceContext に読み込むことなく、エンティティに対して行った変更を保存できます。AttachTo メソッドを使用して、既存のオブジェクトを DataServiceContext の特定のエンティティ セットにアタッチします。その後、オブジェクトを変更して、変更内容をデータ サービスに保存できます。次の例では、変更された顧客オブジェクトがコンテキストにアタッチされた後、SaveChanges が呼び出される前に、UpdateObject が呼び出され、アタッチされたオブジェクトが Modified としてマークされます。

' Attach the existing customer to the context and mark it as updated.
context.AttachTo("Customers", customer)
context.UpdateObject(customer)

' Send updates to the data service.
context.SaveChanges()

// Attach the existing customer to the context and mark it as updated.
context.AttachTo("Customers", customer);
context.UpdateObject(customer);

// Send updates to the data service.
context.SaveChanges();

オブジェクトをアタッチする際は、次の点に注意してください。

• オブジェクトは、Unchanged 状態でアタッチされます。

• オブジェクトがアタッチされるとき、アタッチされるオブジェクトに関連付けられたオブジェクトはアタッチされません。

• エンティティがコンテキストによって既に追跡されている場合は、オブジェクトをアタッチできません。

• eTag 値と一緒に受け取ったエンティティ オブジェクトをアタッチした場合は、AttachTo メソッドの、etag パラメーターを受け取るオーバーロードが使用されます。この eTag 値は、アタッチされたオブジェクトへの変更を保存したときに、同時実行をチェックするために使用されます。

詳細については、「方法: 既存のエンティティを DataServiceContext にアタッチする (WCF Data Services)」を参照してください。

リレーションシップ リンクの作成および変更

[サービス参照の追加] ダイアログで生成された DataServiceContext クラスの AddObject メソッド、または適切な AddTo メソッドを使用して新しいエンティティを追加する場合、新しいエンティティと関連付けられたエンティティの間のリレーションシップの自動定義は行われません。

エンティティ インスタンス間のリレーションシップを作成および変更し、クライアント ライブラリにこれらの変更をデータ サービスに反映できます。エンティティ間のリレーションシップは、モデル内の関連付けとして定義されています。また、DataServiceContext は、各リレーションシップをコンテキスト内のリンク オブジェクトとして追跡します。WCF Data Services は、DataServiceContext クラスで、これらのリンクを作成、変更、および削除する以下のメソッドを提供します。

次の例は、AddRelatedObject メソッドを使用して、既存の Orders エンティティに関連付けられた新しい Order_Detail を追加する方法を示します。新しい Order_Details オブジェクトは DataServiceContext によって追跡されるので、既存の Products エンティティと追加された Order_Details オブジェクトのリレーションシップは、AddLink メソッドを呼び出すことによって定義されます。

' Add the new item with a link to the related order.
context.AddRelatedObject(order, "Order_Details", newItem)

' Since the item is now tracked by the context,
' set just the link to the related product.
context.AddLink(selectedProduct, "Order_Details", newItem)

// Add the new item with a link to the related order.
context.AddRelatedObject(order, "Order_Details", newItem);

// Since the item is now tracked by the context,
// set just the link to the related product.
context.AddLink(selectedProduct, "Order_Details", newItem);

AddLink メソッドは、データ サービス内に作成する必要のあるリンクを定義しますが、これらのリンクをコンテキスト内のオブジェクトに反映させるには、オブジェクト自身でナビゲーション プロパティを設定する必要があります。前の例では、次のようにナビゲーション プロパティを設定します。

' Add the new order detail to the collection, and
' set the reference to the product.
order.Order_Details.Add(newItem)
newItem.Order = order
newItem.Product = selectedProduct

// Add the new order detail to the collection, and
// set the reference to the product.
order.Order_Details.Add(newItem);
newItem.Order = order;
newItem.Product = selectedProduct;

詳細については、「方法: エンティティ リレーションシップを定義する (WCF Data Services)」を参照してください。

変更の保存

変更は、DataServiceContext インスタンスで追跡されますが、サーバーには直ちに送信されません。指定されたアクティビティに対して必要な変更が完了した後、SaveChanges を呼び出して、すべての変更をデータ サービスに送信します。詳細については、「データ サービス コンテキストの管理 (WCF Data Services)」を参照してください。変更は、BeginSaveChanges および EndSaveChanges メソッドを使用して、非同期で保存することもできます。詳細については、「非同期操作 (WCF Data Services)」を参照してください。

参照

概念

データ サービスのクエリ (WCF Data Services)
非同期操作 (WCF Data Services)
バッチ処理 (WCF Data Services)
オブジェクトの具体化 (WCF Data Services)
データ サービス コンテキストの管理 (WCF Data Services)

その他のリソース

WCF Data Services クライアント ライブラリ