XQuery Update - Revision history

Amanda: "b" tag was not being rendered, and escaping the left angle bracket seems to fix the problem

2024-03-25T22:00:53Z

"b" tag was not being rendered, and escaping the left angle bracket seems to fix the problem

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:34Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to "

2023-12-01T16:33:20Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG: Text replacement - "" to ""

2023-12-01T16:31:41Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG at 10:24, 26 October 2023

2023-10-26T10:24:41Z

CG: /* Example */

2023-05-16T12:58:32Z

Example

CG: /* Example */

2023-05-16T12:57:57Z

Example

CG: /* Example */

2023-05-16T12:57:23Z

Example

CG: /* User-Defined Functions */

2023-05-16T12:54:08Z

User-Defined Functions

CG: /* Functions */

2023-05-16T12:45:30Z

Functions

@@ Line 240: / Line 240: @@
 </pre>
-Despite explicitly renaming all child nodes of {{Code|<doc/>}}, the former {{Code|<a/>}} element is the only one to be renamed. The {{Code|<b/>}} element is inserted within the same snapshot and is therefore not yet visible to the user.
+Despite explicitly renaming all child nodes of {{Code|<doc/>}}, the former {{Code|<a/>}} element is the only one to be renamed. The {{Code|&lt;b/>}} element is inserted within the same snapshot and is therefore not yet visible to the user.
 ==Returning Results==

@@ Line 87: / Line 87: @@
 ;Result:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <entry>
    <title>Copy of: Transform expression example</title>
@@ Line 230: / Line 230: @@
 …applied on the document…
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <doc> <a/> </doc>
 </pre>
@@ Line 236: / Line 236: @@
 …results in the following document:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <doc> <renamed/><b/> </doc>
 </pre>

@@ Line 14: / Line 14: @@
 ===insert===
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 insert node (attribute { 'a' } { 5 }, 'text', <e/>) into /n
 </pre>
@@ Line 24: / Line 24: @@
 ===delete===
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 delete node //n
 </pre>
@@ Line 32: / Line 32: @@
 ===replace===
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 replace node /n with <a/>
 </pre>
@@ Line 38: / Line 38: @@
 The target element is replaced by the DOM node <code><a/></code>. You can also replace the value of a node and its descendants by using the modifier '''value of''':
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 replace value of node /n with 'newValue'
 </pre>
@@ Line 46: / Line 46: @@
 ===rename===
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 for $n in //originalNode
 return rename node $n as 'renamedNode'
@@ Line 59: / Line 59: @@
 ===copy/modify/return===
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 copy $c := doc('example.xml')//originalNode
 modify rename node $c as 'copyOfNode'
@@ Line 71: / Line 71: @@
 ;Query:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 copy $c :=
    <entry>
@@ Line 97: / Line 97: @@
 Instead of the main-memory {{Code|<entry>}} element, a database node can be supplied:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 copy $c := (db:get('example')//entry)[1]
 ...
@@ Line 106: / Line 106: @@
 Entire documents can be copied and modified:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 copy $doc := doc("zaokeng.kml")
 modify (
@@ Line 122: / Line 122: @@
 The {{Code|update}} expression is a BaseX-specific convenience operator for the bulky {{Code|copy/modify/return}} construct. Similar to the [[XQuery 3.0#Simple Map Operator|XQuery 3.0 map operator]], the nodes resulting from the first expression are bound as context items, and the bracketed expressions performs updates on the item. The updated nodes is returned as result:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 for $item in db:get('data')//item
 return $item update {
@@ Line 131: / Line 131: @@
 If multiple nodes are supplied as input, the updates will subsequently be performed on each node:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 db:get('data')//item update {
    delete node text()
@@ Line 139: / Line 139: @@
 It is easy to chain subsequent update expressions:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 <root/> update {
    insert node <child/> into .
@@ Line 151: / Line 151: @@
 The {{Code|transform with}} expression was added to the current [https://www.w3.org/TR/xquery-update-30/#id-transform-with XQuery Update 3.0] working draft. It is a simplified version of the [[#update|update]] expression (it is limited to single input nodes and cannot be chained):
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 <xml>text</xml> transform with {
    replace value of node . with 'new-text'
@@ Line 176: / Line 176: @@
 Functions that performs updates need to be marked with an {{Code|%updating}} annotation:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare %updating function local:add($target, $node) {
    insert node $node into $target
@@ Line 188: / Line 188: @@
 If update operations are defined in an anonymous function, it may be necessary to call the function with an additional {{Code|updating}} keyword:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $add := %updating function($target, $node) {
    insert node $node into $target
@@ Line 223: / Line 223: @@
 The query…
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 insert node <b/> into /doc,
 /doc/* ! (rename node . as 'renamed')
@@ Line 248: / Line 248: @@
 * The BaseX-specific {{Function|Update|update:output}} function bridges this gap: it caches the results of its arguments at runtime and returns them after all updates have been processed. The following example performs an update and returns a success message:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 update:output("Update successful."), insert node <c/> into doc('factbook')/mondial
 </pre>

@@ Line 16: / Line 16: @@
 <syntaxhighlight lang="xquery">
 insert node (attribute { 'a' } { 5 }, 'text', <e/>) into /n
-</syntaxhighlight>
+</pre>
 Insert enables you to insert a sequence of nodes into a single target node. Several modifiers are available to specify the exact insert location: insert into '''as first'''/'''as last''', insert '''before'''/'''after''' and insert '''into'''.
@@ Line 26: / Line 26: @@
 <syntaxhighlight lang="xquery">
 delete node //n
-</syntaxhighlight>
+</pre>
 The example query deletes all <code><n></code> elements in your database. In contrast to other updating expressions, multiple nodes can be supplied as a target.
@@ Line 34: / Line 34: @@
 <syntaxhighlight lang="xquery">
 replace node /n with <a/>
-</syntaxhighlight>
+</pre>
 The target element is replaced by the DOM node <code><a/></code>. You can also replace the value of a node and its descendants by using the modifier '''value of''':
@@ Line 40: / Line 40: @@
 <syntaxhighlight lang="xquery">
 replace value of node /n with 'newValue'
-</syntaxhighlight>
+</pre>
 All descendants of /n are deleted, and the supplied text is inserted as the only child. The result of the insert sequence is either a single text node or an empty sequence. If the insert sequence is empty, all descendants of the target are deleted. Consequently, replacing the value of a node leaves the target with either a single text node or no descendants at all.
@@ Line 49: / Line 49: @@
 for $n in //originalNode
 return rename node $n as 'renamedNode'
-</syntaxhighlight>
+</pre>
 All <code>originalNode</code> elements are renamed. A loop can be used to modify multiple nodes within a single statement. Nodes on the {{Code|descendant}} or {{Code|attribute}} axis of the target are not affected.
@@ Line 63: / Line 63: @@
 modify rename node $c as 'copyOfNode'
 return $c
-</syntaxhighlight>
+</pre>
 A copy of the {{Code|originalNode}} element is created, renamed and returned; the original document will not be updated.
@@ Line 83: / Line 83: @@
+)
 return $c
-</syntaxhighlight>
+</pre>
 ;Result:
@@ Line 93: / Line 93: @@
    <author>Joey</author>
 </entry>
-</syntaxhighlight>
+</pre>
 Instead of the main-memory {{Code|<entry>}} element, a database node can be supplied:
@@ Line 100: / Line 100: @@
 copy $c := (db:get('example')//entry)[1]
 ...
-</syntaxhighlight>
+</pre>
 In this case, the database node remains untouched, as all updates are performed on the node copy.
@@ Line 116: / Line 116: @@
+)
 return $doc
-</syntaxhighlight>
+</pre>
 ===update===
@@ Line 127: / Line 127: @@
    delete node ./text()
+}
-</syntaxhighlight>
+</pre>
 If multiple nodes are supplied as input, the updates will subsequently be performed on each node:
@@ Line 135: / Line 135: @@
    delete node text()
+}
-</syntaxhighlight>
+</pre>
 It is easy to chain subsequent update expressions:
@@ Line 145: / Line 145: @@
    insert node "text" into child
+}
-</syntaxhighlight>
+</pre>
 ===transform with===
@@ Line 155: / Line 155: @@
    replace value of node . with 'new-text'
+}
-</syntaxhighlight>
+</pre>
 ==Functions==
@@ Line 184: / Line 184: @@
    local:add(., <sub/>)
+}
-</syntaxhighlight>
+</pre>
 If update operations are defined in an anonymous function, it may be necessary to call the function with an additional {{Code|updating}} keyword:
@@ Line 195: / Line 195: @@
    updating $add(., <sub/>)
+}
-</syntaxhighlight>
+</pre>
 =Concepts=
@@ Line 226: / Line 226: @@
 insert node <b/> into /doc,
 /doc/* ! (rename node . as 'renamed')
-</syntaxhighlight>
+</pre>
 …applied on the document…
@@ Line 232: / Line 232: @@
 <syntaxhighlight lang="xml">
 <doc> <a/> </doc>
-</syntaxhighlight>
+</pre>
 …results in the following document:
@@ Line 238: / Line 238: @@
 <syntaxhighlight lang="xml">
 <doc> <renamed/><b/> </doc>
-</syntaxhighlight>
+</pre>
 Despite explicitly renaming all child nodes of {{Code|<doc/>}}, the former {{Code|<a/>}} element is the only one to be renamed. The {{Code|<b/>}} element is inserted within the same snapshot and is therefore not yet visible to the user.
@@ Line 250: / Line 250: @@
 <syntaxhighlight lang="xquery">
 update:output("Update successful."), insert node <c/> into doc('factbook')/mondial
-</syntaxhighlight>
+</pre>
 * With {{Option|MIXUPDATES}}, all updating constraints will be turned off. Returned nodes will be copied before they are modified by updating expressions. An error is raised if items are returned within a transform expression.

@@ Line 119: / Line 119: @@
 ===update===
 The {{Code|update}} expression is a BaseX-specific convenience operator for the bulky {{Code|copy/modify/return}} construct. Similar to the [[XQuery 3.0#Simple Map Operator|XQuery 3.0 map operator]], the nodes resulting from the first expression are bound as context items, and the bracketed expressions performs updates on the item. The updated nodes is returned as result:
@@ Line 207: / Line 205: @@
 ==Pending Update List==
 Updating statements are not executed immediately, but are first collected as update primitives within a set-like structure, the so-called Pending Update List (PUL). After the evaluation of the query, and after some consistency checks and optimizations, the update primitives will be applied in the following order:

@@ Line 163: / Line 163: @@
 ===Built-in Functions===
-{{Code|fn:put()}} can be used to serialize nodes to secondary storage:
+Numerous [[Database Module#Updates|Database Functions]] exist in BaseX for performing document- and database-wide updates.
 * The function will be executed after all other updates.
@@ Line 170: / Line 172: @@
 * Serialization parameters can be specified as third argument (more details are found in the [https://www.w3.org/TR/xquery-update-30/#id-func-put XQUF 3.0 Specification]).
-Numerous additional [[Database Module#Updates|database functions]] exist for performing updates on document and database level.
+If you want to write intermediate results to files, it is more flexible to use {{Function|File|file:write}}.
 ===User-Defined Functions===
-If an updating function item is called, the function call must be prefixed with the keyword {{Code|updating}}. This ensures that the query compiler can statically detect whether an invoked function item will perform updates or not:
+If an updating function item is called, the function call must be prefixed with the {{Code|updating}} keyword. This ensures that the query compiler can statically detect whether an invoked function item will perform updates or not:
 <syntaxhighlight lang="xquery">