xdmp.describe

xdmp.describexdmpdescribe

/apidoc/8.0/xdmp:describe.xml

Returns a string representing the description of a given item sequence. If you take the output of the xdmp:describe function and evaluate it as an XQuery program, it returns the item(s) input to the function.

The item sequence whose description is returned.

item

ValueIterator

Represents the maximum number of items per sequence to print. The default is 3. () means no maximum.

max-sequence-length

Number?

Represents the maximum number of characters per item to print. The default is 64. The minimum is 8. () means no limit.

max-item-length

Number?

String

If you specify an item that is in a database, xdmp:describe returns the path to the item (or to the items if you specify multiple items). If the item or items are constructed in XQuery, then it prints out the item, truncating the characters in each item according to the maxItmLen parameter.

xdmp.describe(fn.currentDate());

=> xs.dateTime("2014-11-06T08:00:00")

var x = xdmp.toJSON({key:"value"});
xdmp.describe(x);

  => document{{"key":"value"}}

//  assume /mydoc.json is a JSON document with the following content:
//    {key: "value"}
xdmp.describe(cts.doc("/mydoc.json").root.key)

  => fn.doc("/mydoc.json")/text("key")