Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
m
{{Mark|Introduced with Version 9.0:}}
{{Mark|Updated with Version 9.0:}} {{Code|$cache}} argument removed.
{{Mark|Updated with Version 9.0:}} Renamed (old name: <code>prof:mem</code>); {{Code|$cache}} argument removed.
Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"
==prof:track==
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|prof:track|$expr as item()|item()*}}<br/pre>{{Func|prof:track|( $expr input as item()*, $options as map(*)|? := map { }) as item()*}}</pre>|-valign="top"
| '''Summary'''
|Measures the execution time and memory consumption required for evaluating the specified {{Code|$expressioninput}} and returns a map with the results. The following {{Code|$options}} are available:* {{Code|memorytime}}: Enables Include execution time profiling in result as {{Code|xs:decimal}} (unit: milliseconds; default: true).* {{Code|timememory}}: Enables Include memory profiling consumption in result as {{Code|xs:integer}} (unit: bytes; default: truefalse).* {{Code|value}}: Returns the Include value in result (default: true).
Helpful notes:
* If you are not interested in some of the returned results, you should disable them to save time and memory.
* Profiling might change the execution behavior of your code: An expression that might be executed iteratively will be cached by the profiling function.
* If a value has a compact internal representation, memory consumption will be very low, even if the serialized result may consume much more memory.
* In Java, Please note that memory profiling can is only be approximative: To improve the measurement, and if so it can be quite misleading. If the memory option is enabled, main-memory will be garbage-collected before and after evaluation. If you are not interested in to improve the quality of the memory consumption, it is advisable to disable this optionmeasurement.|-valign="top"
| '''Properties'''
|The function is ''non-deterministicnondeterministic'': evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
|
* Return a human-readable representation of the memory consumption caused by fetching an XML document (<code>. {{Function||fetch:xml</code> doc}} is used, as <code>fn:doc</code> may already be evaluated at compilation time):<pre classlang="brush:'xquery"'>prof:track(fetch:xmldoc('factbook.xml'))?memory
=> prof:human()
</pre>
* The function call <code>prof:track((1 to 1000000)[. mod 2 = 0], map { 'time': false() })</code> will return something similar to:<pre classlang="brush:'xquery"'>
map {
"memory": 41548400, "time": 34.9921548400,
"value": (2, 4, 6, 8, 10, ...)
}
==prof:time==
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|prof:time|$expr as item()|item()*}}<br /pre>{{Func|prof:time|( $expr input as item(), $label as xs:string|? := ()) as item()*}}</pre>|-valign="top"
| '''Summary'''
|Measures the time needed to evaluate {{Code|$exprinput}} and outputs a string to standard error or, if the GUI is used, to the Info View. An optional {{Code|$label}} may be specified to tag the profiling result. See {{Function|Profiling|prof:track}} for further notes.|-valign="top"
| '''Properties'''
|The function is ''non-deterministicnondeterministic'': evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
|
==prof:memory==
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|prof:memory|$expr as item()|item()*}}<br/pre>{{Func|prof:memory|( $expr input as item(), $label as xs:string|? := ()) as item()*}}</pre>|-valign="top"
| '''Summary'''
|Measures the memory allocated by evaluating {{Code|$exprinput}} and outputs a string to standard error or, if the GUI is used, to the Info View. An optional {{Code|$label}} may be specified to tag the profiling result. See {{Function|Profiling|prof:track}} for further notes.|-valign="top"
| '''Properties'''
|The function is ''non-deterministicnondeterministic'': evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:current-ms||() as xs:integer}}<br /pre>|-valign="top"
| '''Summary'''
|Returns the number of milliseconds passed since 1970/01/01 UTC. The granularity of the value depends on the underlying operating system and may be larger. For example, many operating systems measure time in units of tens of milliseconds.
|-valign="top"
| '''Properties'''
|In contrast to {{Code|fn:current-time()}}, the function is ''non-deterministicnondeterministic'' and returns different values every time it is called. Its evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:current-ns||() as xs:integer}}<br /pre>|-valign="top"
| '''Summary'''
|Returns the current value of the most precise available system timer in nanoseconds.
|-valign="top"
| '''Properties'''
|In contrast to {{Code|fn:current-time()}}, the function is ''non-deterministicnondeterministic'' and returns different values every time it is called. Its evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
| Measures the time of an expression:
<pre classlang="brush:'xquery"'>
let $ns1 := prof:current-ns()
return (
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|prof:dump|$expr as item()|empty-sequence()}}<br /pre>{{Func|prof:dump|( $expr input as item()*, $label as xs:string|? := ()) as empty-sequence()}}<br /pre>|-valign="top"
| '''Summary'''
|Dumps a serialized representation of {{Code|$exprinput}} to {{Code|STDERR}}, optionally prefixed with {{Code|$label}}, and returns an empty sequence. If the GUI is used, the dumped result is shown in the [[Graphical User Interface#Visualizations|Info View]].|-valign="top"
| '''Properties'''
|In contrast to {{Code|fn:trace()}}, the consumed expression will not be passed on.
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:variables||() as empty-sequence()}}</pre>|-valign="top"
| '''Summary'''
|Prints a list of all current local and global variable assignments to standard error or, if the GUI is used, to the Info View.<br />As every query is optimized before being evaluated, not all of the original variables may be visible in the output. Moreover, many variables of function calls will disappear because functions are inlined. Function inlining can be turned off by setting the [[Options#INLINELIMIT{{Option|INLINELIMIT]] option }} to <code>0</code>.|-valign="top"
| '''Properties'''
|The function is ''non-deterministicnondeterministic'': evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
|
* {{Code|for $x in 1 to 2 return ($x, prof:variables())}} will dump the values of <code>$x</code> to standard error.
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:type|( $expr as item()*|) as item()*}}</pre>|-valign="top"
| '''Summary'''
|Similar to {{Code|fn:trace($expr, $msg)}}, but instead of a user-defined message, it emits the compile-time type and estimated result size of its argument.
|}
==prof:gc==
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|<pre>prof:gc(
$count as xs:integer := ()
) as empty-sequence()</pre>
|- valign="top"
| '''Summary'''
|Enforces Java garbage collection. If no {{Code|$count}} is supplied, garbage will be collected once. Please note that this function should only be used for debugging purposes; in productive code, it is best to trust the garbage collecting strategies of Java.
|}
==prof:runtime==
{| width='100%'
|- valign="top"
| width='120' | '''Signature'''
|<pre>prof:runtime(
$option as xs:string
) as xs:integer</pre>
|- valign="top"
| '''Summary'''
|Returns the value of the specified runtime {{Code|$option}}. The following options are available:
* {{Code|max}}: Maximum memory that the Java virtual machine will attempt to use.
* {{Code|total}}: Total memory in the Java virtual machine (varies over time).
* {{Code|used}}: Currently used memory (varies over time, will shrink after garbage collection).
* {{Code|processors}}: number of processors available to the Java virtual machine.
|- valign="top"
|{{Code|option}}
|The specified option is unknown.
|- valign="top"
| '''Examples'''
|
* <code>prof:gc(3), prof:human(prof:runtime('used'))</code> performs some garbage collection and returns the currently used amount of memory in a user-friendly format.
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:void|( $value input as item()*|) as empty-sequence()}}</pre>|-valign="top"
| '''Summary'''
|Swallows all items of Absorbs the specified {{Code|$valueinput}} and returns an empty sequence. This function is helpful if some (often nondeterministic or side-effecting) code needs to be evaluated and if the actual result resulting value is irrelevantnot required.|-valign="top"
| '''Properties'''
|The function is ''non-deterministicnondeterministic'': evaluation order will be preserved by the compiler.|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:sleep|( $ms as xs:integer|) as empty-sequence()}}<br /pre>|-valign="top"
| '''Summary'''
|Sleeps for the specified number of milliseconds.
|-valign="top"
| '''Properties'''
|The function is ''non-deterministicnondeterministic'': evaluation order will be preserved by the compiler.
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>prof:human|( $number as xs:integer|) as xs:string}}</pre>|-valign="top"
| '''Summary'''
|Returns a human-readable representation of the specified {{Code|$number}}.
|-valign="top"
| '''Example'''
|
* {{Code|prof:human(16384)}} returns {{Code|16K}}.
|}
=Errors=
{| class="wikitable" width="100%"
! width="110"|Code
|Description
|- valign="top"
|{{Code|option}}
|The specified option is unknown.
|}
=Changelog=
;Version 9.2
* Added: {{Function||prof:gc}}, {{Function||prof:runtime}}
* Updated: {{Function||prof:track}}: decimal timing results; by default no memory profiling
;Version 9.0
* Added: [[#prof:track{{Function||prof:track]]}}* Updated: renamed prof:mem to [[#{{Function||prof:memory}}, {{Function||prof:memory]]time}}: <code>$cache</code> argument removed
;Version 8.5
* Added: [[#prof:type{{Function||prof:type]] }} (moved from [[XQuery Module]])
;Version 8.1
* Added: [[#prof:variables{{Function||prof:variables]]}}
;Version 7.7
* Added: [[#prof:void{{Function||prof:void]]}}
;Version 7.6
* Added: [[#prof:human{{Function||prof:human]]}}
;Version 7.5
* Added: [[#prof:dump{{Function||prof:dump]]}}, [[#prof:current-ms{{Function||prof:current-ms]]}}, [[#prof:current-ns{{Function||prof:current-ns]]}}
This module was introduced with Version 7.3.
