Deletes from the database every document in a collection.

  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 nothing is done.

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

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-collection privilege.

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

Adds the given permissions to the given document. 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. Otherwise, the function replaces the content in the existing file as an update operation.

  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)

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.

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-collection privilege.

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

Removes the given permissions from the named document. User must have update permissions on the document.

  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:expanded-QName("", "priority"),
          fn:expanded-QName("", "status")))
  => ()

Sets the named document to belong 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-collection privilege.

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

Sets the permissions on the named document to the given permissions. User must have update permissions on the document.

  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. 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] 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, the unprotected-uri privilege (only if the URI is not protected), the any-uri privilege, or an appropriate URI privilege is also needed.

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 console.

If neither "repair-full" nor "repair-none" is present, malformed XML content will be repaired.

  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")

Aquire a lock on a document or directory for an extended amount of time. Locks restrict updates to a document or directory.

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.

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

Unlock a document.

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

Starts merging the database forests.

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

  xdmp:merge()
   => ()

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 arguments 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>

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

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

  xdmp:save("example.xml", $mynode)