Autoren

• Fred Teske(s3frtesk@stud.hs-zigr.de )
• Philipp Dvorak (s3phdvor@stud.hs-zigr.de)

Einstieg in XQuery

XQuery ist eine Abfragesprache für XML. Welche eine Empfehlung vom W3C ist. In diesem Kurs sollen die grundlegenden Spracheigenschaften vorgestellt werden und ein Verständnis der Syntax und Struktur von XQuery–Ausdrücken vermittelt werden.

XQuery ermöglicht:

• Auswählen von Elementen und Attributen
• Zusammenführen mehrerer XML-Dokumente
• Bearbeiten von XML-Daten
• Hinzufügen von Elementen und Attributen zu der Ergebnismengen
• Berechnungen auf Grundlage von XML-Daten
• Sortierungen der Ergebnismenge

Datenmodell

Die Basis des XQuery Datenmodells sind Sequenzen. Eine Sequenz ist die Sammlung einzelner sogenannter Items, welche mit einem Komma voneinander getrennt sind. Es sind Duplikate von Items möglich. Sequenzen funktionieren nach dem fifo–Prinzip (first in first out) d.h. das Item, das als erstes in die Sequenz eingestellt wurde, wird auch als erstes wieder ausgegeben. Die einzelnen Items können unterschiedliche Datentypen haben. XQuery bestitz eigene Datentypen für atomare Werte und von XML Schema geerbte Datentypen.

Beispiele für Sequenzen

• atomare Ganzzahl

2

• atomare Zeichenkette

'hallo'

• drei atomare Wert

(1, 2, 3)

• XML Elementknoten

<schauspieler></schauspieler>

• atomare Werte und XML Elementknoten

(1, <schauspieler></schauspieler>, 'hallo')

• leere Sequenz

()

Die Empfehlungen vom W3C für XQuery und XPath überschneiden sich. XPath bildet eine Untermenge von XQuery. Somit ist jeder gültige XPath-Ausdruck auch ein gültiger XQuery-Ausdruck. XQuery ist selbst keine XML-Anwendung. XQuery bestitz eine eigene Syntax.

Syntax

Bei XQuery handelt es sich um eine funktionale Sprache. Eine Abfrage wird als Ausdruck formuliert, der anschließend ausgewertet wird. Ausdrücke können beliebig verschachtelt werden. Schlüsselwörter werden klein geschrieben und sind bis auf wenige Ausnahmen nicht reserviert.

Die Abfragen werden aus mehreren Modulen zusammengestellt. Das Hauptmodul besteht aus einem optionalen Prolog und dem Teil, in dem die eigentliche Abfrage formuliert wird, der Query Body. Des Weiteren sind Bibliotheksmodule für beispielsweise benutzerdefinierte Funktionen möglich.

Der Prolog gliedert sich in zwei Teile. Im ersten Teil ist es möglich Einstellungen zu machen, welche die Verarbeitung durch den XQuery-Prozessor beeinflussen. Der zweite Teil ist für die Deklaration von Variablen und dem Import von Funktionen und Optionen vorgesehen.

Folgendes XML-Dokument soll als Basis für Beispiele und Erläuterungen dienen.

Arithmetik

XQuery besitzt eine Reihe von arithmetischen Operatoren zur Addition, Subtraktion, Multiplikation, Division und Modulu-Berechnung. Dabei ist der erste Schritt die Evaluierung der Operanden und erst danach die Anwendung der Operatoren. Die Ergebnisse dieser Berechnungen geben immer einen atomaren Wert zurück. Anhand der Verwendung der in ihnen benutzten Operatoren unterscheidet man in folgenden drei Kategorien:

• additive Ausdrücke
• multiplikative Ausdrücke
• unäre Ausdrücke

Additive Ausdrücke

Der Plus-Operator

Der Plus-Operator bildet die Summe aus 2 oder mehr Opperanden. Er ist durch die Funktion op:numeric-add() definiert.

 Syntax: Operand1 + Operand2

Der Minus-Operator

Der Minus-Operator bildet die Differenz seiner Operanden und ist durch die Funktion op:numeric-subtract() definiert. Damit er nicht als Teil der vorangehenden Zeichenkette interpretiert werden könnte, sollte vor dem Operator ein Leerzeichen stehen.

 Syntax: Operand1 - Operand2

Multiplikative Ausdrücke

Der mal-Operator

Der mal-Operator bildet das Produkt seiner Operanden. Seine Funktion ist definiert in op:nemeric-multiply().

  Syntax: Operand1 * Operand2

Der div-Operator

Der Divisions-Operator berechnet und definiert den Quotient seiner Operanden. Seine Funktion entspricht op:numeric-divide()

  Syntax: Operand1 div Operand2

Der idiv-Operator

Dieser Operator berechnet zwar auch den Quotienten seiner Operanden, jedoch berücksichtigt er den Rest nicht. Die Funktion dieses Operators ist op:numeric-integer divide().

  Syntax: Operand1 div Operand2 ( äquivalent zur Syntax xs:integer ( Operand1 div Operand2) )

Der mod-Operator

Der "mod"-Operator berechnet den Rest der einer Division. Seine Funktion ist über op:numeric-mod() definiert. Ist der erste Operand negativ so ist das Ergebnis negativ. Ist das der erste Operand positiv so trifft das auch beim Ergebnis zu.

  Syntax: Operand1 mod Operand2

Unäre Ausdrücke

In XQuery sind die unären Operatoren "+" und "-" definiert. Damit die Kompatibilität mit mit XPath 1.0 gewährleistet ist sind in XQuery mehrere aufeinender folgende unäre Operatoren erlaubt. Die unären Operatoren haben außerdem eine höhere Priorität als binäre. Dem zu Folge werden unäre eher ausgewertet.

Unäres-Plus

Der unäre Plus-Operator gibt den Operanden mit unveränderten Vorzeichen zurück. Er ist definiert in der Funktion op:numeric-unary-plus().

  Syntax: + Operand

Unäres-Minus

Der unäre Minus-Operator gibt den Operanden mit umgekehrten Vorzeichen zurück. Seine Definition ist op:numeric-unary-minus().

  Syntax: - Operand

FLWOR - Ausdrücke

FLWOR-Ausdrücke bilden die Grundlage für Anfragen an XML-Dokumente. Der Ausdruck bindet Variablen an Ergebnisse von Ausdrücken, wertet darauf in einer where-Klausel ein Prädikat aus und konstruiert ein neues Dokument als Resultat. FLWOR-Ausdrücke weisen Ähnlichkeiten mit Abfragen im SQL-Syntax auf. FLWOR ist ein Kunstwort (aus dem englischen "Flower"). Die einzelnen Buchstaben entsprechen dabei den Anfangsbuchstaben der Klauseln des Ausdrucks: for, let, where, order und return.

Ein einfacher FLWOR-Ausdruck ist zum Beispiel folgendes:

Dieser Ausdruck gibt alle Filmtitel aus dem Beispiel XML-Dokument "filmliste" zurück.

Mit einer zusätzlichen where-Klausel kann die Ergebnismenge weiter eingegrenzt werden.

Die gleiche Abfrage könnte auch mit Hilfe des folgenden XPath-Ausdrucks ausgeführt werden.

/filmliste/film[jahr=2009]/titel 

Der XPath-Ausdruck liefert genau die selbe Ergebnismenge wie der XQuery-Ausdruck. Es gilt: Jeder gültige XPath-Ausdruck ist auch in XQuery zulässig. Jedoch sind FLWOR-Ausdrücke in XQuery weitaus leistungsfähiger, wenn es darum geht, mit Hilfe von Joins Abfragen über mehrere XML-Dokumente auszuführen.

Die for-Klausel

In der for-Klausel wird über eine Sequenz iteriert. Es handelt sich entweder um eine Sequenz von Knoten oder um eine Sequenz aus atomaren Werten. Es kann eine beliebige Operation auf alle Elemente der Sequenz angewendet werden.

Bei $i handelt es sich um die Iterationsvariable, welche jeden Wert der Sequenz einmal annimmt. Es ist mehr als eine for-Klausel pro Ausdruck möglich.

Ein FLWOR-Ausdruck kann an jeder beliebigen Stelle stehen an der ein Ausdruck erlaubt ist. Beispielsweise kann ein FLWOR-Ausdruck als Argument an eine Funktion übergeben werden. Die Funktion avg() berechnet den Durchschnitt aus der Sequenz, welche der FLWOR-Ausdruck zurückgibt. Im Beispiel wird die durchschnittliche Anzahl der Regisseure ermittelt, die an einem Film gearbeitet haben.

Die let-Klausel

Mit Hilfe der let-Klausel ist es möglich Variablen zu deklarieren. Im Gegensatz zur for–Klausel, in der die Listenelemente durchlaufen werden, ist in der let–Klausel die Variable immer an das Element gebunden. Das kann ein atomarer Wert sein oder eine Sequenz. Der Wert der Variablen, welche mit let deklariert wurde, wird in jedem Schleifendurchlauf neu belegt.

Die where-Klausel

Die where–Klausel wird dazu verwendet die gesuchten Elemente aus einer Sequenz zu filtern. Es wird anhand eines Prädikats entschieden ob das Element in die Ergebnismenge aufgenommen werden soll oder nicht. In der where–Klausel können sich weitere Ausdrücke befinden. Die Verwendung einer where-Klausel in einem XQuery–Ausdruck ist optional. Wenn sie aber verwendet wird, dann darf es nur eine where-Klausel nach den for- und let -Klauseln im entsprechenden XQuery–Ausdruck geben. Das where in XQuery ist vergleichbar mit dem where in SQL.

Die order-by-Klausel

Mit der order by–Klausel ist eine Sortierung der Ergebnismenge möglich. Mit dem Schlüsselwort ascending lässt sich die Ergebnismenge aufsteigend sortieren bzw. mit descending absteigend. Die Klausel ist genau wie die where-Klausel optional. Ohne order by werden die Elemente in der Ergebnissequenz in der Reihenfolge ausgegeben wie sie im abgefragten XML-Dokument auftreten.

Die return-Klausel

Jeder FLWOR–Ausdruck hat eine return–Klausel. Mit ihrer Hilfe wird das Ergebnis konstruiert. Im return Teil können Konstruktoren zum Einsatz kommen. Für jeden Knotentyp gibt es einen Konstruktor, der eine Instanz vom jeweiligen Knotentyp erzeugt. Zum Beispiel einen Elementknoten.

Unter unten stehendem Link finden Sie Übungsaufgaben zu den FLWOR-Ausdrücken, die Ihnen helfen sollen, den Umgang mit den in XQuery häufig vorkommenden Ausdrücken einzuüben.

• Übungsaufgaben

Joins

Mit Hilfe von Joins können mehrere Eingabedokumente zu einer Ergebnismenge zusammengeführt werden. In XQuery geschieht dies mit geschachtelten FLWOR-Ausdrücken.

Für das Beispiel wird ein weiteres XML-Dokument verwendet.

<schauspieler>
   <name>Ford</name>
   <vorname>Harrison</vorname>
   <filmid>1</filmid>
</schauspieler>
    
<schauspieler>
   <name>Hamill</name>
   <vorname>Mark</vorname>
   <filmid>1</filmid>
</schauspieler>
   
<schauspieler>
   <name>Alba</name>
   <vorname>Jessica</vorname>
   <filmid>2</filmid>
</schauspieler>
   
<schauspieler>
    <name>Dawson</name>
    <vorname>Rosario </vorname>
    <filmid>2</filmid>
</schauspieler>
   
<schauspieler>
     <name>Wood</name>
     <vorname>Elijah </vorname>
     <filmid>2</filmid>
</schauspieler>
   
<schauspieler>
     <name>Willis</name>
     <vorname>Bruce </vorname>
     <filmid>2</filmid>
</schauspieler>
   
<schauspieler>
     <name>Hanks</name>
     <vorname>Tom </vorname>
     <filmid>3</filmid>
</schauspieler>
   
<schauspieler>
     <name>Bale</name>
     <vorname>Christian </vorname>
     <filmid>4</filmid>
</schauspieler>
   
<schauspieler>
      <name>Ledger</name>
      <vorname>Heath </vorname>
      <filmid>4</filmid>
</schauspieler>
   
<schauspieler>
       <name>Eckhart</name>
       <vorname>Aaron </vorname>
       <filmid>4</filmid>
</schauspieler>
   
<schauspieler>
       <name>Worthington</name>
       <vorname>Sam</vorname>
       <filmid>5</filmid>
</schauspieler>
   
<schauspieler>
       <name>Saldana</name>
       <vorname>Zoe</vorname>
       <filmid>5</filmid>
</schauspieler>
   

Es sollen die Schauspieler ermittelt werden, welche im Film "Sin City" mitgespielt haben.

for $filme in //filmliste/film
where $filme/titel = "Sin City"
return <besetzung>{
(
for $schauspieler in //schauspielerliste/schauspieler
where schauspieler/filmid = filme/@id
return <schauspieler>{(schauspieler/vorname, schauspieler/name)}</schauspieler>
)
}</besetzung>

Die Ergebnismenge der obigen Anfrage:

<besetzung>
  <schauspieler>
     <vorname>Jessica</vorname>
     <name>Alba</name>
  </schauspieler>
  <schauspieler>
     <vorname>Rosario </vorname>
     <name>Dawson</name>
  </schauspieler>
  <schauspieler>
     <vorname>Elijah </vorname>
     <nam>Wood
  </nam></schauspieler>
  <schauspieler>
     <vorname>Bruce </vorname>
     <name>Willis</name>
  </schauspieler>
</besetzung>

Vordefinierte Funktionen

In XQuery gibt es mehr als 100 vordefinierte Funktionen, die die Datenabfrage aus XML-Dokumenten unterstützen. Beispielsweise die data Funktion. Mit ihrer Hilfe kann der Wert eines Knotens zurückgegeben jedoch nicht der komplette Knoten mit Start- und Endtag.

Unter anderem gibt es Funktionen für die Arbeit mit Strings, Datumsangaben, Knoten, Sequenzen und boolschen Werten. Eine Übersicht über vordefinierte XQuery Funktionen findet sich hier.

http://www.xqueryfunctions.com/

Benutzerdefinierte Funktionen

XQuery bietet die Möglichkeit Funktionen selbst zu deklarieren. Eine benutzerdefinierte Funktionen beginnt mit declare function gefolgt von einem Präfix extern oder local. Lokale Funktionen innerhalb eines Hauptmoduls werden mit dem Präfix local definiert. Local ist an den Namensraum http://www.w3.org/2005/xquery-local-functions gebunden. Des Weiteren besteht die Funktion aus einem Funktionskopf, welcher den Namen der Funktion enthält. Sowie die an die Funktion übergebenen Argumente und dem Datentyp des Rückgabewertes. Den Funktionsrumpf bildet ein Xquery-Ausdruck.

Benutzerdefinierte Funktionen können auch rekursiv definiert werden.

• Übungsaufgaben

If-Then-Else Anweisungen

XQuery unterstütz If-Then-Else Anweisungen. Dabei wird wie auch in anderen Sprachen üblich in Abhängigkeit eines boolschen Wertes, entweder der then-Ausdruck oder der else-Ausdruck einer If-Then-Else Anweisung ausgewertet. Der zu testende Ausdruck muss in Klammern stehen. Das else muss in XQuery immer enthalten sein. Wenn es nicht benötigt wird kann auch () (leere Sequenz) zurückgegeben werden. Es ist möglich mehrere If-Then-Else –Anweisungen zu schachteln.

• Übungsaufgaben

Datums- und Zeitausdrücke

Das Rechnen mit Zeitausdrücken in XQuery ist sehr komfortabel. Beispielsweise ist es sehr schnell möglich den Zeitraum zwischen zwei Datumsangaben zu berechnen, wie das Beispiel zeigt.

Auf die selbe Art und Weise können einzelne Zeiträume zu einem großen Zeitraum addiert werden. Weiterhin bietet XQuery vordefinierte Funktionen an um aus Zeiträumen die Anzahl der Tage, Stunden etc. zu extrahieren.

• Übungsaufgaben

Quellen / Weiterführendes

Quellen

• Helmut Vonhoegen: Einstieg in XML, Galileo Computing, 2011
• Alfred Moss: XQuery und SQL/XML in DB2-Datenbanken, Vieweg + Teubner, 2008

Weiterführende Links

http://www.w3.org/XML/Query/

http://www.w3.org/TR/xquery-update-10/