Loading TOC...

MarkLogic 12 Product Documentation
dbg functions

The table below lists all the dbg built-in functions (in this namespace: http://marklogic.com/xdmp/debug).

Implements a library of functions which allow developers to build an IDE which will allow runtime debugging of query requests against MarkLogic Server. The debug functions allow you to build an application that does things like attach to a running server, set breakpoints in a query, examine the value of variables at a point in query execution, and so on. Note that the debug function library is not a debugger, but provides server-side support to build an application that can debug queries against MarkLogic Server.

25 functions
Function name Description
dbg:attach Attach to a request and stop it for debugging.
dbg:attached Return the request ID's of attached requests in a given server.
dbg:break Set a breakpoint at the given expression ID.
dbg:breakpoints Returns a sequence of expression ID's representing existing breakpoints for the given request.
dbg:clear Clear a breakpoint at the given expression ID.
dbg:connect Connect to a Server (http, xdbc, or task) for debugging.
dbg:connected Return the ID's of servers that are connected by the debugger.
dbg:continue Continue evaluation of the request.
dbg:detach Detach from a stopped request.
dbg:disconnect End the debugging of a server.
dbg:eval Evaluate a string as an XQuery for debugging.
dbg:expr Returns a description/representation of a given expression.
dbg:finish Continue evaluation of the request until the end of the current function.
dbg:function Returns the expression ID representing the function defined in a module with a given name.
dbg:invoke Invoke a module for debugging.
dbg:line Returns a sequence of expression ID's found on a given line of a stopped request.
dbg:next Continue evaluation of the request until the beginning or end of an expression that is not a descendant of the current expression.
dbg:out Continue evaluation of the request until the end of the current expression.
dbg:stack Return the stack trace for a given request.
dbg:status Return the debugging status of given requests.
dbg:step Continue evaluation of the request until the beginning or end of an expression.
dbg:stop Placing this call in XQuery will instruct the evaluator to stop a request for debugging.
dbg:stopped Return the request ID's of stopped requests in a given server.
dbg:value Evaluate an expression in the context of the identified stopped request.
dbg:wait Wait until at least one of the given requests stops or all complete evaluating.