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

  xdmp:access(
         "http://example.com/foo.xml",
         "create")
   => true()

Converts base64-encoded string to plaintext.

xdmp:base64-decode(
     "c2xpbmdzIGFuZCBhcnJvd3Mgb2Ygb3V0cmFnZW91cyBmb3J0dW5l")
=> slings and arrows of outrageous fortune

Converts plaintext into base64-encoded string.

  xdmp:base64-encode("slings and arrows of outrageous fortune")
   => c2xpbmdzIGFuZCBhcnJvd3Mgb2Ygb3V0cmFnZW91cyBmb3J0dW5l

Returns locks of documents in a collection.

  for $d in xdmp:collection-locks(
                     ("http://example.com/col1/",
                      "http://example.com/col2/"))
  return base-uri($d)
  => http://example.com/bar.xml 
     http://example.com/baz.xml

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

  declare namespace cpf="http://marklogic.com/cpf"

  for $d in xdmp:collection-properties(
                   ("http://example.com/col1/",
                    "http://example.com/col2/"))
  where $d/property::cpf:error
  return base-uri($d)

  => A list of document URIs of documents that have a 
        cpf:error property in their corresponding properties 
	documents.  For example:

      http://example.com/bar.xml http://example.com/baz.xml

Returns the the ID of the database named in the the parameter. Returns the ID of the current database if no parameter is specified.

  xdmp:database("myDB")
  => 74495681647284736476

Returns a sequence of forest IDs in the specified database.

  xdmp:database-forests(xdmp:database("Documents"))
  => (8456374036761185098, 10615125154705099114)

Return the name of the database with the given ID.

xdmp:database-name(8456374036761185098)
=> "Documents"

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

  xdmp:databases()
   => (14389140626518478220,
          8456374036761185098,
	  10615125154705099114)

Returns a string whose value corresponds to the description of a given item sequence.

  xdmp:describe(current-date())
  => xs:date("2003-04-15-08:00")

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

xdmp:diacritic-less("José")
=> Jose 

Returns the documents in a directory.

  for $d in xdmp:directory("http://example.com/foo/","1")
  return base-uri($d)
  => http://example.com/foo/bar.xml 
     http://example.com/foo/baz.xml

Returns locks of documents in a directory.

  for $d in xdmp:directory-locks("http://example.com/foo/","1")
  return base-uri($d)
  => http://example.com/foo/bar.xml 
     http://example.com/foo/baz.xml

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

  xdmp:directory-properties("http://example.com/dir/","1")
  => <prop:properties 
            xmlns:prop="http://marklogic.com/xdmp/property">
         <prop:directory/>
     </prop:properties>
   

The properties document returned has one directory element, indicating that there is a single directory that is an immediate child of the specified directory.

Returns the forest ID of the forest in which the document with the specified URI is stored. Otherwise, returns the empty sequence.

  xdmp:document-forest("example.xml")
  => 12972338785465832200

Returns the document in the XML file specified by $location.

If no format is specified in $options, and the document is from an HTTP server, the format is specified by the document content type from the HTTP response. If no format is specified in $options, and the document is from the filesystem, the format is specified by the document content type from the filename extension. The mimetype extensions and corresponding content types are set in the Admin console.

If neither "repair" option is specified, malformed XML content will be repaired.

When the document is from an HTTP server, xdmp:document-get will always return the response from the HTTP server, even if it is an error response such as 404 or 500. If you want to be able to examine the response header in your application, use the xdmp:http-get instead, which returns both the response header and the response.

  xdmp:document-get("myDocument.xml")
  => the xml contained in myDocument.xml, 
        for example, <myDocument/>

  xdmp:document-get("myDocument.html", 
       <options xmlns="xdmp:document-get">
           <repair>full</repair>
       </options>)
  => myDocument.html as an XML document that has gone 
     through any needed tag repair

  xdmp:document-get("http://myCompany.com/file.xml", 
       <options xmlns="xdmp:document-get"
                xmlns:http="xdmp:http">
           <format>xml</format>
           <http:authentication>
	      <http:username>user</http:username>
	      <http:password>pass</http:password>
	   </http:authentication>
       </options>)
  => gets an XML document named file.xml, sending the 
     authentication credentials user/pass to the 
     http://myCompany.com server
  

Returns the collections to which a given document belongs.

  xdmp:document-get-collections("chapter5.xml")
  =>("http://marklogic.com/all-books", 
        "http://marklogic.com/xml-books")

Returns the property values for a document's property.

  xdmp:document-get-properties(
         "http://example.com/foo.xml",
         expanded-QName("http://examples.com/","priority"))
   => <priority xmlns="http://examples.com/">5</priority>

Returns the quality of the specified document if the document exists. Otherwise, returns the empty sequence.

  xdmp:document-get-quality("example.xml")
  => 10

Returns the locks for one or more documents or directories. Returns the locks for all documents and directories in the database if no parameter is given.

  xdmp:document-locks("example.xml")
  => <lock:lock>
          <lock:active-locks>
            <lock:active-lock>
              <lock:lock-type>write</lock:lockt-ype>
              <lock:lock-scope>exclusive</lock:lock-scope>
              <lock:depth>infinity</lock:depth>
              <lock:owner>
                http://example.com/~user
              </lock:owner>
              <lock:timeout>5000</lock:timeout>
              <lock:lock-token>
                  http://marklogic.com/xdmp/locks/e71d4fae
              </lock:lock-token>
              <lock:timestamp>5234768</lock:timestamp>
              <sec:user-id>52378234768</sec:user-id>
            </lock:active-lock>
          </lock:active-locks>
        </lock:lock>

Returns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document. If no documents are specified, returns a sequence of properties documents for all documents in the database that have a corresponding properties document.

  xdmp:document-properties()
    => 
    <prop:properties 
          xmlns:prop="http://marklogic.com/xdmp/property">
    Property Node1
    </prop:properties>
    <prop:properties 
          xmlns:prop="http://marklogic.com/xdmp/property">
    Property Node2
    </prop:properties>
    <prop:properties 
          xmlns:prop="http://marklogic.com/xdmp/property">
    Property NodeN
    </prop:properties>

Send an email in an XQuery program. A valid SMTP Relay must be configured in the Groups page of the Admin console for the email to be sent. The format of the email message must be an XML file that complies with the schema files listed below.

http://marklogic.com/xdmp/privileges/xdmp-email

This example demonstrates sending a message with 
HTML content.
   
xdmp:email(
<em:Message 
 xmlns:em="URN:ietf:params:email-xml:" 
 xmlns:rf="URN:ietf:params:rfc822:">
  <rf:subject>Sample HTML Email</rf:subject>
  <rf:from>
    <em:Address>
      <em:name>Mark Logic</em:name>
      <em:adrs>marklogic@yourdomain</em:adrs>
    </em:Address>
  </rf:from>
  <rf:to>
    <em:Address>
      <em:name>System Administrator</em:name>
      <em:adrs>admin@yourdomain</em:adrs>
    </em:Address>
  </rf:to>
  <em:content>
    <html xmlns="http://www.w3.org/1999/xhtml"> 
      <head>
        <title>Test HTML message</title>
      </head>
      <body>
        <h1>Test HTML message</h1>
        <p>Here is a simple paragraph</p>
      </body> 
    </html>
  </em:content>
</em:Message>)

This example demonstrate sending a message with 
plain text content. 

xdmp:email(
<em:Message 
 xmlns:em="URN:ietf:params:email-xml:" 
 xmlns:rf="URN:ietf:params:rfc822:">
  <rf:subject>Sample Plain Text Email</rf:subject>
  <rf:from>
    <em:Address>
      <em:name>Mark Logic</em:name>
      <em:adrs>marklogic@yourdomain</em:adrs>
    </em:Address>
  </rf:from>
  <rf:to>
    <em:Address>
      <em:name>System Administrator</em:name>
      <em:adrs>admin@yourdomain</em:adrs>
    </em:Address>
  </rf:to>
  <em:content xml:space="preserve">
This is a sample email with a plain text body.
</em:content>
</em:Message>)

Returns the number of fragments selected by an expression. This can be used as a fast estimate of the number of items in a sequence.