Deletes from the database every document in a collection. If there are no documents in the specified collection, then nothing is deleted, and xdmp:collection-delete still returns the empty sequence.

  xdmp:collection-delete("collection-uri")

Creates a directory. If security is enabled, the document permissions and collections are set to the given parameters, if supplied. Otherwise, the current user's default permissions and/or collections are applied. If the beginning of the the document URI is protected, the user must have access to that URI privilege. If the directory URI does not end with a '/' one is added. If the directory already exists, then an XDMP-DIREXISTS exception is thrown.

xdmp:directory-create("http://marklogic.com/a/",
            (xdmp:permission("development", "update"),
             xdmp:permission("qa", "read")),
             "http://marklogic.com/directories")

=> Creates a directory named "http://marklogic.com/a/",
   which has the parent directory "http://marklogic.com/".
   The directory is created with the specified permissions,
   and is added to the "http://marklogic.com/directories"
   collection.  
  

xdmp:directory-create("/dir/myDirectory/")

=> Creates a directory named "/dir/myDirectory/",
   which has the parent directory "/dir/", which
   in turn has parent directory "/". If 
   directory creation is set to automatic in
   the database configuration, this example creates
   all three directories ("/", "/dir/", and 
    "/dir/myDirectory/").  
  

Deletes a directory and its children from the database.

If you delete a directory, the directory and all of its children are deleted, including all child documents and directories. A child document or directory of a given directory is one whose URI begins with the same string as the directory URI.

  xdmp:directory-delete("http://example.com/")

Adds the named document to the given collections. For each collection that is protected, the user must have permissions to update that collection or have the any-collection privilege. For each unprotected collection, the user must have the unprotected-collections privilege.

If adding an unprotected collection to a document, the unprotected-collections privilege (http://marklogic.com/xdmp/privileges/unprotected-collections) is needed; if adding a protected collection, the user must have either permissions to update the collection or the any-collection privilege (http://marklogic.com/xdmp/privileges/any-collection).

  xdmp:document-add-collections(
    "/example.xml", 
    ("http://examples.com", "http://marklogic.com"))

Adds the given permissions to the given document or directory. The user must have update or insert permissions on the document.

  xdmp:document-add-permissions(
    "/example.xml", 
    (xdmp:permission("development", "update"), 
     xdmp:permission("qa", "read")))

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

  xdmp:document-add-properties(
         "example.xml", 
         (<priority>1</priority>,
          <status>unedited</status>))
  => ()

Deletes a document from the database.

The xdmp:document-delete function deletes a document and all of its properties, except the directory property; it does not delete a directory with the same URI as the document being deleted. To delete a directory, use the xdmp:directory-delete function.

If a document does not exist at the specified URI, xdmp:document-delete returns an error.

xdmp:document-delete("example.xml")

Inserts a new document into the database if a document with the specified URI does not already exist. If a document already exists at the specified URI, the function replaces the content of the existing document with the specified content (the $root parameter) as an update operation. In addition to replacing the content, xdmp:document-insert replaces any permissions, collections, and quality with the ones specified (or with the default values for these parameters, if not explicitly specified). Also, if a properties document exists at the same URI, that properties document (including any content it contains) is preserved.

  xdmp:document-insert(
         "/example.xml", <a>aaa</a>,
            (xdmp:permission("editor", "read"), 
             xdmp:permission("editor", "update")),
         "http://examples.com")

  xdmp:document-insert(
         "/example.xml", 
	 <a>aaa</a>,
         xdmp:default-permissions(), 
         xdmp:default-collections(), 
	 10)

(: 
   Specify the forest IDs to move a delete-only document 
   from one forest to another (assuming at least one of 
   the forests allows updates). 
:)
  xdmp:document-insert(
         "/example.xml", 
	 <root>new content here</root>, (), (), 0,
	 xdmp:database-forests(xdmp:database()) )

Inserts a new document with the specified URI. If a document already exists at the URI, the function replaces the content in the existing document as an update operation.

http://marklogic.com/xdmp/privileges/xdmp-document-load

If a new document is inserted, you also need the unprotected-uri privilege (only if the URI is not protected), the any-uri privilege, or an appropriate URI privilege.

If adding an unprotected collection to a document, the unprotected-collections privilege (http://marklogic.com/xdmp/privileges/unprotected-collections) is needed; if adding a protected collection, the user must have either permissions to update the collection or the any-collection privilege (http://marklogic.com/xdmp/privileges/any-collection).

xdmp:document-load("c:\myFile.xml", 
    <options xmlns="xdmp:document-load">
      <uri>/documents/myFile.xml</uri>
      <repair>none</repair>
      <permissions>{xdmp:default-permissions()}</permissions>
    </options>)

=> Loads the document with a URI "/documents/myFile.xml"
   and does not perform tag repair during the load.

xdmp:document-load("http://myCompany.com/file.xml", 
    <options xmlns="xdmp:document-load"
             xmlns:http="xdmp:http">
      <uri>/documents/myFile.xml</uri>
      <repair>none</repair>
      <permissions>{xdmp:default-permissions()}</permissions>
      <format>xml</format>
      <http:authentication>
          <http:username>user</http:username>
          <http:password>pass</http:password>
      </http:authentication>
    </options>)

=> Loads the document with a URI "/documents/myFile.xml"
   from the server http://myCompany.com, sending the
   credentials user/pass. Tag repair is not performed
   during the load, and the document is loaded as xml.

xdmp:document-load("c:\myFile.xml",
    <options xmlns="xdmp:document-load">
       <uri>/documents/myFile.xml</uri>
       <permissions>{xdmp:default-permissions()}</permissions> 
       <collections>
          <collection>myCollection1</collection>
	  <collection>myCollection2</collection>
       </collections> 
       <repair>full</repair>
       <forests>
         <forest>{xdmp:forest("myForest")}</forest>
       </forests>
    </options> )

=> Loads the document with a URI "/documents/myFile.xml"
   performing tag repair during the load, adding the 
   document to the "myCollection1" and "myCollection2"
   collections, and loading the document into the forest 
   named "myForest".

Removes the named document from the given collections. For each collection that is protected, the user must have permissions to update that collection or have the any-collection privilege. For each unprotected collection, the user must have the unprotected-collections privilege.

  xdmp:document-remove-collections(
    "/example.xml", 
    ("http://examples.com", "http://marklogic.com"))

Removes the given permissions from the named document or directory. The user must have update permissions on the document or directory.

  xdmp:document-remove-permissions(
    "/example.xml", 
    (xdmp:permission("development", "update"), 
     xdmp:permission("qa", "read")))

Removes a sequence of properties from the properties of a document. If properties with the QNames given do not exist, nothing is done.

  xdmp:document-remove-properties(
         "example.xml", 
         (fn:QName("", "priority"),
          fn:QName("", "status")))
  => ()

Sets the named document to belong to the given collections, replacing any previously set collections on the named document. To preserve existing collections, use xdmp:document-add-collections. For each collection that is protected, the user must have permissions to update that collection or have the any-collection privilege. For each unprotected collection, the user must have the unprotected-collections privilege.

  xdmp:document-set-collections(
    "/example.xml", 
    ("http://examples.com", "http://marklogic.com"))

Sets the permissions on the named document (or directory) to the given permissions, replacing any permissions previously set on the document (or directory). To preserve any existing permissions, use xdmp:document-add-permissions. The user must have update permissions on the document or directory.

  xdmp:document-set-permissions(
    "/example.xml", 
    (xdmp:permission("development", "update"), 
     xdmp:permission("qa", "read")))

Sets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document. To preserve existing document properties, use xdmp:document-add-properties. Each element QName is the property name and the element value is the property value. Modifying properties requires update permissions on a document.

  xdmp:document-set-properties(
         "example.xml", 
         (<priority>1</priority>,
          <status>unedited</status>))
  => ()

Sets a property on a document. If any properties with the same property QName exist, they are replaced with the new property. If no properties exist with the same QName, the new property is added.

xdmp:document-set-property(
  "http://marklogic.com/a/example.xml",
  <priority xmlns="http://example.com">5</priority>)
  

Sets the quality of the document with the given URI. If the quality of the document is positive, the relevance score of the document is increased in text search functions. The converse is true for "negative" quality.

  xdmp:document-set-quality(
    "http://www.marklogic.com/test.xml",10)
  => ()

[DEPRECATED: use xdmp:document-load instead] Inserts a new document from the XML file at $path if a document with the specified URI does not already exist. Otherwise, the function replaces the content in the existing document as an update operation.

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

If a new document is inserted, you also need the unprotected-uri privilege (only if the URI is not protected), the any-uri privilege, or an appropriate URI privilege.

If no format is specified in $options, it is specified by the document content type specified by the extension of the document URI. The mimetype extensions and corresponding content types are set in the Admin Interface.

If neither "repair-full" nor "repair-none" is present, the default is specified by the XQuery version of the caller. In XQuery version 1.0 and 1.0-ml the default is "repair-none". In XQuery version 0.9-ml the default is "repair-full".

  xdmp:load("/home/test/example.xml", "/example.xml", 
            (xdmp:permission("editor", "read"), 
             xdmp:permission("editor", "update")),
            "http://examples.com",
            10,"http://www.marklogic.com/default")

  xdmp:load("/home/test/example.xml", 
	    "/example.xml", 
            xdmp:default-permissions(), 
            xdmp:default-collections(),
            0, 
	    "", 
	    "repair-none")

Acquire a lock on a document or directory for an extended amount of time. Locks restrict updates to a document or directory to the user who acquires the lock.

If you lock a directory specifying a depth of "infinity", the directory and all of it children (all documents and directories with a URI started with the locked directory) are locked. You will not be able to add any children to the directory until the lock is released.

When a user locks a URI, it is locked to other users, but not to the user who locked it. For example, if the user sam locks the URI /home/sam.xml by issuing the statement xdmp:lock-acquire("/home/sam.xml"), the user sam can still issue update commands to the document at that URI, but other users (for example, the user josh) will get an exception if they try to update the document.

If you attempt to acquire a lock on a document that already has a lock, the XDMP-LOCKCONFLICT exception is thrown.

If you attempt to update a document that is locked by another user, the XDMP-LOCKED exception is thrown.

  xdmp:lock-acquire("/example.xml", 
           "exclusive",
           "0",
           <DAV:href>http://example.com/~user</DAV:href>,
           xs:unsignedLong(120))
  => ()

Unlock a document or directory. Releases the lock created with xdmp:lock-acquire.

  xdmp:lock-release("/example.xml")
  => () 

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

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

  xdmp:merge(<options xmlns="xdmp:merge">
       	       <merge-max-size>10</merge-max-size>
               <merge-timestamp>8273</merge-timestamp>
               <single-stand>false</single-stand>
               <forests>
                 <forest>{xdmp:forest("my-forest")}</forest>
                 <forest>{xdmp:forest("my-other-forest")}</forest>
               </forests>
	     </options>)
   => ()
   Performs a merge on my-forest and my-other-forest (assuming 
   they are in the database). If a stand created by this 
   merge would be greater than 10 megabytes, the merge will be 
   limited and not all stands will be merges (as many as can 
   be merged under 10 MB will be merged).  If my-forest or
   my-other-forest have only one stand, they will not be 
   merged.  Any fragments with timestamp 8273 or newer will 
   not be garbage collected.

Returns the forest IDs of any currently merging database forests.

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

  xdmp:merging()
   => 23487234872334

Deletes a node from the database. On-the-fly constructed nodes cannot be deleted.

  xdmp:document-insert("/example.xml", 
    <a><b>bbb</b></a>);
  xdmp:node-delete(doc("/example.xml")/a/b);
  doc("/example.xml")
 => 
  <a/>

Adds an immediately following sibling to a node.

Attribute nodes cannot be followed by non-attribute nodes. Non-attribute nodes cannot be followed by attribute nodes. Element nodes cannot have document node children. Document nodes cannot have multiple element node children. On-the-fly constructed nodes cannot be updated.

  xdmp:document-insert("/example.xml", 
    <a><b>bbb</b></a>);
  xdmp:node-insert-after(doc("/example.xml")/a/b, 
    <c>ccc</c>);
  doc("/example.xml")
 => 
  <a><b>bbb</b><c>ccc</c></a>

Adds an immediately preceding sibling to a node.

Attribute nodes cannot be preceded by non-attribute nodes. Non-attribute nodes cannot be preceded by attribute nodes. Element nodes cannot have document node children. Document nodes cannot have multiple element node children. On-the-fly constructed nodes cannot be updated.

  xdmp:document-insert("/example.xml", 
    <a><b>bbb</b></a>);
  xdmp:node-insert-before(doc("/example.xml")/a/b, 
    <c>ccc</c>);
  doc("/example.xml")
 => 
  <a><c>ccc</c><b>bbb</b></a>

Adds a new last child to a node. Only element nodes and document nodes can have children. Element nodes cannot have document node children. Document nodes cannot have multiple element node children. On-the-fly constructed nodes cannot be updated. The parameters must specify individual nodes and not node sets.

  xdmp:document-insert("/example.xml", 
    <a/>);
  xdmp:node-insert-child(doc("/example.xml")/a,
    <b>bbb</b>);
  doc("/example.xml")
 => 
  <a><b>bbb</b></a>

  xdmp:document-insert("/example.xml", <a/>);
  xdmp:node-insert-child(doc("/example.xml")/a, 
    attribute b { "bbb" });
  doc("/example.xml")
 => 
  <a b="bbb"/>

Replaces a node.

Attribute nodes cannot be replaced by non-attribute nodes. Non-attribute nodes cannot be replaced by attribute nodes. Element nodes cannot have document node children. Document nodes cannot have multiple element node children.

  xdmp:document-insert("/example.xml", 
    <a><b>bbb</b></a>);
  xdmp:node-replace(doc("/example.xml")/a/b, <c>ccc</c>);
  doc("/example.xml")
 =>
  <a><c>ccc</c></a>

(: This example shows how to update the root 
   node of a text format document.  Start by 
   creating a text document.     :)

xdmp:document-insert("/mydir/doc.txt",
text{"This is a line of text."} ) ;

(: Update the text node of the text document 
   by appending another line of text to the 
   text node.  Note that the text node is the
   root node of a text document.     :)

xdmp:node-replace(doc("/mydir/doc.txt")/text() ,
text{ concat(doc("/mydir/doc.txt")/text(), "
This is another line of text.") } ) ;

doc("/mydir/doc.txt")
=>
This is a line of text.
This is another line of text.

Serializes a node as text and saves it to a file. The node can be any node, including a document node, an element node, a text node, or a binary node.

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

  (: serialize an XML document in the database to a file on disk :)
  let $mynode := doc("/mydocs/example.xml")
  return
  xdmp:save("example.xml", $mynode)

  (: save a text file :)
  let $text := text { "hello" }
  return
  xdmp:save("hello.txt", $text)

  (: save a pdf stored in the database to disk :)
  let $pdf := doc("/mydocs/stuff.pdf")
  return
  xdmp:save("mystuff.pdf", $pdf)