Difference between revisions of "Output Module"

From BaseX Documentation
Jump to navigation Jump to search
(Created page with "<p>This module offers utility methods, which can be used for testing and profiling the code. All functions are preceded by the <code>util:</code> prefix. </p> ==util:eval== <t...")
 
Line 135: Line 135:
 
   </tr>  
 
   </tr>  
 
</table>
 
</table>
 +
[[Category:XQuery]]
 +
[[Category:Wikify]]

Revision as of 18:03, 9 December 2010

This module offers utility methods, which can be used for testing and profiling the code. All functions are preceded by the util: prefix.

util:eval

     Signatures 
      
       util:eval($expr as xs:string) as item()* 
     
     Summary 
Evaluates the argument at runtime.
     Rules 
This function dynamically evaluates $expr as XQuery expression and returns the resulting items.
     Examples 
The expression util:eval("1+3") returns 4.

util:run

     Signatures 
      
       util:run($input as xs:string) as item()* 
     
     Summary 
Opens the argument as file and evaluates it as at runtime.
     Rules 
This function opens $input as file, evaluates it as XQuery expression, and returns the resulting items.

util:mb

     Signatures 
      
       util:mb($expr as item()) as xs:double 
     
util:mb($expr as item(), $cache as xs:boolean) as xs:double
     Summary 
Measures the memory consumption for evaluating the argument.
     Rules 
This function measures the amount of memory that is needed to evaluate $expr. If the value of $cache is true(), the result will be cached. The returned xs:double value represents the amount of memory in megabytes.
     Examples 
The expression util:mb("1 to 100000") might return 0.
The expression util:mb("1 to 100000", true()) might return 26.678.

util:ms

     Signatures 
      
       util:ms($expr as item()) as xs:double 
     
util:ms($expr as item(), $cache as xs:boolean) as xs:double
     Summary 
Measures the time needed for evaluating the argument.
     Rules 
This function measures the time needed to evaluate $expr. If the value of $cache is true(), the result will be cached. The returned xs:double value represents the needed time in milliseconds.
     Examples 
The expression util:ms("1 to 100000") might return 25.69.
The expression util:ms("1 to 100000", true()) might return 208.12.