Mark Logic - XQuery Function Online Documentation

Returns -1, 0, or 1, depending on whether the value of the $comparand1 is respectively less than, equal to, or greater than the value of $comparand2, according to the rules of the collation that is used.

fn:concat

Returns the xs:string that is the concatenation of the values of the specified parameters.

fn:contains

Returns true if the first parameter contains the string from the second parameter, otherwise returns false.

fn:count

Returns the number of items in the value of $arg.

fn:current-date

Returns xs:date(fn:current-dateTime()).

fn:current-dateTime

Returns the current dateTime value (with timezone) from the dynamic context.

fn:current-time

Returns xs:time(fn:current-dateTime()).

fn:data

Takes a sequence of items and returns a sequence of atomic values.

fn:day-from-date

Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.

fn:day-from-dateTime

Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg.

fn:days-from-duration

Returns an xs:integer representing the days component in the canonical lexical representation of the value of $arg.

fn:deep-equal

This function assesses whether two sequences are deep-equal to each other.

fn:default-collation

Returns the value of the default collation property from the static context.

fn:distinct-nodes

Returns the sequence resulting from removing from the input sequence all but one of a set of nodes that have the same identity as one another.

fn:distinct-values

Returns the sequence that results from removing from $arg all but one of a set of values that are eq to one other.

fn:doc

Returns the document(s) stored in the database at the specified URI(s).

fn:doc-available

If fn:doc($uri) returns a document node, this function returns true.

fn:document-uri

Returns the value of the document-uri property for the specified node.

fn:empty

If the value of $arg is the empty sequence, the function returns true; otherwise, the function returns false.

fn:encode-for-uri

Invertible function that escapes characters required to be escaped inside path segments of URIs.

fn:ends-with

Returns true if the first parameter ends with the string from the second parameter, otherwise returns false.

fn:error

Throw the given error.

fn:escape-html-uri

%-escapes everything except printable ASCII characters.

fn:escape-uri

Returns a string representing the specified URI either with escaped reserved characters ($escape-reserved=true) or with the reserved characters left as specified ($escape-reserved=true).

fn:exactly-one

Returns $arg if it contains exactly one item.

fn:exists

If the value of $arg is not the empty sequence, the function returns true; otherwise, the function returns false.

fn:false

Returns the xs:boolean value false.

fn:floor

Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of $arg.

fn:hours-from-dateTime

Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of $arg.

fn:hours-from-duration

Returns an xs:integer representing the hours component in the canonical lexical representation of the value of $arg.

fn:hours-from-time

Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg.

fn:id

Returns the sequence of element nodes that have an ID value matching the value of one or more of the IDREF values supplied in $arg.

fn:idref

Returns the sequence of element or attribute nodes that have an IDREF value matching the value of one or more of the ID values supplied in $arg.

fn:implicit-timezone

Returns the value of the implicit timezone property from the dynamic context.

fn:in-scope-prefixes

Returns the prefixes of the in-scope namespaces for $element.

fn:index-of

Returns a sequence of positive integers giving the positions within the sequence $seqParam of items that are equal to $srchParam.

fn:insert-before

Returns a new sequence constructed from the value of $target with the value of $inserts inserted at the position specified by the value of $position.

fn:iri-to-uri

Idempotent function that escapes non-URI characters.

fn:lang

This function tests whether the language of $node, or the context node if the second argument is omitted, as specified by xml:lang attributes is the same as, or is a sublanguage of, the language specified by $testlang.

fn:last

Returns the context size from the dynamic context.

fn:local-name

Returns the local part of the name of $arg as an xs:string that will either be the zero-length string or will have the lexical form of an xs:NCName.

fn:local-name-from-QName

Returns an xs:NCName representing the local part of $arg.

fn:lower-case

Returns the specified string converting all of the characters to lower-case characters.

fn:matches

Returns true if the specified $input matches the specified $pattern, otherwise returns false.

fn:max

Selects an item from the input sequence $arg whose value is greater than or equal to the value of every other item in the input sequence.

fn:min

Selects an item from the input sequence $arg whose value is less than or equal to the value of every other item in the input sequence.

fn:minutes-from-dateTime

Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg.

fn:minutes-from-duration

Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of $arg.

fn:minutes-from-time

Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg.

fn:month-from-date

Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.

fn:month-from-dateTime

Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg.

fn:months-from-duration

Returns an xs:integer representing the months component in the canonical lexical representation of the value of $arg.

fn:name

Returns the name of a node, as an xs:string that is either the zero-length string, or has the lexical form of an xs:QName.

fn:namespace-uri

Returns the namespace URI of the xs:QName of $arg.

fn:namespace-uri-for-prefix

Returns the namespace URI of one of the in-scope namespaces for $element, identified by its namespace prefix.

fn:namespace-uri-from-QName

Returns the namespace URI for $arg as an xs:string.

fn:node-kind

Returns an xs:string representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment".

fn:node-name

Returns an expanded-QName for node kinds that can have names.

fn:normalize-space

Returns the specified string with normalized whitespace, which strips off any leading or trailing whitespace and replaces any other sequences of more than one whitespace characters with a single space character (#x20).

fn:normalize-unicode

Return the argument normalized according to the normalization criteria for a normalization form identified by the value of $normalizationForm.

fn:not

Returns true if the effective boolean value is false, and false if the effective boolean value is true.

fn:number

Returns the value indicated by $arg or, if $arg is not specified, the context item after atomization, converted to an xs:double.

fn:one-or-more

Returns $arg if it contains one or more items.

fn:position

Returns the context position from the dynamic context.

fn:prefix-from-QName

Returns an xs:NCName representing the prefix of $arg.

fn:QName

Returns an xs:QName with the namespace URI given in $paramURI.

fn:remove

Returns a new sequence constructed from the value of $target with the item at the position specified by the value of $position removed.

fn:replace

Returns a string constructed by replacing the specified $pattern on the $input string with the specified $replacement string.

fn:resolve-QName

Returns an xs:QName value (that is, an expanded-QName) by taking an xs:string that has the lexical form of an xs:QName (a string in the form "prefix:local-name" or "local-name") and resolving it using the in-scope namespaces for a given element.

fn:resolve-uri

Resolves a relative URI against an absolute URI.

fn:reverse

Reverses the order of items in a sequence.

fn:root

Returns the root of the tree to which $arg belongs.

fn:round

Returns the number with no fractional part that is closest to the argument.

fn:round-half-to-even

The value returned is the nearest (that is, numerically closest) numeric to $arg that is a multiple of ten to the power of minus $precision.

fn:seconds-from-dateTime

Returns an xs:decimal value between 0 and 60.999..., both inclusive representing the seconds and fractional seconds in the localized value of $arg.

fn:seconds-from-duration

Returns an xs:decimal representing the seconds component in the canonical lexical representation of the value of $arg.

fn:seconds-from-time

Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg.

fn:starts-with

Returns true if the first parameter starts with the string from the second parameter, otherwise returns false.

fn:static-base-uri

Returns the value of the base-uri property from the static context.

fn:string

Returns the value of $arg represented as an xs:string.

fn:string-join

Returns an xs:string created by concatenating the members of the $parameter1 sequence using $parameter2 as a separator.

fn:string-length

Returns an integer representing the length of the specified string.

fn:string-pad

Returns a string representing the $padString concatenated with itself the number of times specifed in $padCount.

fn:string-to-codepoints

Returns the sequence of Unicode code points that constitute an xs:string.

fn:subsequence

Returns the contiguous sequence of items in the value of $sourceSeq beginning at the position indicated by the value of $startingLoc and continuing for the number of items indicated by the value of $length.

fn:substring

Returns a substring starting from the $startingLoc and continuing for $length characters.

fn:substring-after

Returns the substring created by taking all of the input characters that occur after the specified $after characters.

fn:substring-before

Returns the substring created by taking all of the input characters that occur before the specified $before characters.

fn:sum

Returns a value obtained by adding together the values in $arg.

fn:timezone-from-date

Returns the timezone component of $arg if any.

fn:timezone-from-dateTime

Returns the timezone component of $arg if any.

fn:timezone-from-time

Returns the timezone component of $arg if any.

fn:tokenize

Returns a sequence of strings contructed by breaking the specified input into substrings separated by the specified $pattern.

fn:trace

Return the input $value unchanged and, if $label is the name of an enabled server event, emit that server event to the server log file (ErrorLog.txt) with $value as its data.

fn:translate

Returns a string where every character in $src that occurs in some position in the $mapString is translated into the $transString character in the corresponding location of the $mapString character.

fn:true

Returns the xs:boolean value true.

fn:unordered

Returns the items of $sourceSeq in an implementation dependent order.

fn:upper-case

Returns the specified string converting all of the characters to upper-case characters.

fn:year-from-date

Returns an xs:integer representing the year component in the localized value of $arg.

fn:year-from-dateTime

Returns an xs:integer representing the year component in the localized value of $arg.

fn:years-from-duration

Returns an xs:integer representing the years component in the canonical lexical representation of the value of $arg.

fn:zero-or-one

Returns $arg if it contains zero or one items.

lnk:create

Create a link between the two given documents with the given role labels and strength.

lnk:from

Find and return all the links from the given document to some other.

lnk:get

Find and return the link between the two documents, if any.

lnk:insert

Insert the given link.

lnk:remove

Remove the link between the two given documents and return the removed link.

lnk:to

Find and return all the links to the given document from some other.

math:acos

Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive).

math:asin

Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive).

math:atan

Returns the arc tangent of x, in radians.

math:atan2

Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the apropriate quadrant.

math:ceil

Returns the smallest integer greater than or equal to x.

math:cos

Returns the cosine of x, in the range from -1 to +1 (inclusive).

math:cosh

Returns the hyperbolic cosine of x.

math:exp

Returns e to the xth power.

math:fabs

Returns the absolute value of x.

math:floor

Returns the largest integer less than or equal to x.

math:fmod

Returns the remainder of x/y.

math:frexp

Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent.

math:ldexp

Returns x*2^i.

math:log

Returns the base-e logarithm of x.

math:log10

Returns the base-10 logarithm of x.

math:modf

Returns x broken up into fraction and integer.

math:pow

Returns x^y.

math:sin

Returns the sine of x, in the range from -1 to +1 (inclusive).

math:sinh

Returns the hyperbolic sine of x.

math:sqrt

Returns the square root of x.

math:tan

Returns the tangent of x.

math:tanh

Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive).

msword:clean

Clean up any conversion artifacts or other infelicities.

p:action

Construct an action element.

p:collection

Return the name of the collection in which pipelines are stored.

p:condition

Construct a condition element.

p:create

Create a new content processing pipeline.

p:execute

Construct a execute element.

p:get

Find a particular pipeline.

p:get-by-id

Find a particular pipeline.

p:insert

Insert a fully constructed content processing pipeline, returning its unique id.

p:pipelines

Return all the pipelines.

p:remove

Remove the named pipeline.

p:state-transition

Construct a new state transition element.

p:status-transition

Construct a new status transition element.

pdf:clean

Clean up any conversion artifacts or other infelicities.

pdf:get-toc

Fetch the linked TOC, if any.

pdf:insert-toc-headers

Locate TOC anchors and make them properly refer to headers at the appropriate level.

pdf:make-toc

Clean and normalize the TOC produced by raw conversion.

ppt:clean

Clean up any conversion artifacts or other infelicities, putting each slide into its own div element.

prof:allowed

Returns the value of the Profile Allow setting for the App Server or Task Server upon which the target request is running.

prof:disable

Disable profiling for this request.

prof:enable

Enable profiling for this request.

prof:eval

Evaluate a string as an XQuery for profiling.

prof:invoke

Profiles and returns the result of evaluating a module at the given path.

prof:report

Return a prof:report node containing the current state of profiling statistics for the given request.

prof:reset

Clear any accumulated profiling statistics for the requests.

sec:amp-add-roles

Adds the roles ($role-names) to the list of roles granted to the amp ($namespace, $local-name, $document-uri).

sec:amp-doc-collections

Returns a sequence of strings corresponding to the collection uri's that amps belong to.

sec:amp-doc-permissions

Returns a sequence of permission elements that all newly created amp documents receive.

sec:amp-get-roles

Returns a sequence of role names for the roles directly assigned to the amp ($namespace, $local-name, $document-uri).

sec:amp-remove-roles

Removes a role ($role-name) from the set of roles included by the amp ($namespace, $local-name, $document-uri).

sec:amp-set-roles

Assigns the amp identified by $namespace, $local-name and $document-uri to have the roles identified by $roles-names.

sec:amps-collection

Returns a string corresponding to the uri for the amps collection.

sec:check-admin

Throws an error if the current user does not have the admin role.

sec:collection-add-permissions

Add the permissions $permissions to the protected collection identified by $uri.

sec:collection-get-permissions

Returns a sequence of permission elements corresponding to the current permissions granted to the protected collection identified by $uri.

sec:collection-remove-permissions

Removes the permissions $permissions from the protected collection identified by $uri.

sec:collection-set-permissions

Sets the permissions of a protected collection identified by $uri to $permissions.

sec:collections-collection

Returns a string corresponding to the uri for the protected collections collection.

sec:create-amp

Creates a new amp in the system database for the context database.

sec:create-privilege

Creates a new privilege and returns the new privilege-id.

sec:create-role

Creates a new role in the system database for the context database.

sec:create-user

Creates a new user in the system database for the context database.

sec:create-user-with-role

Creates a new user in the system database for the context database.

sec:get-amp

Returns an sec:amp element corresponding to an amp identified by ($namespace, $local-name, $document-uri).

sec:get-collection

Gets the security document corresponding to a protected collection with uri equal to $uri.

sec:get-distinct-permissions

Returns a sequence of permission elements made up of a concatenation of $output-perms and the distinct permission elements of $input-perms.

sec:get-privilege

Returns a sec:privilege element corresponding to a privilege identified by ($action,$kind).

sec:get-role-ids

Returns sequence of unique sec:role-id's that corresponds to the sequence of role names $role-names.

sec:get-role-names

Returns sequence of unique sec:role-name's that corresponds to the sequence of role IDs $role-ids.

sec:get-unique-elem-id

Returns a unique id for a given security element, $elem.

sec:priv-doc-collections

Returns a sequence of strings corresponding to the collection uri's that privileges belong to.

sec:priv-doc-permissions

Returns a sequence of permission elements that all newly created privilege documents receive.

sec:privilege-add-roles

Adds the roles ($role-names) to the list of roles assigned to the privilege ($action,$kind).

sec:privilege-get-roles

Returns a sequence of role names for the roles assigned to the privilege ($action,$kind).

sec:privilege-remove-roles

Removes roles ($role-names) from the roles assigned to the privilege ($action,$kind).

sec:privilege-set-name

Changes the sec:privilege-name of a sec:privilege to $new-privilege-name.

sec:privilege-set-roles

Assigns the privilege ($action,$kind) to have the roles identified by $role-names.

sec:privileges-collection

Returns a string corresponding to the uri for the privileges collection.

sec:protect-collection

Protects a collection $uri with the given permissions ($permissions).

sec:remove-amp

Removes the amp ($namespace, $local-name, $document-uri, $database) and returns true after completion.

sec:remove-privilege

Removes the privilege identified by ($action,$kind).

sec:remove-role

Removes the role ($role-name).

sec:remove-role-from-amps

Removes references to the role ($role-name) from all amps.

sec:remove-role-from-privileges

Removes references to the role ($role-name) from all privileges.

sec:remove-role-from-role

Removes references to the role ($role-name) from other roles.

sec:remove-role-from-users

Removes references to the role ($role-name) from all users.

sec:remove-user

Removes the user with name $user-name.

sec:role-add-roles

Adds the roles ($new-roles) to the set of roles included by the role ($role-name).

sec:role-doc-collections

Returns a sequence of strings corresponding to the collection uri's that roles belong to.

sec:role-doc-permissions

Returns a sequence of permission elements that all newly created role documents receive.

sec:role-get-default-collections

Returns a sequence of strings correspondinig to the uri's of the role's default collections.

sec:role-get-default-permissions

Returns a sequence of permission elements correspondinig to the role's default permissions.

sec:role-get-description

Returns the description for the specified role.

sec:role-get-roles

Returns a sequence of role names for the roles directly assigned to the given role ($role-name).

sec:role-privileges

Returns a set of privilege elements corresponding to all privileges that a role has.

sec:role-remove-roles

Removes the roles ($role-names) from the set of roles included by the role ($role-name).

sec:role-set-default-collections

Sets the default collections of a role with name $role-name to $collections.

sec:role-set-default-permissions

Sets the default permissions for a role with name $role-name.

sec:role-set-description

Changes the description of the role identified by $role-name to $description.

sec:role-set-name

Changes the sec:role-name of a role from $role-name to $new-role-name.

sec:role-set-roles

Assigns roles (named $role-names) to be the set of included roles for the role ($role-name).

sec:roles-collection

Returns a string corresponding to the uri for the roles collection.

sec:security-collection

Returns a string corresponding to the uri for the Security collection.

sec:security-installed

Returns fn:true() if security has been installed on the current database.

sec:security-namespace

Returns a string corresponding to the uri of the security namespace.

sec:security-version

Returns the current version of the security database.

sec:set-realm

Changes the realm of this security database to $realm.

sec:uid-for-name

Returns the uids for the named user or () if no such user exists.

sec:unprotect-collection

Removes the protection of a collection $uri.

sec:user-add-roles

Adds the roles ($role-names) to the list of roles granted to the user ($user-name).

sec:user-doc-collections

Returns a sequence of strings corresponding to the collection uri's that users belong to.

sec:user-doc-permissions

Returns a sequence of permission elements that all newly created user documents receive.

sec:user-get-default-collections

Returns a sequence of strings correspondinig to the uri's of the user's default collections.

sec:user-get-default-permissions

Returns a sequence of permission elements correspondinig to the user's default permissions.

sec:user-get-description

Returns the user's description.

sec:user-get-roles

Returns a sequence of role names for the roles directly assigned to the user ($user-name).

sec:user-privileges

Returns a set of privilege elements corresponding to all privileges that a user has.

sec:user-remove-roles

Removes the roles ($role-names) from the list of roles granted to the user ($user-name).

sec:user-set-default-collections

Sets the default collections of a user with name $user-name to $collections.

sec:user-set-default-permissions

Sets the default permissions for a user with name $user-name.

sec:user-set-description

Changes the description of the user identified by $user-name to $description.

sec:user-set-name

Changes the name of the user from $user-name to $new-user-name.

sec:user-set-password

Changes the password for the user identified by $user-name to $password.

sec:user-set-roles

Assigns the user with name $user-name to have the roles identified by $role-names.

sec:users-collection

Returns a string corresponding to the uri for the users collection.

spell:add-word

Add the word $word to the dictionary at $uri.

spell:insert

Load the words in $dict into the dictionary at $uri.

spell:is-correct

Returns true() if the specified word is spelled correctly, otherwise returns false().

spell:load

Add the words from the file specified in $path to the dictionary at $uri.

spell:remove-word

Remove the word $word from the dictionary at $uri.

spell:suggest

Suggests a list of spellings for a word.

thsr:add-synonym

Adds a synonym to the specified thesaurus entry.

thsr:expand

Returns a query that searches for all the query strings specified in $query and their synonyms as found in $entries.

thsr:insert

Load the entries in $thsr into the thesaurus at $uri.

thsr:load

Load the file specified in $path to the thesaurus at $uri.

thsr:lookup

Returns all entries for term $term in the thesaurus document(s) at $uri.

thsr:query-lookup

Returns a sequence of all entries that are found by looking up terms in the query and/or subqueries of $query in the thesaurus document(s) at $uri.

thsr:remove-entry

Removes all entries that exactly match $entry from the thesaurus documents(s) at $uri.

thsr:remove-synonym

Removes synonym $synonym from thesaurus entry $entry.

thsr:remove-term

Removes all entries with term $term from the thesaurus document(s) at $uri.

thsr:set-entry

Adds the entry $entry to the thesaurus at $uri.

trgr:any-property-content

Returns the representation of an all-properties part to a triggering event.

trgr:collection-scope

Returns the representation of a collection scope.

trgr:create-trigger

Creates a new trigger in the context database.

trgr:directory-scope

Returns the representation of a directory scope.

trgr:document-content

Returns the representation of a document part to a triggering event.

trgr:document-scope

Returns the representation of a document scope.

trgr:get-trigger

Returns the xml representation of the trigger named $trigger-name.

trgr:get-trigger-by-id

Returns the xml representation of the trigger that has a trigger-id of $trigger-id.

trgr:post-commit

Returns the representation of a post-commit trigger timing.

trgr:pre-commit

Returns the representation of a pre-commit trigger timing.

trgr:property-content

Returns the representation of an property part to a triggering event.

trgr:remove-trigger

Remove the trigger named $trigger-name.

trgr:trigger-add-permissions

Add $permissions to the set of permissions on the trigger named $trigger.

trgr:trigger-data-event

Returns the representation of a triggering event.

trgr:trigger-database-online-event

Returns the representation of a database coming online event.

trgr:trigger-disable

Disable the trigger named $trigger-name.

trgr:trigger-enable

Enable the trigger named $trigger-name.

trgr:trigger-get-permissions

Get the set of permissions of the trigger named $trigger-name.

trgr:trigger-module

Returns the representation of a trigger module invocation.

trgr:trigger-remove-permissions

Remove $permissions from the set of permissions on the trigger named $trigger-name.

trgr:trigger-set-description

Sets the description of the trigger nameds $trigger-name to $description.

trgr:trigger-set-event

Assigned the trigger named $trigger-name the new triggering event defined in $event.

trgr:trigger-set-module

Assigned the trigger named $trigger-name the new execution module defined in $module.

trgr:trigger-set-name

Changes the name of the trigger from $user-name to $new-user-name.

trgr:trigger-set-permissions

Set the permissions on the trigger to the new set of permissions in $permissions.

xdmp:access

Returns whether a given action on the specified document URI would succeed.

xdmp:add-response-header

Adds an HTTP response header field.

xdmp:amp-roles

Returns the set of all roles assigned to an amp, including roles directly assigned to the amp and roles inherited by other roles.

xdmp:base64-decode

Converts base64-encoded string to plaintext.

xdmp:base64-encode

Converts plaintext into base64-encoded string.

xdmp:can-grant-roles

Tests whether a user can grant or revoke a set of roles.

xdmp:collation-canonical-uri

Returns the canonical URI for the given URI, if it represents a valid collation.

xdmp:collection-delete

Deletes from the database every document in a collection.

xdmp:collection-locks

Returns locks of documents in a collection.

xdmp:collection-properties

Returns a sequence of properties documents, one for each document in the specified collection(s) that has a corresponding properties document.

xdmp:database

Returns the the ID of the database named in the the parameter.

xdmp:database-forests

Returns a sequence of forest IDs in the specified database.

xdmp:database-name

Return the name of the database with the given ID.

xdmp:databases

Returns a sequence of the IDs of all the databases in the system.

xdmp:default-collections

Returns the collections any new document would get if the current user were to insert a document without specifying the collections.

xdmp:default-permissions

Returns the permissions any new document would get if the current user were to insert a document without specifying the default permissions.

xdmp:describe

Returns a string representing the description of a given item sequence.

xdmp:diacritic-less

Returns the specified string, converting all of the characters with diacritics to characters without diacritics.

xdmp:directory

Returns the documents in a directory.

xdmp:directory-create

Creates a directory.

xdmp:directory-delete

Deletes a directory and its children from the database.

xdmp:directory-locks

Returns locks of documents in a directory.

xdmp:directory-properties

Returns a sequence of properties documents, one for each document in the specified directory that has a corresponding properties document.

xdmp:document-add-collections

Adds the named document to the given collections.

xdmp:document-add-permissions

Adds the given permissions to the given document.

xdmp:document-add-properties

Adds a sequence of properties to the properties of a document.

xdmp:document-delete

Deletes a document from the database.

xdmp:document-forest

Returns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored.

xdmp:document-get

Returns the document in the file specified by $location.

xdmp:document-get-collections

Returns the collections to which a given document belongs.

xdmp:document-get-permissions

Returns the permissions to a given document.

xdmp:document-get-properties

Returns the property values for a document's property.

xdmp:document-get-quality

Returns the quality of the specified document if the document exists.

xdmp:document-insert

Inserts a new document into the database if a document with the specified URI does not already exist.

xdmp:document-load

Inserts a new document with the specified URI.

xdmp:document-locks

Returns the locks for one or more documents or directories.

xdmp:document-properties

Returns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document.

xdmp:document-remove-collections

Removes the named document from the given collections.

xdmp:document-remove-permissions

Removes the given permissions from the named document.

xdmp:document-remove-properties

Removes a sequence of properties from the properties of a document.

xdmp:document-set-collections

Sets the named document to belong to the given collections, replacing any previously set collections on the named document.

xdmp:document-set-permissions

Sets the permissions on the named document to the given permissions, replacing any permissions previously set on the document.

xdmp:document-set-properties

Sets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document.

xdmp:document-set-property

Sets a property on a document.

xdmp:document-set-quality

Sets the quality of the document with the given URI.

xdmp:email

Send an email in an XQuery program.

xdmp:estimate

Returns the number of fragments selected by an expression.

xdmp:eval

Returns the result of evaluating a string as an XQuery module.

xdmp:eval-in

[DEPRECATED--use xdmp:eval with the database option instead] Returns the result of evaluating a string as an XQuery module in a given database.

xdmp:excel-convert

Converts a Microsoft Excel document to XHTML.

xdmp:exists

Returns true if any fragment is selected by an expression, false if no fragments are selected.

xdmp:forest

Returns the the ID of the forest specified as the parameter.

xdmp:forest-counts

Returns detailed forest statistics for a given forest.

xdmp:forest-databases

Returns the database ID corresponding to the database to which the specified forest belongs.

xdmp:forest-name

Return the name of the forest with the given id.

xdmp:forest-status

Returns the status of a forest.

xdmp:forests

Returns a sequence of the IDs of all the forests in the system.

xdmp:get

[DEPRECATED] Returns the document in the XML file specified by $path.

xdmp:get-current-roles

Returns all the current roles, both assigned and inherited by the current user and any received from amps.

xdmp:get-current-user

Returns the name of the current user.

xdmp:get-request-body

Returns the POST body of this request, if it is not application/x-www-form-urlencoded.

xdmp:get-request-client-address

Returns as a string the internet address of the client from which the HTTP server request is issued.

xdmp:get-request-field

Returns the value of a named request field.

xdmp:get-request-field-names

Returns a sequence of the request field names.

xdmp:get-request-header

Returns the value of a named request header.

xdmp:get-request-header-names

Returns a sequence of request header names.

xdmp:get-request-method

Returns the HTTP request method.

xdmp:get-request-path

Returns the HTTP request path.

xdmp:get-request-user

Returns the id of the current user.

xdmp:get-request-username

Returns the username from the Authorization header of this App Server request.

xdmp:get-session-field

Returns the value of a named HTTP session field.

xdmp:get-session-field-names

Returns a sequence of the HTTP session field names.

xdmp:has-privilege

Tests whether the current user has at least one of a given set of privileges.

xdmp:hash32

Returns the 32-bit hash of a string.

xdmp:hash64

Returns the 64-bit hash of a string.

xdmp:hex-to-integer

Parses a hexadecimal string, returning an integer.

xdmp:host

Returns the the ID of the host named in the parameter.

xdmp:host-name

Returns the the name of the host ID specified as the parameter.

xdmp:host-status

Returns the status of a host.

xdmp:hosts

Returns a sequence of the IDs of all the hosts in the system.

xdmp:http-delete

Sends an http DELETE request to the http server specified in the URI to delete the specified resource.

xdmp:http-get

Sends the http GET method to the specified URI.

xdmp:http-head

Sends the http HEAD method to the specified URI.

xdmp:http-post

Sends the http POST request to the server.

xdmp:http-put

Sends an HTTP PUT request to an HTTP server.

xdmp:integer-to-hex

Returns a hexadecimal representation of an integer.

xdmp:integer-to-octal

Returns an octal representation of an integer.

xdmp:invoke

Returns the result of evaluating a module at the given path.

xdmp:invoke-in

[DEPRECATED--use xdmp:invoke with the database option instead] Returns the result of evaluating a module at the given path.

xdmp:load

[DEPRECATED] Inserts a new document from the XML file at $path if a document with the specified URI does not already exist.

xdmp:lock-acquire

Acquire a lock on a document or directory for an extended amount of time.

xdmp:lock-release

Unlock a document or directory.

xdmp:log

Logs a debug message to the log file <install_dir>/Logs/ErrorLog.txt.

xdmp:login

Logs in a user on an application server that is using application-level authentication and deposits a session cookie.

xdmp:logout

Sets the current user to the default user defined in application-level authentication.

xdmp:merge

Starts merging the forests of the database, subject to specified options.

xdmp:merging

Returns the forest IDs of any currently merging database forests.

xdmp:modules-database

Returns the database ID of the modules database.

xdmp:modules-root

Returns the current root path for modules.

xdmp:node-delete

Deletes a node from the database.

xdmp:node-insert-after

Adds an immediately following sibling to a node.

xdmp:node-insert-before

Adds an immediately preceding sibling to a node.

xdmp:node-insert-child

Adds a new last child to a node.

xdmp:node-replace

Replaces a node.

xdmp:node-uri

Returns the document-uri property of the parameter or its ancestor.

xdmp:octal-to-integer

Parses an octal string, returning an integer.

xdmp:path

Returns a string whose value corresponds to the path of the node.

xdmp:pdf-convert

Converts a PDF file to XHTML.

xdmp:permission

Returns a permission element in the security namespace corresponding to the named role and capability given.

xdmp:platform

Returns the platform upon which MarkLogic Server is running ("solaris", "winnt", or "linux").

xdmp:powerpoint-convert

Converts a Microsoft Powerpoint document to XHTML.

xdmp:privilege-roles

Returns the set of all roles that have a given privilege.

xdmp:product-edition

Returns the current Mark Logic product edition.

xdmp:query-meters

Returns the current value of the resource meters for this query sequence.

xdmp:query-trace

Enables or disables tracing of this query.

xdmp:quote

Returns the unevaluated serialized representation of the input parameter as a string.

xdmp:random

Returns a random unsigned integer between 0 and a number up to 64 bits long.

xdmp:redirect-response

Redirects the App Server response to a given location.

xdmp:request

Returns the unique key of the current request.

xdmp:request-cancel

Cancel the request with the given host, server, and request IDs.

xdmp:request-status

Returns the status of a running request.

xdmp:request-timestamp

Returns the system timestamp for this request if the request is a query statement.

xdmp:role-roles

Returns the set of all roles inherited by a given role, including roles directly assigned to the role and roles inherited from other roles.

xdmp:save

Serializes a node as text and saves it to a file.

xdmp:schema-database

Returns the database ID of the schema database associated with the current database.

xdmp:security-assert

Tests whether the current user has at least one of a given set of privileges.

xdmp:security-database

Returns the database ID of the security database associated with the current database.

xdmp:server

Returns the the ID(s) of the App Server specified in the parameter.

xdmp:server-name

Return the name of the App Server with the given ID.

xdmp:server-status

Returns the status of an app-server on a host.

xdmp:servers

Returns a sequence of the IDs of all the App Servers in the system.

xdmp:set

Set the value of a variable to the specified expression.

xdmp:set-response-code

Sets the response code and message.

xdmp:set-response-content-type

Sets the response content-type.

xdmp:set-session-field

Sets the value of a named HTTP session field.

xdmp:spawn

Place the specified module on the task queue for evaluation.

xdmp:spawn-in

[DEPRECATED--use xdmp:spawn with the database option instead] Place the specified module on the task queue for evaluation.

xdmp:strftime

Formats a dateTime value using POSIX strftime.

xdmp:subbinary

Returns a binary node made up of a subset of the given binary node.

xdmp:tidy

Run tidy on the specified html document to convert the document to well-formed and clean XHTML.

xdmp:trace

Signal a trace event.

xdmp:triggers-database

Returns the database ID of the triggers database associated with the current database.

xdmp:unquote

Parses a string as XML, returning one or more document nodes.

xdmp:uri-content-type

Returns the content type of the given URI as matched in the mimetypes configuration.

xdmp:uri-format

Returns the format of the given URI as matched in the mimetypes configuration.

xdmp:uri-is-file

Returns true if a given URI refers to a file which exists on the current application server.

xdmp:url-decode

Converts URL-encoded string to plaintext.

xdmp:url-encode

Converts plaintext into URL-encoded string.

xdmp:user-roles

Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles.

xdmp:version

Returns the current MarkLogic Server version.

xdmp:word-convert

Converts a Microsoft Word document to XHTML.

xdmp:zip-create

Create a zip file from a list of nodes.

xdmp:zip-get

Get a named file from a zip document.

xdmp:zip-manifest

Return a manifest for this zip file.

xhtml:add-lists

Infer numbered or bulleted lists and insert appropriate markup.

xhtml:clean

Clean up the XHTML: pruning empty spans, consolidating adjacent spans, etc.

xhtml:restructure

Turn an XHTML with flat structure into one with div structure based on the header elements.