Zugreifen auf Datendienstressourcen (WCF Data Services)
WCF Data Services unterstützt Open Data Protocol (OData) , um Daten als Feed mit Ressourcen verfügbar zu machen, die mithilfe von URIs adressierbar sind. Diese Ressourcen werden entsprechend der Entitätsbeziehungskonventionen des Entity Data Model dargestellt. In diesem Modell stellen Entitäten Funktionsbausteine von Daten, die Datentypen sind, in einer Anwendungsdomäne dar, z. B. Kunden, Bestellungen, Artikel und Produkte. Das Zugreifen auf und Ändern von Entitätsdaten erfolgt mit der REST (Representational State Transfer)-Semantik, speziell mit den Standard-HTTP-Verben GET, PUT, POST und DELETE.
Adressieren von Ressourcen
In OData werden alle vom Datenmodell verfügbar gemachten Daten mit einem URI adressiert. So gibt der folgende URI z. B. einen Feed zurück, bei dem es sich um die Customers-Entitätenmenge handelt, die Einträge für alle Instanzen des Customer-Entitätstyps enthält:
http://services.odata.org/Northwind/Northwind.svc/Customers
Entitäten verfügen über besondere Eigenschaften, die als Entitätsschlüssel bezeichnet werden. Ein Entitätsschlüssel wird verwendet, um eine einzelne Entität in einer Entitätenmenge eindeutig zu identifizieren. Dies ermöglicht es Ihnen, eine bestimmte Instanz eines Entitätstyps in der Entitätenmenge zu adressieren. Der folgende URI gibt z. B. einen Eintrag für eine bestimmte Instanz des Customer-Entitätstyps mit dem Schlüsselwert ALFKI zurück:
http://services.odata.org/Northwind/Northwind.svc/Customers('ALFKI')
Primitive und komplexe Eigenschaften einer Entitätsinstanz können auch einzeln behandelt werden. Der folgende URI gibt z. B. ein XML-Element zurück, das den ContactName-Eigenschaftswert für einen bestimmten Kunden enthält:
http://services.odata.org/Northwind/Northwind.svc/Customers('ALFKI')/ContactName
Wenn Sie den $value-Endpunkt in den vorherigen URI einschließen, wird in der Antwortnachricht nur der Wert der primitiven Eigenschaft zurückgegeben. Im folgenden Beispiel wird nur die Zeichenfolge "Maria Anders" ohne das XML-Element zurückgegeben:
http://services.odata.org/Northwind/Northwind.svc/Customers('ALFKI')/ContactName/$value
Beziehungen zwischen Entitäten werden im Datenmodell durch Zuordnungen definiert. Diese Zuordnungen ermöglichen es Ihnen, mithilfe der Navigationseigenschaften einer Entitätsinstanz verknüpfte Entitäten zu adressieren. Eine Navigationseigenschaft kann entweder eine einzelne verknüpfte Entität (bei einer n:1-Beziehung) oder einen Satz von verknüpften Entitäten (bei einer 1:n-Beziehung) zurückgeben. Der folgende URI gibt z. B. einen Feed zurück, bei dem es sich um den Satz aller Bestellungen handelt, die sich auf einen bestimmten Kunden beziehen:
http://services.odata.org/Northwind/Northwind.svc/Customers('ALFKI')/Orders
Gewöhnlich bidirektionale Beziehungen werden mithilfe eines Paars von Navigationseigenschaften dargestellt. Als Gegenstück zu der Beziehung im vorherigen Beispiel gibt der folgende URI einen Verweis auf die Customer-Entität zurück, zu der eine bestimmte Order-Entität gehört:
http://services.odata.org/Northwind/Northwind.svc/Orders(10643)/Customer
OData ermöglicht es Ihnen auch, Ressourcen auf der Grundlage der Ergebnisse von Abfrageausdrücken zu adressieren. Dies ermöglicht das Filtern mehrerer Ressourcensätze anhand eines ausgewerteten Ausdrucks. Der folgende URI filtert z. B. die Ressourcen, um nur die Bestellungen für den angegebenen Kunden zurückzugeben, die seit dem 22. September 1997 ausgeliefert wurden:
http://services.odata.org/Northwind/Northwind.svc/Customers('ALFKI')/Orders?$filter=ShippedDate gt datetime'1997-09-22T00:00:00'
Weitere Informationen finden Sie unter OData: URI Conventions.
Systemabfrageoptionen
OData definiert einen Satz von Systemabfrageoptionen, mit denen Sie herkömmliche Abfragevorgänge für Ressourcen ausführen können, z. B. Filterung, Sortierung und Paging. Der folgende URI gibt z. B. den Satz aller Order-Entitäten sowie die zugehörigen Order_Detail-Entitäten zurück, deren Postleitzahlen nicht mit 100 enden:
http://services.odata.org/Northwind/Northwind.svc/Orders?$filter=not endswith(ShipPostalCode,'100')&$expand=Order_Details&$orderby=ShipCity
Die Einträge des zurückgegebenen Feeds werden zudem nach dem Wert der ShipCity-Eigenschaft der Bestellungen geordnet.
WCF Data Services unterstützt die folgenden OData -Systemabfrageoptionen:
| Abfrageoption | Beschreibung |
|---|---|
$orderby |
Definiert im zurückgegebenen Feed eine Standardsortierreihenfolge für Entitäten. Die folgende Abfrage sortiert den zurückgegebenen Kundenfeed nach Landkreis und Ort:
Weitere Informationen finden Sie unter OData. |
$top |
Gibt die Anzahl der Entitäten an, die in den zurückgegebenen Feed eingeschlossen werden soll. Im folgenden Beispiel werden die ersten zehn Kunden übersprungen und die folgenden zehn zurückgegeben:
Weitere Informationen finden Sie unter OData: Top System Query Option ($top). |
$skip |
Gibt die Anzahl der Entitäten an, die vor dem Beginn der Rückgabe der Entitäten im Feed übersprungen werden sollen. Im folgenden Beispiel werden die ersten zehn Kunden übersprungen und die folgenden zehn zurückgegeben:
Weitere Informationen finden Sie unter OData: Skip System Query Option ($skip). |
$filter |
Definiert einen Ausdruck, der die im Feed zurückgegebenen Entitäten anhand bestimmter Kriterien filtert. Diese Abfrageoption unterstützt einen Satz logischer Vergleichsoperatoren, arithmetische Operatoren und vordefinierte Abfragefunktionen, die zur Auswertung des Filterausdrucks verwendet werden. Im folgenden Beispiel werden alle Bestellungen zurückgegeben, deren Postleitzahlen nicht mit "100" enden:
Weitere Informationen finden Sie unter OData: Filter System Query Option ($filter). |
$expand |
Gibt an, welche verknüpften Entitäten von der Abfrage zurückgegeben werden. Verknüpfte Entitäten sind entweder als Feed oder als Eintrag in der von der Abfrage zurückgegebenen Entität inline enthalten. Im folgenden Beispiel werden die Bestellungen des Kunden "ALFKI" zusammen mit den Artikeldetails der einzelnen Bestellungen zurückgegeben:
Weitere Informationen finden Sie unter OData: Expand System Query Option ($expand). |
$format |
Gibt das Format des zurückgegebenen Feeds an. Das Standardfeedformat ist Atom. Weitere Informationen finden Sie unter OData: Format System Query Option ($format). |
$select |
Gibt eine Projektion an, die die Eigenschaften der Entität definiert, die in der Projektion zurückgegeben werden. In der Standardeinstellung werden alle Eigenschaften einer Entität in einem Feed zurückgegeben. Die folgende Abfrage gibt nur drei Eigenschaften der
Weitere Informationen finden Sie unter OData: Select System Query Option ($select). |
$inlinecount |
Fordert an, dass die Anzahl der im Feed zurückgegebenen Entitäten im Feed enthalten sein muss. Weitere Informationen finden Sie unter OData. |
Behandeln von Beziehungen
Zusätzlich zum Adressieren von Entitätenmengen und Entitätsinstanzen ermöglicht OData Ihnen auch das Adressieren von Zuordnungen, die Beziehungen zwischen Entitäten darstellen. Diese Funktionalität ist erforderlich, um eine Beziehung zwischen zwei Entitätsinstanzen erstellen oder ändern zu können, z. B. das Versandunternehmen, das einer gegebenen Bestellung in der Northwind-Beispieldatenbank zugeordnet ist. OData unterstützt den $link-Operator, um speziell die Zuordnungen zwischen Entitäten zu adressieren. Der folgende URI wird z. B. in einer HTTP PUT-Anforderungsnachricht angegeben, um das Versandunternehmen für die angegebene Bestellung in ein neues Versandunternehmen zu ändern.
http://services.odata.org/Northwind/Northwind.svc/Orders(10643)/$links/Shipper
Weitere Informationen finden Sie unter OData: Addressing Links between Entries.
Verwenden des zurückgegebenen Feeds
Der URI einer OData -Ressource ermöglicht es Ihnen, vom Dienst verfügbar gemachte Entitätsdaten zu adressieren. Wenn Sie einen URI in das Adressfeld eines Webbrowsers eingeben, wird eine OData -Feeddarstellung der angeforderten Ressource zurückgegeben. Weitere Informationen finden Sie unter WCF Data Services-Schnellstart. Obwohl ein Webbrowser nützlich sein kann, um zu testen, ob eine Datendienstressource die erwarteten Daten zurückgibt, wird auf Produktionsdatendiensten, die Daten auch erstellen, aktualisieren und löschen können, im Allgemeinen mit Anwendungscode oder Skriptsprachen auf einer Webseite zugegriffen. Weitere Informationen finden Sie unter Verwenden eines Datendiensts in einer Clientanwendung (WCF Data Services).