Difference between revisions of "Utility Module"
Line 1: | Line 1: | ||
This [[Module Library|XQuery Module]] contains some utility and helper functions. | This [[Module Library|XQuery Module]] contains some utility and helper functions. | ||
− | With {{Announce|Version 11}}, many functions have been removed | + | With {{Announce|Version 11}}, many functions have been removed in favor or new features of XQuery 4: |
{| | {| |
Revision as of 17:36, 21 November 2023
This XQuery Module contains some utility and helper functions.
With Version 11, many functions have been removed in favor or new features of XQuery 4:
BaseX 10 | XQuery 4 |
util:array-members
|
array:members
|
util:array-values
|
array:values
|
util:chars
|
fn:characters
|
util:duplicates
|
fn:duplicate-values
|
util:if
|
if($test) { $then } else { $else } (with the new syntax, the else branch is optional)
|
util:init
|
fn:trunk
|
util:intersperse
|
fn:intersperse
|
util:item
|
fn:items-at
|
util:last
|
fn:foot
|
util:map-entries
|
map:pairs
|
util:map-values
|
map:values
|
util:or
|
$expr1 otherwise $expr2
|
util:replicate
|
fn:replicate
|
Contents
Conventions
All functions and errors in this module and errors are assigned to the http://basex.org/modules/util
namespace, which is statically bound to the util
prefix.
Range Conditions
util:count-within
Signature | util:count-within( $sequence as item()*, $min as xs:integer, $max as xs:integer := () ) as xs:boolean |
Summary | Checks if the specified $sequence has at least $min and, optionally, at most $max items. Equivalent to:
<syntaxhighlight lang="xquery"> let $count := count($sequence) return $count >= $min and $count <= $max </syntaxhighlight> |
Examples |
|
util:range
Signature | util:range( $sequence as item()*, $first as xs:double, $last as xs:double ) as item()* |
Summary | Returns items from $sequence , starting at position $first and ending at $last . Equivalent to:
<syntaxhighlight lang="xquery"> subsequence($sequence, $first, $last - $first + 1) </syntaxhighlight> |
Examples |
|
Node Functions
util:ddo
Signature | util:ddo( $nodes as node()* ) as node()* |
Summary | Returns nodes in distinct document order: duplicate nodes will be removed, and the remaining nodes will be returned in document order. As results of path expressions are brought distinct document order before they are returned, the function is equivalent to:
<syntaxhighlight lang="xquery"> $nodes/self::node() </syntaxhighlight> |
util:root
Signature | util:root( $nodes as node()* ) as document-node()* |
Summary | Returns the document nodes of the specified $nodes . The path expression /abc is internally represented as util:root(.)/abc . Equivalent to:
<syntaxhighlight lang="xquery"> $nodes ! / </syntaxhighlight> |
util:strip-namespaces
Signature | util:strip-namespaces( $node as node(), $prefixes as xs:string* := () ) as node() |
Summary | Removes namespaces with the specified $prefixes from the supplied $node . An empty string can be supplied to remove the default namespace. If no prefixes are specified, all namespaces will be removed.
|
Examples |
<syntaxhighlight lang="xquery"> util:strip-namespaces(<xml xmlns='uri' xmlns:prefix='uri2' prefix:name='value'><prefix:child/></xml>) (: yields :) <xml name='value'><child/></xml> </syntaxhighlight>
<syntaxhighlight lang="xquery"> <xml xmlns='uri1'><child xmlns='uri2'/></xml> => util:strip-namespaces() </syntaxhighlight> |
Errors
Code | Description |
---|---|
negative
|
The specified number is negative. |
Changelog
- Version 11.0
- Removed:
util:array-members
,util:array-values
,util:chars
,util:duplicates
,util:init
,util:intersperse
,util:item
,util:last
,util:map-entries
,util:map-values
,util:replicate
- Version 9.7
- Added:
util:strip-namespaces
- Updated:
util:count-within
: Renamed fromutil:within
.
- Version 9.5
- Added:
util:intersperse
,util:within
,util:duplicates
,util:array-members
,util:array-values
,util:map-entries
,util:map-values
- Updated:
util:replicate
: Third argument added.
- Version 9.4
- Added:
util:root
- Version 9.3
- Added:
util:ddo
- Version 9.2
- Added:
util:chars
,util:init
- Updated:
util:item
,util:last
,util:range
renamed (before:util:item-at
,util:item-range
,util:last-from
)
- Version 9.1
- Version 9.0
- Added:
util:replicate
The Module was introduced with Version 8.5.