Changes

This [[Module Library|XQuery Module]] contains various testingfunctions to test and profile code, profiling and helper functionsto dump information to standard output.

All functions and errors in this module are assigned to the {{Code|<code><nowiki>http://basex.org/modules/prof}} </nowiki></code> namespace, which is statically bound to the {{Code|prof}} prefix.<br/>All errors are assigned to the {{Code|http://basex.org/errors}} namespace, which is statically bound to the {{Code|bxerr}} prefix.

=Performance Functions=

==prof:timetrack==

| width='90120' | '''Signatures'''|{{Func|prof:timetrack|$expr expression as item()|item()*}}<br />{{Func|prof:timetrack|$expr expression as item(), $cache options as xs:boolean|itemmap()*}}<br />{{Func|prof:time|$expr as item(), $cache as xs:boolean, $label as xs:string?|item()*}}

|Measures the execution time needed to evaluate and memory consumption required for evaluating the specified {{Code|$exprexpression}} and sends it to standard error or, if returns a map with the GUI is used, to the Info Viewresults.<br />If The following {{Code|$cacheoptions}} is set to are available:* {{Code|memory}}: Include memory consumption in result (unit: bytes; default: true).* {{Code|time}}: Include execution time in result (unit: milliseconds; default: true).* {{Code|value}}: 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 result execution behavior of your code: An expression that might be executed iteratively will be temporarily cachedby the profiling function. This way* If a value has a compact internal representation, memory consumption will be very low, a potential iterative execution of even if the expression (which often yields different serialized result may consume much more memory.* Please note that memory usage) profiling is blockedonly approximative, so it can be quite misleading.<br/>A thirdIf the memory option is enabled, optional argument {{Code|$label}} may main-memory will be specified garbage-collected before and after evaluation to tag improve the quality of the profiling resultmeasurement.

* {{Code|profReturn a human-readable representation of the memory consumption caused by fetching an XML document (<code>fetch:xml</code> is used, as <code>fn:doc</code> may already be evaluated at compilation time():<pre class="1 to 100000brush:xquery">prof:track(fetch:xml('factbook.xml')}} may output {{Code|25.69 ms}}.)?memory=> prof:human()</pre>* {{Code|The function call <code>prof:timetrack(("1 to 100000"1000000)[. mod 2 = 0], truemap { 'time': false()})}} may output </code> will return something similar to:<pre class="brush:xquery">map {{Code|208 "memory": 21548400, "value": (2, 4, 6, 8, 10, ...12 ms)}}.</pre>

==prof:memtime==

| width='90120' | '''Signatures'''|{{Func|prof:memtime|$expr as item()|item()*}}<br />{{Func|prof:memtime|$expr as item(), $cache as xs:boolean|item()*}}<br />{{Func|prof:mem|$expr as item(), $cache as xs:boolean, $label as xs:string|item()*}}

|Measures the memory allocated by evaluating time needed to evaluate {{Code|$expr}} and sends it outputs a string to standard error or, if the GUI is used, to the Info View.<br />If {{Code|$cache}} is set to {{Code|true()}}, the result will be temporarily cached. This way, a potential iterative execution of the expression (which often yields different memory usage) is blocked.<br/>A third, An optional argument {{Code|$label}} may be specified to tag the profiling result. See {{Function|Profiling|prof:track}} for further notes.

* {{Code|prof:mbtime("1 to 100000")}} may output {{Code|0 Bytes}}.* {{Code|prof:mb("1 to 100000", truesleep(1000))}} may output outputs something similar to {{Code|261000.678 mb99 ms}}.

==prof:sleepmemory==

| width='90120' | '''Signatures'''|{{Func|prof:sleepmemory|$ms expr as xs:integeritem()|empty-sequenceitem()*}}<br />{{Func|prof:memory|$expr as item(), $label as xs:string|item()*}}

|Sleeps for Measures the memory allocated by evaluating {{Code|$expr}} and outputs a string to standard error or, if the GUI is used, to the Info View. An optional {{Code|$label}} may be specified number of millisecondsto tag the profiling result. See {{Function|Profiling|prof:track}} for further notes.

==prof:humancurrent-ms== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|prof:current-ms||xs:integer}}<br />|-| '''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.|-| '''Properties'''|In contrast to {{Code|fn:current-time()}}, the function is ''non-deterministic'' and returns different values every time it is called. Its evaluation order will be preserved by the compiler.|-| '''Examples'''|* {{Code|convert:integer-to-dateTime(prof:current-ms())}} returns the current miliseconds in the {{Code|xs:dateTime}} format.|}

{{Mark|Introduced with Version 7.6==prof:}}current-ns==

| width='90120' | '''Signatures'''|{{Func|prof:humancurrent-ns||$number as xs:integer|xs:string}}<br />

|Returns a human-readable representation the current value of the specified most precise available system timer in nanoseconds.|-| '''Properties'''|In contrast to {{Code|$numberfn:current-time()}}, the function is ''non-deterministic'' and returns different values every time it is called. Its evaluation order will be preserved by the compiler.

| '''ExampleExamples'''|Measures the time of an expression:<pre class="brush:xquery">let $ns1 := prof:current-ns()return ( (: process to measure :) (1 to 1000000)[. = 0],* {{Code| let $ns2 := prof:humancurrent-ns() let $ms := (16384(($ns2 - $ns1)}} returns {{Codeidiv 10000) div 100) return $ms |16K}}.| ' ms')</pre>

| width='90120' | '''Signatures'''

==prof:current-msvariables==

| width='90120' | '''Signatures'''|{{Func|prof:current-msvariables||xs:integerempty-sequence()}}<br />

|Returns Prints a list of all current local and global variable assignments to standard error or, if the GUI is used, to the number of milliseconds passed since 1970Info View.<br /01/01 UTC. The granularity >As every query is optimized before being evaluated, not all of the value depends on the underlying operating system and original variables may be largervisible in the output. For exampleMoreover, many operating systems measure time in units variables of tens of millisecondsfunction calls will disappear because functions are inlined. Function inlining can be turned off by setting the [[Options#INLINELIMIT|INLINELIMIT]] option to <code>0</code>.

|In contrast to {{Code|fn:current-time()}}, the The function is ''non-deterministic'', as it returns different values every time it is called. Its : evaluation order will be preserved by the compiler.|-| '''Examples'''|* {{Code|for $x in 1 to 2 return prof:variables()}} will dump the values of <code>$x</code> to standard error.

==prof:current-nstype==

| width='90120' | '''Signatures'''|{{Func|prof:current-nstype|$expr as item()*|xs:integeritem()*}}<br />

|Returns the current value of the most precise available system timer in nanoseconds.|-| '''Properties'''|In contrast Similar to {{Code|fn:current-timetrace($expr, $msg)}}, the function is ''nonbut instead of a user-deterministic''defined message, as it returns different values every emits the compile-time it is called. Its evaluation order will be preserved by the compilertype and estimated result size of its argument.

==prof:swallow=Helper Functions=

{{Mark|Introduced with Version 7.6.1==prof:}}void==

| width='90120' | '''Signatures'''|{{Func|prof:swallowvoid|$value as item()*|empty-sequence()}}

* {{Code|prof:swallowvoid(fetch:binary('http://my.rest.service'))}} performs an HTTP request and ignores the result.|} ==prof:sleep== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|prof:sleep|$ms as xs:integer|empty-sequence()}}<br />|-| '''Summary'''|Sleeps for the specified number of milliseconds.|-| '''Properties'''|The function is ''non-deterministic'': evaluation order will be preserved by the compiler.|} ==prof:human== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|prof:human|$number as xs:integer|xs:string}}|-| '''Summary'''|Returns a human-readable representation of the specified {{Code|$number}}.|-| '''Example'''|* {{Code|prof:human(16384)}} returns {{Code|16K}}.

;Version 79.60 * Added: [[#prof:track|prof:track]]* Updated: renamed prof:mem to [[#prof:memory|prof:memory]] ;Version 8.15 * Added: [[#prof:type|prof:type]] (moved from [[XQuery Module]])

;Version 8.1 * Added: <code>[[#prof:swallowvariables|prof:swallowvariables]] ;Version 7.7 * Added: [[#prof:void|prof:void]]</code>

* Added: <code>[[#prof:human|prof:human]]</code>

* Added: <code>[[#prof:dump|prof:dump]]</code>, <code>[[#prof:current-ms|prof:current-ms]]</code>, <code>[[#prof:current-ns|prof:current-ns]]</code>