Loading TOC...

xdmp:document-insert

xdmp:document-insert(
   $uri as xs:string,
   $root as node(),
   [$options as (element()|map:map)?]
) as empty-sequence()

Summary

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.

Parameters
$uri The URI of the document to be inserted.
$root The root node. The root node can be one of JSON format, XML format, binary (BLOB) format, or text (CLOB) format.
$options

The options node for this insert operation. The default value is (). The node for the xdmp:document-load options must be in the xdmp:document-insert namespace. This parameter can also include option elements in the xdmp:http namespace for the HTTP parameters.

The xdmp:document-insert options include:

<permissions>

Security permission elements corresponding to the permissions for the document. If not supplied, the current user's default permissions are applied. The default value used for permissions can be obtained by calling xdmp:default-permissions(). A document that is created by a non-admin user (that is, by any user who does not have the admin role) must have at least one update permission, otherwise the creation will throw an XDMP-MUSTHAVEUPDATE exception.

<collections>

The collection URIs for collections to which this document belongs. If not supplied, the document is added to the current user's default 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. The default value used for collections can be obtained by calling xdmp:default-collections(). Specify the collection URIs in <collection> child elements of this option, one URI per child.

<quality>

The quality of this document. A positive value increases the relevance score of the document in text search functions. The converse is true for a negative value. The default value is 0.

<forests>

Specifies the IDs of one or more forests in which this document is inserted. Each forst is specified in a separate <forest> element. If the document already exists in the database and if forests is not specified, it will remain in its existing forest. If no such forest exists or if no such forest is attached to the context database, an error is raised. If multiple forests are specified, the document is inserted into one of the specifed forests. If the document exists and the forest in which it is stored is set to delete-only, then you must set forests to include one or more forests that allow updates, otherwise an exception is thrown.

If you have local disk failover enabled, specify the ID of the master forest. In the event of a failover, MarkLogic server will automatically redirect documents to the replica forest. Specify the ID of the replica forest will result in a "forest not in database" error.

<metadata>

Specifies key-value pairs representing certain metadata associated with the document. The value of a metadata element is a serialized map containing the key-value pairs.

Required Privileges

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 adding an unprotected collection to a document, the unprotected-collections privilege is needed; if adding a protected collection, the user must have either permissions to update the collection or the any-collection privilege.

Example

xdmp:document-insert(
    "/example.xml", <a>aaa</a>,
    <options xmlns="xdmp:document-insert">
      <metadata>{
        map:map() => map:with("w", "world")
                  => map:with("h", "hello")
      }</metadata>
      <permissions>{xdmp:default-permissions()}</permissions>
    </options>)

Example

(: Insert with perm, collection, and quality options. Notice that this
 : example adds to, rather than replaces, the default collections. :)
xdmp:document-insert(
    "/example.xml",
    <a>aaa</a>,
    <options xmlns="xdmp:document-insert">  
      <permissions>{xdmp:default-permissions()}</permissions>
      <collections>{
        <collection>/my/additional/collection</collection>,
        for $coll in xdmp:default-collections()
        return <collection>{$coll}</collection>
      }</collections>
      <quality>10</quality>
    </options>)

Example

(: Expressing options as a map instead of an element :)
xquery version "1.0-ml";
xdmp:document-insert("/example.xml", <a>aaa</a>,
  map:map() => map:with("collections", ("coll1","coll2"))
            => map:with("quality", 2)
)

Example

(:
   Specify the valid start and end time for a temporal document.
:)
xdmp:document-insert(
    "/example.xml",
    <root>new content here</root>, 
    <options xmlns="xdmp:document-insert">  
      <metadata>{
        map:map() => map:with("valid-start", "2014-06-03T14:13:05.472585-07:00")
                  => map:with("valid-end", "9999-12-31T11:59:59Z")
      }</metadata>
    </options>)

Example

xquery version "1.0-ml";
(: create a text document :)
xdmp:document-insert("/text-doc.txt",
   text { "This is a text document." } )

Comments

  • One way to ingest / insert text /XQY documents to MarkLogic https://uploads.disquscdn.com/images/ad35b39ef6b867698636f79e9578f09a3fba2e3137a03a2fff9457679566cd34.png
  • Gives an error while providing a forestID as mentioned in the example:( [1.0-ml] XDMP-PLACEKEYSLOCKING
    • Generally speaking, you should not specify the forest using the forestID parameter. For more information, see http://docs.marklogic.com/guide/ingestion/xquery#id_24146
  • while not specifically about xdmp:document-insert, this tutorial http://developer.marklogic.com/learn/config_status (specifically the client-manage-example-ml5.xqy) does a great job at explaining how it works
Powered by MarkLogic Server 7.0-4.1 and rundmc | Terms of Use | Privacy Policy