temporal.documentInsert

temporal.documentinserttemporaldocumentinsert

/apidoc/8.0/temporal:document-insert.xml

This function inserts a document into the database and stores it as a temporal document. The document will belong to the specified temporal collection to ensure that it can only be updated or deleted using the temporal functions. If a temporal document already exists at the specified URI, this function performs an update instead of an insert. (Note that updates on temporal documents mean that a new document is created in the temporal collection with a different time period.)

An exception is thrown if $temporal-collection is not temporal or $collection includes temporal collection(s).

The URI for the protected temporal collection in which the document is to belong. This must have been previously created by the temporal:collection-create function. All versions of the temporal document will be associated with this temporal collection.

temporal-collection

String

The URI to be used to identify the document in the database. If the document is not the latest version, a suffix will be concatenated to the document URI with a dot as the new URI of the document.

uri

String

The root node of the document. The root node can be one of XML format, JSON format, binary (BLOB) format, or text (CLOB) format.

root

Node

Security permission objects corresponding to the permissions for the document. The permissions specified only apply to the latest document versions created in this operation; previous versions of the documents will retain their previous permissions. If not supplied, the current user's default permissions are applied. The default value used for permissions can be obtained by calling xdmp.defaultPermissions(). 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.

permissions

Object[]

The collection URIs for any additional, non-temporal collections the document is to belong to. 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(). The collections specified only apply to the latest document versions created in this operation; previous versions of the documents will retain their previous collections.

collections

String[]

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.

quality

xs.int?

Specifies the ID of the forest in which this document is inserted. If the document already exists in the database and if $forest-ids 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 $forest-ids 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.

forest-ids

String[]

null

declareUpdate();

var root =
{
   "systemStart" : "2001-01-01T00:00:00Z",
   "systemEnd" : "2001-01-01T00:00:00Z",
   "validStart" : "2014-06-03T14:13:05.472585-07:00",
   "validEnd" : "9999-12-31T23:59:59.99Z",
   "content" : "v1-content here"
}

temporal.documentInsert( "temporalCollection", "doc.json", root )