public interface XdmpExpr
Builds expressions to call functions in the xdmp server library for a row pipeline.
| Modifier and Type | Method and Description |
|---|---|
XsUnsignedLongExpr |
add64(XsUnsignedLongExpr x,
XsUnsignedLongExpr y)
Add two 64-bit integer values, discarding overflow.
|
XsUnsignedLongExpr |
and64(XsUnsignedLongExpr x,
XsUnsignedLongExpr y)
AND two 64-bit integer values.
|
XsStringExpr |
base64Decode(XsStringExpr encoded)
Converts base64-encoded string to plaintext.
|
XsStringExpr |
base64Encode(XsStringExpr plaintext)
Converts plaintext into base64-encoded string.
|
XsBooleanExpr |
castableAs(XsStringExpr namespaceUri,
String localName,
ItemExpr item)
Returns true if a value is castable.
|
XsBooleanExpr |
castableAs(XsStringExpr namespaceUri,
XsStringExpr localName,
ItemExpr item)
Returns true if a value is castable.
|
XsStringExpr |
crypt(XsStringExpr password,
String salt)
Calculates the password hash for the given password and salt.
|
XsStringExpr |
crypt(XsStringExpr password,
XsStringExpr salt)
Calculates the password hash for the given password and salt.
|
XsStringExpr |
crypt2(XsStringExpr password)
Calculates the password hash for the given plain-text password.
|
XsStringExpr |
daynameFromDate(XsDateExpr arg)
Returns an xs:string representing the dayname value in the localized value of arg.
|
XsStringExpr |
decodeFromNCName(XsStringExpr name)
Invertible function that decodes characters an NCName produced by
xdmp:encode-for-NCName. |
XsStringExpr |
describe(ItemSeqExpr item)
Returns a string representing the description of a given item sequence.
|
XsStringExpr |
describe(ItemSeqExpr item,
XsUnsignedIntExpr maxSequenceLength)
Returns a string representing the description of a given item sequence.
|
XsStringExpr |
describe(ItemSeqExpr item,
XsUnsignedIntExpr maxSequenceLength,
XsUnsignedIntExpr maxItemLength)
Returns a string representing the description of a given item sequence.
|
XsStringExpr |
diacriticLess(XsStringExpr string)
Returns the specified string, converting all of the characters with diacritics to characters without diacritics.
|
XsStringExpr |
elementContentType(ElementNodeExpr element)
Returns the schema-defined content-type of an element (“empty”, “simple”, “element-only”, or “mixed”).
|
XsStringExpr |
encodeForNCName(XsStringExpr name)
Invertible function that escapes characters required to be part of an NCName.
|
XsStringExpr |
formatNumber(XsNumericExpr... value)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture,
String language)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture,
String language,
String letterValue)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture,
String language,
String letterValue,
String ordchar)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture,
String language,
String letterValue,
String ordchar,
String zeroPadding)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture,
String language,
String letterValue,
String ordchar,
String zeroPadding,
String groupingSeparator)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
String picture,
String language,
String letterValue,
String ordchar,
String zeroPadding,
String groupingSeparator,
long groupingSize)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language,
XsStringExpr letterValue)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language,
XsStringExpr letterValue,
XsStringExpr ordchar)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language,
XsStringExpr letterValue,
XsStringExpr ordchar,
XsStringExpr zeroPadding)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language,
XsStringExpr letterValue,
XsStringExpr ordchar,
XsStringExpr zeroPadding,
XsStringExpr groupingSeparator)
Returns a formatted number value based on the picture argument.
|
XsStringExpr |
formatNumber(XsNumericSeqExpr value,
XsStringExpr picture,
XsStringExpr language,
XsStringExpr letterValue,
XsStringExpr ordchar,
XsStringExpr zeroPadding,
XsStringExpr groupingSeparator,
XsIntegerExpr groupingSize)
Returns a formatted number value based on the picture argument.
|
ItemSeqExpr |
fromJson(NodeExpr arg)
Atomizes a JSON node, returning a JSON value.
|
XsStringExpr |
getCurrentUser()
Returns the name of the current user.
|
XsUnsignedIntExpr |
hash32(XsStringExpr string)
Returns the 32-bit hash of a string.
|
XsUnsignedLongExpr |
hash64(XsStringExpr string)
Returns the 64-bit hash of a string.
|
XsIntegerExpr |
hexToInteger(XsStringExpr hex)
Parses a hexadecimal string, returning an integer.
|
XsStringExpr |
hmacMd5(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacMd5(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacMd5(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha1(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha1(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha1(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha256(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha256(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha256(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha512(ItemExpr secretkey,
ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha512(ItemExpr secretkey,
ItemExpr message,
String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
|
XsStringExpr |
hmacSha512(ItemExpr secretkey,
ItemExpr message,
XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
|
XsStringExpr |
initcap(XsStringExpr string)
Returns the string where the first letter of each token has been uppercased.
|
XsStringExpr |
integerToHex(XsIntegerExpr val)
Returns a hexadecimal representation of an integer.
|
XsStringExpr |
integerToOctal(XsIntegerExpr val)
Returns an octal representation of an integer.
|
XsStringExpr |
keyFromQName(XsQNameExpr name)
Construct a context-independent string from a QName.
|
XsUnsignedLongExpr |
lshift64(XsUnsignedLongExpr x,
long y)
Left-shift a 64-bit integer value.
|
XsUnsignedLongExpr |
lshift64(XsUnsignedLongExpr x,
XsLongExpr y)
Left-shift a 64-bit integer value.
|
XsStringExpr |
md5(ItemExpr data)
Calculates the md5 hash of the given argument.
|
XsStringExpr |
md5(ItemExpr data,
String encoding)
Calculates the md5 hash of the given argument.
|
XsStringExpr |
md5(ItemExpr data,
XsStringExpr encoding)
Calculates the md5 hash of the given argument.
|
XsStringExpr |
monthNameFromDate(XsDateExpr arg)
Returns month name, calculated from the localized value of arg.
|
XsUnsignedLongExpr |
mul64(XsUnsignedLongExpr x,
XsUnsignedLongExpr y)
Muliply two 64-bit integer values, discarding overflow.
|
XsStringSeqExpr |
nodeCollections(NodeExpr node)
Returns any collections for the node’s document in the database.
|
XsStringExpr |
nodeKind(NodeExpr node)
Returns an
xs:string representing the node’s kind: either “document”, “element”, “attribute”, “text”, “namespace”, “processing-instruction”, “binary”, or “comment”. |
MapMapExpr |
nodeMetadata(NodeExpr node)
Returns the metadata value of a given node.
|
XsStringExpr |
nodeMetadataValue(NodeExpr uri,
String keyName)
Returns the metadata value of a node for a particular key.
|
XsStringExpr |
nodeMetadataValue(NodeExpr uri,
XsStringExpr keyName)
Returns the metadata value of a node for a particular key.
|
ItemSeqExpr |
nodePermissions(NodeExpr node)
Returns the permissions to a node’s document.
|
ItemSeqExpr |
nodePermissions(NodeExpr node,
String outputKind)
Returns the permissions to a node’s document.
|
ItemSeqExpr |
nodePermissions(NodeExpr node,
XsStringExpr outputKind)
Returns the permissions to a node’s document.
|
XsStringExpr |
nodeUri(NodeExpr node)
Returns the document-uri property of the parameter or its ancestor.
|
XsUnsignedLongExpr |
not64(XsUnsignedLongExpr x)
NOT a 64-bit integer value.
|
XsIntegerExpr |
octalToInteger(XsStringExpr octal)
Parses an octal string, returning an integer.
|
XsUnsignedLongExpr |
or64(XsUnsignedLongExpr x,
XsUnsignedLongExpr y)
OR two 64-bit integer values.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
String value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
String value,
String language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
String value,
String language,
String calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
String value,
String language,
String calendar,
String country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
XsStringExpr value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
XsStringExpr value,
XsStringExpr language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
XsStringExpr value,
XsStringExpr language,
XsStringExpr calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseDateTime(XsStringExpr picture,
XsStringExpr value,
XsStringExpr language,
XsStringExpr calendar,
XsStringExpr country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
String value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
String value,
String language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
String value,
String language,
String calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
String value,
String language,
String calendar,
String country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
XsStringExpr value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
XsStringExpr value,
XsStringExpr language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
XsStringExpr value,
XsStringExpr language,
XsStringExpr calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsDateTimeExpr |
parseYymmdd(XsStringExpr picture,
XsStringExpr value,
XsStringExpr language,
XsStringExpr calendar,
XsStringExpr country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value.
|
XsStringExpr |
path(NodeExpr node)
Returns a string whose value corresponds to the path of the node.
|
XsStringExpr |
path(NodeExpr node,
boolean includeDocument)
Returns a string whose value corresponds to the path of the node.
|
XsStringExpr |
path(NodeExpr node,
XsBooleanExpr includeDocument)
Returns a string whose value corresponds to the path of the node.
|
XsIntegerExpr |
position(XsStringExpr test,
String target)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
position(XsStringExpr test,
String target,
String collation)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
position(XsStringExpr test,
XsStringExpr target)
Returns an integer value representing the starting position of a string within the search string.
|
XsIntegerExpr |
position(XsStringExpr test,
XsStringExpr target,
XsStringExpr collation)
Returns an integer value representing the starting position of a string within the search string.
|
XsQNameExpr |
QNameFromKey(XsStringExpr key)
Construct a QName from a string of the form “{namespaceURI}localname”.
|
XsIntegerExpr |
quarterFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
|
XsUnsignedLongExpr |
random()
Returns a random unsigned integer between 0 and a number up to 64 bits long.
|
XsUnsignedLongExpr |
random(XsUnsignedLongExpr max)
Returns a random unsigned integer between 0 and a number up to 64 bits long.
|
XsAnyURIExpr |
resolveUri(XsStringExpr relative,
String base)
Resolves a relative URI against an absolute URI.
|
XsAnyURIExpr |
resolveUri(XsStringExpr relative,
XsStringExpr base)
Resolves a relative URI against an absolute URI.
|
XsUnsignedLongExpr |
rshift64(XsUnsignedLongExpr x,
long y)
Right-shift a 64-bit integer value.
|
XsUnsignedLongExpr |
rshift64(XsUnsignedLongExpr x,
XsLongExpr y)
Right-shift a 64-bit integer value.
|
XsStringExpr |
sha1(ItemExpr data)
Calculates the SHA1 hash of the given argument.
|
XsStringExpr |
sha1(ItemExpr data,
String encoding)
Calculates the SHA1 hash of the given argument.
|
XsStringExpr |
sha1(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA1 hash of the given argument.
|
XsStringExpr |
sha256(ItemExpr data)
Calculates the SHA256 hash of the given argument.
|
XsStringExpr |
sha256(ItemExpr data,
String encoding)
Calculates the SHA256 hash of the given argument.
|
XsStringExpr |
sha256(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA256 hash of the given argument.
|
XsStringExpr |
sha384(ItemExpr data)
Calculates the SHA384 hash of the given argument.
|
XsStringExpr |
sha384(ItemExpr data,
String encoding)
Calculates the SHA384 hash of the given argument.
|
XsStringExpr |
sha384(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA384 hash of the given argument.
|
XsStringExpr |
sha512(ItemExpr data)
Calculates the SHA512 hash of the given argument.
|
XsStringExpr |
sha512(ItemExpr data,
String encoding)
Calculates the SHA512 hash of the given argument.
|
XsStringExpr |
sha512(ItemExpr data,
XsStringExpr encoding)
Calculates the SHA512 hash of the given argument.
|
XsUnsignedLongExpr |
step64(XsUnsignedLongExpr initial,
XsUnsignedLongExpr step)
Combines an initial hash with a subsequent hash.
|
XsStringExpr |
strftime(XsStringExpr format,
String value)
Formats a dateTime value using POSIX strftime.
|
XsStringExpr |
strftime(XsStringExpr format,
XsDateTimeExpr value)
Formats a dateTime value using POSIX strftime.
|
XsDateTimeExpr |
timestampToWallclock(XsUnsignedLongExpr timestamp)
Converts a 64 bit timestamp value to an xs:dateTime.
|
NodeExpr |
toJson(ItemSeqExpr item)
Constructs a JSON document.
|
XsQNameExpr |
type(XsAnyAtomicTypeExpr value)
Returns the name of the simple type of the atomic value argument as an
xs:QName. |
XsStringExpr |
urlDecode(XsStringExpr encoded)
Converts URL-encoded string to plaintext.
|
XsStringExpr |
urlEncode(XsStringExpr plaintext)
Converts plaintext into URL-encoded string.
|
XsStringExpr |
urlEncode(XsStringExpr plaintext,
boolean noSpacePlus)
Converts plaintext into URL-encoded string.
|
XsStringExpr |
urlEncode(XsStringExpr plaintext,
XsBooleanExpr noSpacePlus)
Converts plaintext into URL-encoded string.
|
XsUnsignedLongExpr |
wallclockToTimestamp(XsDateTimeExpr timestamp)
Converts an xs:dateTime to a 64 bit timestamp value.
|
XsIntegerExpr |
weekdayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 7, both inclusive, representing the weekday value in the localized value of arg.
|
XsIntegerExpr |
weekFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
|
XsUnsignedLongExpr |
xor64(XsUnsignedLongExpr x,
XsUnsignedLongExpr y)
XOR two 64-bit integer values.
|
XsIntegerExpr |
yeardayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
|
XsUnsignedLongExpr add64(XsUnsignedLongExpr x, XsUnsignedLongExpr y)
Add two 64-bit integer values, discarding overflow.
Provides a client interface to a server function. See xdmp:add64
x - The first value.y - The second value.XsUnsignedLongExpr and64(XsUnsignedLongExpr x, XsUnsignedLongExpr y)
AND two 64-bit integer values.
Provides a client interface to a server function. See xdmp:and64
x - The first value.y - The second value.XsStringExpr base64Decode(XsStringExpr encoded)
Converts base64-encoded string to plaintext.
Provides a client interface to a server function. See xdmp:base64-decode
encoded - Encoded text to be decoded.XsStringExpr base64Encode(XsStringExpr plaintext)
Converts plaintext into base64-encoded string.
Provides a client interface to a server function. See xdmp:base64-encode
plaintext - Plaintext to be encoded.XsBooleanExpr castableAs(XsStringExpr namespaceUri, String localName, ItemExpr item)
Returns true if a value is castable. This is similar to the “castable as” XQuery predicate, except that the type is determined at runtime.
Provides a client interface to a server function. See xdmp:castable-as
namespaceUri - The namespace URI of the type.localName - The local-name of the type.item - The item to be cast.XsBooleanExpr castableAs(XsStringExpr namespaceUri, XsStringExpr localName, ItemExpr item)
Returns true if a value is castable. This is similar to the “castable as” XQuery predicate, except that the type is determined at runtime.
Provides a client interface to a server function. See xdmp:castable-as
namespaceUri - The namespace URI of the type.localName - The local-name of the type.item - The item to be cast.XsStringExpr crypt(XsStringExpr password, String salt)
Calculates the password hash for the given password and salt.
Provides a client interface to a server function. See xdmp:crypt
password - String to be hashed.salt - Salt to avoid 1:1 mapping from passwords to hashes. Only the first 8 characters of the salt are significant; any characters beyond the eighth are ignored.XsStringExpr crypt(XsStringExpr password, XsStringExpr salt)
Calculates the password hash for the given password and salt.
Provides a client interface to a server function. See xdmp:crypt
password - String to be hashed.salt - Salt to avoid 1:1 mapping from passwords to hashes. Only the first 8 characters of the salt are significant; any characters beyond the eighth are ignored.XsStringExpr crypt2(XsStringExpr password)
Calculates the password hash for the given plain-text password.
Provides a client interface to a server function. See xdmp:crypt2
password - String to be hashed.XsStringExpr daynameFromDate(XsDateExpr arg)
Returns an xs:string representing the dayname value in the localized value of arg.
If arg is the empty sequence, returns the empty sequence.
Provides a client interface to a server function. See xdmp:dayname-from-date
arg - The date whose dayname value will be returned.XsStringExpr decodeFromNCName(XsStringExpr name)
Invertible function that decodes characters an NCName produced by xdmp:encode-for-NCName. Given the NCName produced by xdmp:encode-for-NCName this function returns the original string.
Provides a client interface to a server function. See xdmp:decode-from-NCName
name - A string representing an NCName. This string must have been the result of a previous call to xdmp:decode-from-NCName or undefined results will occur.XsStringExpr describe(ItemSeqExpr item)
Returns a string representing the description of a given item sequence. If you take the output of this function and evaluate it as an XQuery program, it returns the item(s) input to the function.
Provides a client interface to a server function. See xdmp:describe
item - The item sequence whose description is returned.XsStringExpr describe(ItemSeqExpr item, XsUnsignedIntExpr maxSequenceLength)
Returns a string representing the description of a given item sequence. If you take the output of this function and evaluate it as an XQuery program, it returns the item(s) input to the function.
Provides a client interface to a server function. See xdmp:describe
item - The item sequence whose description is returned.maxSequenceLength - Represents the maximum number of items per sequence to print. The default is 3. () means no maximum.XsStringExpr describe(ItemSeqExpr item, XsUnsignedIntExpr maxSequenceLength, XsUnsignedIntExpr maxItemLength)
Returns a string representing the description of a given item sequence. If you take the output of this function and evaluate it as an XQuery program, it returns the item(s) input to the function.
Provides a client interface to a server function. See xdmp:describe
item - The item sequence whose description is returned.maxSequenceLength - Represents the maximum number of items per sequence to print. The default is 3. () means no maximum.maxItemLength - Represents the maximum number of characters per item to print. The default is 64. The minimum is 8. () means no limit.XsStringExpr diacriticLess(XsStringExpr string)
Returns the specified string, converting all of the characters with diacritics to characters without diacritics.
Provides a client interface to a server function. See xdmp:diacritic-less
string - The string to convert.XsStringExpr elementContentType(ElementNodeExpr element)
Returns the schema-defined content-type of an element (“empty”, “simple”, “element-only”, or “mixed”).
Provides a client interface to a server function. See xdmp:element-content-type
element - An element node.XsStringExpr encodeForNCName(XsStringExpr name)
Invertible function that escapes characters required to be part of an NCName. This is useful when translating names from other representations such as JSON to XML. Given any string, the result is always a valid NCName. Providing all names are passed through this function the result is distinct NCNames so the results can be used for searching as well as name generation. The inverse function is xdmp:decode-for-NCName.
Provides a client interface to a server function. See xdmp:encode-for-NCName
name - A string which is used as an NCName (such as the localname for an element or attribute).XsStringExpr formatNumber(XsNumericExpr... value)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.XsStringExpr formatNumber(XsNumericSeqExpr value)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture, String language)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture, XsStringExpr language)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture, String language, String letterValue)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture, XsStringExpr language, XsStringExpr letterValue)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture, String language, String letterValue, String ordchar)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture, XsStringExpr language, XsStringExpr letterValue, XsStringExpr ordchar)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture, String language, String letterValue, String ordchar, String zeroPadding)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.zeroPadding - Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture, XsStringExpr language, XsStringExpr letterValue, XsStringExpr ordchar, XsStringExpr zeroPadding)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.zeroPadding - Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture, String language, String letterValue, String ordchar, String zeroPadding, String groupingSeparator)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.zeroPadding - Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.groupingSeparator - Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here “,” is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn’t want to specify this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture, XsStringExpr language, XsStringExpr letterValue, XsStringExpr ordchar, XsStringExpr zeroPadding, XsStringExpr groupingSeparator)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.zeroPadding - Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.groupingSeparator - Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here “,” is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn’t want to specify this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, String picture, String language, String letterValue, String ordchar, String zeroPadding, String groupingSeparator, long groupingSize)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.zeroPadding - Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.groupingSeparator - Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here “,” is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn’t want to specify this argument.groupingSize - Represents size of the group, i.e. the number of digits before after which grouping separator is inserted. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.XsStringExpr formatNumber(XsNumericSeqExpr value, XsStringExpr picture, XsStringExpr language, XsStringExpr letterValue, XsStringExpr ordchar, XsStringExpr zeroPadding, XsStringExpr groupingSeparator, XsIntegerExpr groupingSize)
Returns a formatted number value based on the picture argument. The difference between this function and the W3C standards fn:format-number function is that this function imitates the XSLT xsl:number instruction, which has richer formatting options than the fn:format-number function. This function can be used for spelled-out and ordinal numbering in many languages. This function is available in XSLT as well as in all dialects of XQuery and Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:format-number
value - The given numeric $value that needs to be formatted.picture - The desired string representation of the given numeric $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. Unlike fn:format-number(), here the picture string allows spelled-out (uppercase, lowercase and Capitalcase) formatting.language - The desired language for string representation of the numeric $value. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.letterValue - Same as letter-value attribute in xsl:number. This argument is ignored during formatting as of now. It may be used in future. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ordchar - If $ordchar is “yes” then ordinal numbering is attempted. If this is any other string, including an empty string, then then cardinal numbering is generated. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.zeroPadding - Value of $zero-padding is used to pad integer part of a number on the left and fractional part on the right, if needed. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.groupingSeparator - Value of $grouping-separator is a character, used to groups of digits, especially useful in making long sequence of digits more readable. For example, 10,000,000- here “,” is used as a separator after each group of three digits. An empty sequence must be passed in even if a user doesn’t want to specify this argument.groupingSize - Represents size of the group, i.e. the number of digits before after which grouping separator is inserted. An empty sequence must be passed in even if a user doesn’t want to specifiy this argument.ItemSeqExpr fromJson(NodeExpr arg)
Atomizes a JSON node, returning a JSON value.
Provides a client interface to a server function. See xdmp:from-json
arg - A node of kind object-node(), array-node(), text(), number-node(), boolean-node(), null-node(), or document-node().XsStringExpr getCurrentUser()
Returns the name of the current user.
Provides a client interface to a server function. See xdmp:get-current-user
XsUnsignedIntExpr hash32(XsStringExpr string)
Returns the 32-bit hash of a string.
Provides a client interface to a server function. See xdmp:hash32
string - The string to be hashed.XsUnsignedLongExpr hash64(XsStringExpr string)
Returns the 64-bit hash of a string.
Provides a client interface to a server function. See xdmp:hash64
string - The string to be hashed.XsIntegerExpr hexToInteger(XsStringExpr hex)
Parses a hexadecimal string, returning an integer.
Provides a client interface to a server function. See xdmp:hex-to-integer
hex - The hexadecimal string.XsStringExpr hmacMd5(ItemExpr secretkey, ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-md5
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.XsStringExpr hmacMd5(ItemExpr secretkey, ItemExpr message, String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-md5
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacMd5(ItemExpr secretkey, ItemExpr message, XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-md5
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacSha1(ItemExpr secretkey, ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha1
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.XsStringExpr hmacSha1(ItemExpr secretkey, ItemExpr message, String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha1
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacSha1(ItemExpr secretkey, ItemExpr message, XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha1
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacSha256(ItemExpr secretkey, ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha256
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.XsStringExpr hmacSha256(ItemExpr secretkey, ItemExpr message, String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha256
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacSha256(ItemExpr secretkey, ItemExpr message, XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha256
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacSha512(ItemExpr secretkey, ItemExpr message)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha512
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.XsStringExpr hmacSha512(ItemExpr secretkey, ItemExpr message, String encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha512
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr hmacSha512(ItemExpr secretkey, ItemExpr message, XsStringExpr encoding)
Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments.
Provides a client interface to a server function. See xdmp:hmac-sha512
secretkey - The secret key. Must be xs:string or a binary node.message - Message to be authenticated. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr initcap(XsStringExpr string)
Returns the string where the first letter of each token has been uppercased.
Provides a client interface to a server function. See xdmp:initcap
string - The string to modify.XsStringExpr integerToHex(XsIntegerExpr val)
Returns a hexadecimal representation of an integer.
Provides a client interface to a server function. See xdmp:integer-to-hex
val - The integer value.XsStringExpr integerToOctal(XsIntegerExpr val)
Returns an octal representation of an integer.
Provides a client interface to a server function. See xdmp:integer-to-octal
val - The integer value.XsStringExpr keyFromQName(XsQNameExpr name)
Construct a context-independent string from a QName. This string is of the form “{namespaceURI}localname” and is suitable for use as a map key.
Provides a client interface to a server function. See xdmp:key-from-QName
name - The QName to compute a key for.XsUnsignedLongExpr lshift64(XsUnsignedLongExpr x, long y)
Left-shift a 64-bit integer value.
Provides a client interface to a server function. See xdmp:lshift64
x - The value to shift.y - The left shift to perform. This value may be negative.XsUnsignedLongExpr lshift64(XsUnsignedLongExpr x, XsLongExpr y)
Left-shift a 64-bit integer value.
Provides a client interface to a server function. See xdmp:lshift64
x - The value to shift.y - The left shift to perform. This value may be negative.XsStringExpr md5(ItemExpr data)
Calculates the md5 hash of the given argument.
Provides a client interface to a server function. See xdmp:md5
data - Data to be hashed. Must be xs:string or a binary node.XsStringExpr md5(ItemExpr data, String encoding)
Calculates the md5 hash of the given argument.
Provides a client interface to a server function. See xdmp:md5
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr md5(ItemExpr data, XsStringExpr encoding)
Calculates the md5 hash of the given argument.
Provides a client interface to a server function. See xdmp:md5
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr monthNameFromDate(XsDateExpr arg)
Returns month name, calculated from the localized value of arg.
If arg is the empty sequence, returns the empty sequence.
Provides a client interface to a server function. See xdmp:month-name-from-date
arg - The date whose month-name will be returned.XsUnsignedLongExpr mul64(XsUnsignedLongExpr x, XsUnsignedLongExpr y)
Muliply two 64-bit integer values, discarding overflow.
Provides a client interface to a server function. See xdmp:mul64
x - The first value.y - The second value.XsStringSeqExpr nodeCollections(NodeExpr node)
Returns any collections for the node’s document in the database. If the specified node does not come from a document in a database, then xdmp:node-collections returns an empty sequence.
Provides a client interface to a server function. See xdmp:node-collections
node - The node whose collections are to be returned.XsStringExpr nodeKind(NodeExpr node)
Returns an xs:string representing the node’s kind: either “document”, “element”, “attribute”, “text”, “namespace”, “processing-instruction”, “binary”, or “comment”.
The fn:node-kind builtin was dropped from the final XQuery 1.0 spec. This is the equivalent function in the xdmp: namespace carried over for MarkLogic 1.0 dialects.
Provides a client interface to a server function. See xdmp:node-kind
node - The node whose kind is to be returned.MapMapExpr nodeMetadata(NodeExpr node)
Returns the metadata value of a given node.
Provides a client interface to a server function. See xdmp:node-metadata
node - The node whose metadata are to be returned.XsStringExpr nodeMetadataValue(NodeExpr uri, String keyName)
Returns the metadata value of a node for a particular key.
Provides a client interface to a server function. See xdmp:node-metadata-value
uri - The node whose metadata are to be returned.keyName - Name of the key for the metadata.XsStringExpr nodeMetadataValue(NodeExpr uri, XsStringExpr keyName)
Returns the metadata value of a node for a particular key.
Provides a client interface to a server function. See xdmp:node-metadata-value
uri - The node whose metadata are to be returned.keyName - Name of the key for the metadata.ItemSeqExpr nodePermissions(NodeExpr node)
Returns the permissions to a node’s document.
Provides a client interface to a server function. See xdmp:node-permissions
node - The node.ItemSeqExpr nodePermissions(NodeExpr node, String outputKind)
Returns the permissions to a node’s document.
Provides a client interface to a server function. See xdmp:node-permissions
node - The node.outputKind - The output kind. It can be either “elements” or “objects”. With “elements”, the built-in returns a sequence of XML elements. With “objects”, the built-in returns a sequence of map:map. The default is “elements”.ItemSeqExpr nodePermissions(NodeExpr node, XsStringExpr outputKind)
Returns the permissions to a node’s document.
Provides a client interface to a server function. See xdmp:node-permissions
node - The node.outputKind - The output kind. It can be either “elements” or “objects”. With “elements”, the built-in returns a sequence of XML elements. With “objects”, the built-in returns a sequence of map:map. The default is “elements”.XsStringExpr nodeUri(NodeExpr node)
Returns the document-uri property of the parameter or its ancestor.
Provides a client interface to a server function. See xdmp:node-uri
node - The node whose URI is returned.XsUnsignedLongExpr not64(XsUnsignedLongExpr x)
NOT a 64-bit integer value.
Provides a client interface to a server function. See xdmp:not64
x - The input value.XsIntegerExpr octalToInteger(XsStringExpr octal)
Parses an octal string, returning an integer.
Provides a client interface to a server function. See xdmp:octal-to-integer
octal - The octal string.XsUnsignedLongExpr or64(XsUnsignedLongExpr x, XsUnsignedLongExpr y)
OR two 64-bit integer values.
Provides a client interface to a server function. See xdmp:or64
x - The first value.y - The second value.XsDateTimeExpr parseDateTime(XsStringExpr picture, String value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.XsDateTimeExpr parseDateTime(XsStringExpr picture, XsStringExpr value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.XsDateTimeExpr parseDateTime(XsStringExpr picture, String value, String language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.XsDateTimeExpr parseDateTime(XsStringExpr picture, XsStringExpr value, XsStringExpr language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.XsDateTimeExpr parseDateTime(XsStringExpr picture, String value, String language, String calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.XsDateTimeExpr parseDateTime(XsStringExpr picture, XsStringExpr value, XsStringExpr language, XsStringExpr calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.XsDateTimeExpr parseDateTime(XsStringExpr picture, String value, String language, String calendar, String country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.country - $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value.XsDateTimeExpr parseDateTime(XsStringExpr picture, XsStringExpr value, XsStringExpr language, XsStringExpr calendar, XsStringExpr country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-dateTime
picture - The desired string representation of the given $value. The picture string is a sequence of characters, in which the characters represent variables such as, decimal-separator-sign, grouping-sign, zero-digit-sign, digit-sign, pattern-separator, percent sign and per-mille-sign. For details on the picture string, see http://www.w3.org/TR/xslt20/#date-picture-string. This follows the specification of picture string in the W3C XSLT 2.0 specification for the fn:format-dateTime function. Symbol Description ———————————– ‘Y’ year(absolute value) ‘M’ month in year ‘D’ day in month ‘d’ day in year ‘F’ day of week ‘W’ week in year ‘w’ week in month ‘H’ hour in day ‘h’ hour in half-day ‘P’ am/pm marker ‘m’ minute in hour ‘s’ second in minute ‘f’ fractional seconds ‘Z’ timezone as a time offset from UTC for example PST ‘z’ timezone as an offset using GMT, for example GMT+1
value - The given string $value representing the dateTime value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.country - $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value.XsDateTimeExpr parseYymmdd(XsStringExpr picture, String value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.XsDateTimeExpr parseYymmdd(XsStringExpr picture, XsStringExpr value)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.XsDateTimeExpr parseYymmdd(XsStringExpr picture, String value, String language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.XsDateTimeExpr parseYymmdd(XsStringExpr picture, XsStringExpr value, XsStringExpr language)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.XsDateTimeExpr parseYymmdd(XsStringExpr picture, String value, String language, String calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.XsDateTimeExpr parseYymmdd(XsStringExpr picture, XsStringExpr value, XsStringExpr language, XsStringExpr calendar)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.XsDateTimeExpr parseYymmdd(XsStringExpr picture, String value, String language, String calendar, String country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.country - $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value.XsDateTimeExpr parseYymmdd(XsStringExpr picture, XsStringExpr value, XsStringExpr language, XsStringExpr calendar, XsStringExpr country)
Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. While this function is closely related to other XSLT functions, it is available in XSLT as well as in all XQuery dialects and in Server-Side JavaScript.
Provides a client interface to a server function. See xdmp:parse-yymmdd
picture - The desired string representation of the given $value. This follows the specification of picture string which is compatible to the format specification in icu. See http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SimpleDateFormat.html for more details. The following is the summary of the formatting symbols:
Symbol Description —————————- “y” year(absolute value) “M” month in year “d” day in month “D” day in year “E” day of week “w” week in year “W” week in month “H” hour in day “K” hour in half-day “a” am/pm marker “s” second in minute “S” fractional seconds “Z” timezone as a time offset from UTC for example PST “ZZZZ” timezone as an offset using GMT, for example GMT+1
value - The given string $value that needs to be formatted.language - The language used in string representation of the date, time or dateTime value.calendar - This argument is reserved for future use. The only calendar supported at this point is “Gregorian” or “AD”.country - $country is used to take into account if there any country specific interpretation of the string while converting it into dateTime value.XsStringExpr path(NodeExpr node)
Returns a string whose value corresponds to the path of the node.
Provides a client interface to a server function. See xdmp:path
node - The node whose path is returned.XsStringExpr path(NodeExpr node, boolean includeDocument)
Returns a string whose value corresponds to the path of the node.
Provides a client interface to a server function. See xdmp:path
node - The node whose path is returned.includeDocument - If true, then the path is presented with a leading doc(..)/.., otherwise the path is presented as /...XsStringExpr path(NodeExpr node, XsBooleanExpr includeDocument)
Returns a string whose value corresponds to the path of the node.
Provides a client interface to a server function. See xdmp:path
node - The node whose path is returned.includeDocument - If true, then the path is presented with a leading doc(..)/.., otherwise the path is presented as /...XsIntegerExpr position(XsStringExpr test, String target)
Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
Provides a client interface to a server function. See xdmp:position
test - The string to test for existence in the second parameter.target - The string from which to test.XsIntegerExpr position(XsStringExpr test, XsStringExpr target)
Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
Provides a client interface to a server function. See xdmp:position
test - The string to test for existence in the second parameter.target - The string from which to test.XsIntegerExpr position(XsStringExpr test, String target, String collation)
Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
Provides a client interface to a server function. See xdmp:position
test - The string to test for existence in the second parameter.target - The string from which to test.collation - The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer’s Guide.XsIntegerExpr position(XsStringExpr test, XsStringExpr target, XsStringExpr collation)
Returns an integer value representing the starting position of a string within the search string. Note, the string starting position is 1. If the first parameter is empty, the result is the empty sequence.
Provides a client interface to a server function. See xdmp:position
test - The string to test for existence in the second parameter.target - The string from which to test.collation - The optional name of a valid collation URI. For information on the collation URI syntax, see the Search Developer’s Guide.XsQNameExpr QNameFromKey(XsStringExpr key)
Construct a QName from a string of the form “{namespaceURI}localname”. This function is useful for constructing Clark notation parameters for the xdmp:xslt-eval and xdmp:xslt-invoke functions.
Provides a client interface to a server function. See xdmp:QName-from-key
key - The string from which to construct a QName.XsIntegerExpr quarterFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of arg.
If arg is the empty sequence, returns the empty sequence.
Provides a client interface to a server function. See xdmp:quarter-from-date
arg - The date whose quarter component will be returned.XsUnsignedLongExpr random()
Returns a random unsigned integer between 0 and a number up to 64 bits long.
Provides a client interface to a server function. See xdmp:random
XsUnsignedLongExpr random(XsUnsignedLongExpr max)
Returns a random unsigned integer between 0 and a number up to 64 bits long.
Provides a client interface to a server function. See xdmp:random
max - The optional maximum value (inclusive).XsAnyURIExpr resolveUri(XsStringExpr relative, String base)
Resolves a relative URI against an absolute URI. If base is specified, the URI is resolved relative to that base. If base is not specified, the base is set to the base-uri property from the static context, if the property exists; if it does not exist, an error is thrown.
Provides a client interface to a server function. See xdmp:resolve-uri
relative - A URI reference to resolve against the base.base - An absolute URI to use as the base of the resolution.XsAnyURIExpr resolveUri(XsStringExpr relative, XsStringExpr base)
Resolves a relative URI against an absolute URI. If base is specified, the URI is resolved relative to that base. If base is not specified, the base is set to the base-uri property from the static context, if the property exists; if it does not exist, an error is thrown.
Provides a client interface to a server function. See xdmp:resolve-uri
relative - A URI reference to resolve against the base.base - An absolute URI to use as the base of the resolution.XsUnsignedLongExpr rshift64(XsUnsignedLongExpr x, long y)
Right-shift a 64-bit integer value.
Provides a client interface to a server function. See xdmp:rshift64
x - The value to shift.y - The right shift to perform. This value may be negative.XsUnsignedLongExpr rshift64(XsUnsignedLongExpr x, XsLongExpr y)
Right-shift a 64-bit integer value.
Provides a client interface to a server function. See xdmp:rshift64
x - The value to shift.y - The right shift to perform. This value may be negative.XsStringExpr sha1(ItemExpr data)
Calculates the SHA1 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha1
data - Data to be hashed. Must be xs:string or a binary node.XsStringExpr sha1(ItemExpr data, String encoding)
Calculates the SHA1 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha1
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha1(ItemExpr data, XsStringExpr encoding)
Calculates the SHA1 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha1
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha256(ItemExpr data)
Calculates the SHA256 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha256
data - Data to be hashed. Must be xs:string or a binary node.XsStringExpr sha256(ItemExpr data, String encoding)
Calculates the SHA256 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha256
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha256(ItemExpr data, XsStringExpr encoding)
Calculates the SHA256 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha256
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha384(ItemExpr data)
Calculates the SHA384 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha384
data - Data to be hashed. Must be xs:string or a binary node.XsStringExpr sha384(ItemExpr data, String encoding)
Calculates the SHA384 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha384
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha384(ItemExpr data, XsStringExpr encoding)
Calculates the SHA384 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha384
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha512(ItemExpr data)
Calculates the SHA512 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha512
data - Data to be hashed. Must be xs:string or a binary node.XsStringExpr sha512(ItemExpr data, String encoding)
Calculates the SHA512 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha512
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsStringExpr sha512(ItemExpr data, XsStringExpr encoding)
Calculates the SHA512 hash of the given argument.
Provides a client interface to a server function. See xdmp:sha512
data - Data to be hashed. Must be xs:string or a binary node.encoding - Encoding format for the output string, must be “hex” for hexadecimal or “base64”. Default is “hex”.XsUnsignedLongExpr step64(XsUnsignedLongExpr initial, XsUnsignedLongExpr step)
Combines an initial hash with a subsequent hash.
Provides a client interface to a server function. See xdmp:step64
initial - An initial hash.step - A step hash to be combined with the initial hash.XsStringExpr strftime(XsStringExpr format, String value)
Formats a dateTime value using POSIX strftime. This function uses the POSIX strftime system call in the way it is implemented on each platform. For other XQuery functions that have more functionality (for example, for things like timezones), use one or more if the various XQuery or XSLT standard functions such as fn:format-dateTime.
Provides a client interface to a server function. See xdmp:strftime
format - The strftime format string.value - The dateTime value.XsStringExpr strftime(XsStringExpr format, XsDateTimeExpr value)
Formats a dateTime value using POSIX strftime. This function uses the POSIX strftime system call in the way it is implemented on each platform. For other XQuery functions that have more functionality (for example, for things like timezones), use one or more if the various XQuery or XSLT standard functions such as fn:format-dateTime.
Provides a client interface to a server function. See xdmp:strftime
format - The strftime format string.value - The dateTime value.XsDateTimeExpr timestampToWallclock(XsUnsignedLongExpr timestamp)
Converts a 64 bit timestamp value to an xs:dateTime.
Provides a client interface to a server function. See xdmp:timestamp-to-wallclock
timestamp - The timestamp.NodeExpr toJson(ItemSeqExpr item)
Constructs a JSON document.
Provides a client interface to a server function. See xdmp:to-json
item - A sequence of items from which the JSON document is to be constructed. The item sequence from which the JSON document is constructed.XsQNameExpr type(XsAnyAtomicTypeExpr value)
Returns the name of the simple type of the atomic value argument as an xs:QName.
This function is a built-in.
Provides a client interface to a server function. See xdmp:type
value - The value to return the type of.XsStringExpr urlDecode(XsStringExpr encoded)
Converts URL-encoded string to plaintext. This decodes the string created with xdmp:url-encode.
Provides a client interface to a server function. See xdmp:url-decode
encoded - Encoded text to be decoded.XsStringExpr urlEncode(XsStringExpr plaintext)
Converts plaintext into URL-encoded string. To decode the string, use xdmp:url-decode.
There is also a W3C function that does a slightly different url encoding: fn:encode-for-uri.
Provides a client interface to a server function. See xdmp:url-encode
plaintext - Plaintext to be encoded.XsStringExpr urlEncode(XsStringExpr plaintext, boolean noSpacePlus)
Converts plaintext into URL-encoded string. To decode the string, use xdmp:url-decode.
There is also a W3C function that does a slightly different url encoding: fn:encode-for-uri.
Provides a client interface to a server function. See xdmp:url-encode
plaintext - Plaintext to be encoded.noSpacePlus - True to encode space as “%20” instead of “+”.XsStringExpr urlEncode(XsStringExpr plaintext, XsBooleanExpr noSpacePlus)
Converts plaintext into URL-encoded string. To decode the string, use xdmp:url-decode.
There is also a W3C function that does a slightly different url encoding: fn:encode-for-uri.
Provides a client interface to a server function. See xdmp:url-encode
plaintext - Plaintext to be encoded.noSpacePlus - True to encode space as “%20” instead of “+”.XsUnsignedLongExpr wallclockToTimestamp(XsDateTimeExpr timestamp)
Converts an xs:dateTime to a 64 bit timestamp value.
Provides a client interface to a server function. See xdmp:wallclock-to-timestamp
timestamp - The xs:datetime value.XsIntegerExpr weekFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of arg.
If arg is the empty sequence, returns the empty sequence.
Provides a client interface to a server function. See xdmp:week-from-date
arg - The date whose weeks of the year will be returned.XsIntegerExpr weekdayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 7, both inclusive, representing the weekday value in the localized value of arg.
If arg is the empty sequence, returns the empty sequence.
Provides a client interface to a server function. See xdmp:weekday-from-date
arg - The date whose weekday value will be returned.XsUnsignedLongExpr xor64(XsUnsignedLongExpr x, XsUnsignedLongExpr y)
XOR two 64-bit integer values.
Provides a client interface to a server function. See xdmp:xor64
x - The first value.y - The second value.XsIntegerExpr yeardayFromDate(XsDateExpr arg)
Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of arg.
If arg is the empty sequence, returns the empty sequence.
Provides a client interface to a server function. See xdmp:yearday-from-date
arg - The date whose days of the year will be returned.Copyright © 2013-2017 MarkLogic Corporation.