|
|
dls:document-add-collections(
|
|
$uri as xs:string,
|
|
$collections as xs:string*
|
| ) as empty-sequence() |
|
|
|
Summary:
This function adds the named document to the specified collections.
|
Parameters:
|
$uri
:
The URI of
the document to be added to the collection.
|
|
$collections
:
A set of collection URIs.
|
|
Required Privilege:
The dls-user role is required to run this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
For each collection
that is protected, the user must have permissions to update that collection or
the privilege:
http://marklogic.com/xdmp/privileges/any-collection
For each unprotected collection, the user must have the privilege:
http://marklogic.com/xdmp/privileges/unprotected-collections
The document must specify dls-user(update) permission.
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-add-collections(
"/foo/bar/baz.xml",
"http://marklogic.com/documents/foo")
(: Adds 'bax.xml' to the 'foo' collection. :)
|
|
|
|
dls:document-add-permissions(
|
|
$uri as xs:string,
|
|
$permissions as element(sec:permission)*
|
| ) as empty-sequence() |
|
|
|
Summary:
This function adds the specified permissions for the named document. Any
permissions that were previously set for the document are retained.
|
Parameters:
|
$uri
:
The URI of
the document.
|
|
$permissions
:
The permissions to be added for the document.
|
|
Required Privilege:
The dls-user role is required to run this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
The document must specify dls-user(update) permission.
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-add-permissions("/foo/bar/baz.xml",
(xdmp:permission("dls-user", "read"),
xdmp:permission("dls-user", "update")))
(: Adds the specified permissions to the list of permissions for the 'baz.xml'
document. :)
|
|
|
|
dls:document-checkout(
|
|
$uri as xs:string,
|
|
$deep as xs:boolean,
|
|
[$annotation as item()?],
|
|
[$timeout as xs:unsignedLong?]
|
| ) as empty-sequence() |
|
|
|
Summary:
This function checks out (locks) the document at the
specified URI to prevent other users from modifying the document. An
exception is thrown if the document does not yet exist or does exist
but is not managed.
|
Parameters:
|
$uri
:
The URI of the document to check out.
|
|
$deep
:
If set to true, then
any documents
directly or indirectly included by the specified document are also checked out.
|
|
$annotation
(optional):
Any comments you
want to add to the document's active-lock element.
|
|
$timeout
(optional):
The duration of the
checkout, in seconds. For infinite, omit this parameter or specify ().
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-checkout("/foo/bar/baz.xml", fn:true(), "updating doc", 3600)
(: Checks out the 'baz'xml' document, and all of its included documents,
for one hour. :)
|
|
|
|
dls:document-delete(
|
|
$uri as xs:string,
|
|
$keep-old-versions as xs:boolean,
|
|
$retain-history as xs:boolean
|
| ) as empty-sequence() |
|
|
Summary:
This function removes the specified managed document.
You must have update permissions on the document to delete it.
If you set $retain-history to true, you can use
xdmp:document-properties to view the deleted document's properties
fragment in the database.
|
Parameters:
|
$uri
:
The URI of
the document.
|
|
$keep-old-versions
:
Determines whether to keep old versions of the document. Set to
false to delete all of the versions of the document.
|
|
$retain-history
:
Determines whether to retain the deleted document's property fragment
in the database. Set to true to
retain the property fragment, or false to delete.
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-delete("/foo/bar/baz.xml", fn:false(), fn:true())
(: Deletes all versions of the 'baz.xml' document and retains the
property fragment for each version. :)
|
|
|
|
dls:document-extract-part(
|
|
$new-uri as xs:string,
|
|
$element as element(),
|
|
$annotation as item()*,
|
|
$retain-history as xs:boolean,
|
|
[$permissions as element(sec:permission)*],
|
|
[$collections as xs:string*],
|
|
[$quality as xs:integer?],
|
|
[$forest-ids as xs:unsignedLong*]
|
| ) as xs:string* |
|
|
Summary:
This function extracts an element from an existing document and creates a
new document from the
extracted element. The extracted element is removed from the root node document
and replaced by an XInclude to the new
document. A new version of the root node document is created.
You must have already performed a
dls:document-checkout of the document that contains the element to be
extracted.
The $new-uri must be an absolute path and is initially not checked out.
This will create a new version of both the original document and the newly
included document, with $annotation being used to create
a dls:annotation property on each of them.
|
Parameters:
|
$new-uri
:
The URI for the new document.
|
|
$element
:
The element to be extracted
and used to create the new document.
This element can be one of XML format, binary (BLOB) format, or text
(CLOB) format.
|
|
$annotation
:
Any comments you
want to add to the new versions of the documents.
|
|
$retain-history
:
Determines whether or not
to retain the document's properties fragment in the database. Set to
true to retain the original document's properties in order to track
when the document was updated and by whom. Otherwise, set to false.
|
|
$permissions
(optional):
The permissions to be set on the new document.
If not supplied, the your default permissions are applied. The default value
used for this parameter can be obtained by calling
xdmp:default-collections(). 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
(optional):
The collection URIs for the collections to which the new document is to belong.
If not supplied, the document is added to your current default collections.
For each collection that is protected, you must have permissions to update
that collection or have the any-collection privilege. For each unprotected
collection, you must have the unprotected-collections privilege. The default
value used for this parameter can be obtained by calling
xdmp:default-collections().
|
|
$quality
(optional):
Specifies the quality of the document created from the extracted element.
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.
|
|
$forest-ids
(optional):
Specifies the ID of the forest in which the document created from the extracted
element is inserted. If the document already exists in the database and if this
parameter 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 this parameter to include one or
more forests that allow updates, otherwise an exception is thrown.
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-extract-part("/foo/bar/baz-chapter1.xml",
fn:doc("/foo/bar/baz.xml")//CHAPTER1,
"part insert",
fn:true(),
(xdmp:permission("dls-user","insert"),
xdmp:permission("dls-user","read"),
xdmp:permission("dls-user","update"),
xdmp:permission("admin","insert"),
xdmp:permission("admin","read"),
xdmp:permission("admin","update")))
(: Extracts the <CHAPTER1> element from the 'baz.xml' file and creates a new document,
named 'baz-chapter1.xml', containing the extracted element. :)
|
|
|
|
dls:document-insert-and-manage(
|
|
$uri as xs:string,
|
|
$deep as xs:boolean,
|
|
$doc as node(),
|
|
[$annotation as item()*],
|
|
[$permissions as element(sec:permission)*],
|
|
[$collections as xs:string*],
|
|
[$quality as xs:integer?],
|
|
[$forest-ids as xs:unsignedLong*]
|
| ) as xs:string* |
|
|
|
Summary:
This function inserts a document into the database and places the document under
management.
|
Parameters:
|
$uri
:
The URI of the document.
|
|
$deep
:
Specifies whether to manage
this document as well as any documents for which this document
has XInclude references to. Specify true to manage
all XInclude references or false to not manage
any included documents. The default is false.
|
|
$doc
:
The contents of the document (root node). The document
root node can be one of XML format, binary (BLOB) format, or text (CLOB) format.
|
|
$annotation
(optional):
Any comments you want to add to the properties.
|
|
$permissions
(optional):
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
(optional):
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().
|
|
$quality
(optional):
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.
|
|
$forest-ids
(optional):
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.
|
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
let $contents :=
<BOOK>
<TITLE>Baz Goes to the Disco</TITLE>
<CHAPTER1>
<TITLE>Baz Wakes Up to James Brown and Feels Funky</TITLE>
</CHAPTER1>
</BOOK>
return
dls:document-insert-and-manage(
"/foo/bar/baz.xml",
fn:true(),
$contents)
(: Inserts 'baz.xml' into the database and places the document under management. :)
|
|
|
|
dls:document-purge(
|
|
$uri as xs:string,
|
|
$delete as xs:boolean,
|
|
$retain-history as xs:boolean
|
| ) as xs:string* |
|
|
Summary:
This function deletes all numbered versions of the specified
managed document and its referenced documents, as specified by the rention
policies set by dls:retention-rule. The document versions are
deleted if they
have no retention rule causing them to be kept and if they are not included
by documents that cannot yet be deleted. If $delete is
false, the document's versions are not actually deleted and instead
a list of the documents that would have been deleted is returned.
If you set $retain-history to true, you can use
xdmp:document-properties to view the deleted document's properties
fragment in the database.
|
Parameters:
|
$uri
:
The URI of the document to be purged.
|
|
$delete
:
Determines whether or not to delete the
documents. Set to true to remove the documents or false
to list which documents would have been deleted.
|
|
$retain-history
:
Determines whether to retain the deleted document's property fragment
in the database. Set to true to
retain the property fragment, or false to delete.
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-purge("/foo/bar/baz.xml", fn:false(), fn:true())
(: Returns the versions of the 'baz.xml' document and its referenced
documents, as specified by the rention policy. :)
|
|
|
|
dls:document-set-permissions(
|
|
$uri as xs:string,
|
|
$permissions as element(sec:permission)*
|
| ) as empty-sequence() |
|
|
|
Summary:
This function sets the specified permissions for the named document.
Any unspecified permissions that were previously set for the document are removed.
|
Parameters:
|
$uri
:
The URI of
the document.
|
|
$permissions
:
The permissions
to be set for the document.
|
|
Required Privilege:
The dls-user role is required to run this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
The document must specify dls-user(update) permission.
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-set-permissions("/foo/bar/baz.xml",
(xdmp:permission("dls-user", "read"),
xdmp:permission("dls-user", "update"),
xdmp:permission("Developer", "read"),
xdmp:permission("Developer", "update")))
(: Sets the permissions on the 'baz.xml' document. :)
|
|
|
|
dls:document-set-properties(
|
|
$uri as xs:string,
|
|
$properties as element()*
|
| ) as empty-sequence() |
|
|
|
Summary:
This function sets the properties of a document to the given
sequence of elements. With the exception of the Library Services properties, any properties
that already exist on the document are replaced.
To preserve existing document properties, use dls:document-add-properties.
Each element QName is the property name and the element value is the property value.
|
Parameters:
|
$uri
:
The URI of
the document.
|
|
$properties
:
The peroperties to be set
for the document.
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
Modifying properties requires update permissions on a document.
|
|
Usage Notes:
You cannot set any property nodes in the DLS namespace.
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-set-properties(
"/foo/bar/baz.xml",
(<priority>1</priority>,
<status>unedited</status>))
(: The <priority> and <status> properties are set to the 'baz.xml' document. :)
|
|
|
|
dls:document-update(
|
|
$uri as xs:string,
|
|
$doc as node(),
|
|
$annotation as item()*,
|
|
$retain-history as xs:boolean,
|
|
[$permissions as element(sec:permission)*],
|
|
[$collections as xs:string*],
|
|
[$quality as xs:integer?],
|
|
[$forest-ids as xs:unsignedLong*]
|
| ) as xs:string* |
|
|
Summary:
This function updates the managed document at the specified URI
with the specified contents. This function does an implicit dls:document-purge
and returns the URI of any version of the document purged as
the result of the established retention policy.
You must first check out the document
with dls:document-checkout before you can update,
otherwise an exception is thrown. If the document does not exist, then an
exception is thrown.
|
Parameters:
|
$uri
:
The URI of the document.
|
|
$doc
:
The new contents of the document.
|
|
$annotation
:
Any comments you
want to add to the new versions of the documents.
|
|
$retain-history
:
Determines whether or not
to retain the document's properties fragment in the database. Set to
true to retain the original document's properties in order to track
when the document was updated and by whom. Otherwise, set to false.
|
|
$permissions
(optional):
The permissions to be set on the updated document.
If not supplied, the your default permissions are applied. The default value
used for this parameter can be obtained by calling
xdmp:default-collections(). A document that is updated 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
(optional):
The collection URIs for the collections to which the updated document is to belong.
If not supplied, the document maintains its current collections.
For each collection that is protected, you must have permissions to update
that collection or have the any-collection privilege. For each unprotected
collection, you must have the unprotected-collections privilege. The default
value used for this parameter can be obtained by calling
xdmp:default-collections().
|
|
$quality
(optional):
Specifies the quality of the updated 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.
|
|
$forest-ids
(optional):
Specifies the ID of the forest in which the updated document is inserted.
If this parameter is not specified, the updated document will remain in the
original document's 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 this parameter to include one or
more forests that allow updates, otherwise an exception is thrown.
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
let $bazbook :=
<BOOK>
<TITLE>Baz Goes to the Disco</TITLE>
<CHAPTER1>
<TITLE>Baz Wakes Up</TITLE>
<PARA>
Baz woke up this afternoon to the sound of James Brown. Soon
Baz was feeling a little funky, so he put on his cleanest
propeller hat and headed out in search of a Disco.
</PARA>
</CHAPTER1>
</BOOK>
return
dls:document-update(
"/foo/bar/baz.xml",
$bazbook,
"Changed the title from Baz Feelin' Funky",
fn:true())
(: Updates the contents of 'baz.xml'. :)
|
|
|
|
dls:document-version-delete(
|
|
$uri as xs:string,
|
|
$version as xs:integer,
|
|
$retain-history as xs:boolean
|
| ) as empty-sequence() |
|
|
Summary:
This function removes the specified version of the managed
document at the specified URI. This overrides any configured retention policies
and should be used with care. You must have update permissions on the document
version in order to delete it.
If you set $retain-history to true, you can use
xdmp:document-properties to view the deleted document's properties
fragment in the database. For example, if you had deleted version 1 of
/foo/bar/baz.xml, you can view its properties by calling:
xdmp:document-properties("/foo/bar/baz.xml_versions/1-baz.xml")
|
Parameters:
|
$uri
:
The URI of
the document.
|
|
$version
:
The version of the document to
be deleted.
|
|
$retain-history
:
Determines whether or not
to retain the document's properties fragment in the database. Set to
true to retain the deleted document's properties in order to track
when the document was deleted and by whom. Otherwise, set to false.
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-version-delete("/foo/bar/baz.xml", 1, fn:true())
(: Deletes version 1 of the 'baz.xml' document and records it in the document
history. :)
|
|
|
|
dls:purge(
|
|
$delete as xs:boolean,
|
|
$retain-history as xs:boolean
|
| ) as xs:string* |
|
|
Summary:
This function deletes all numbered versions of managed documents and
its referenced documents (such as /foo/bar.xml_versions/1-bar.xml), as
specified by the rention policy set by one or more dls:retention-rule
functions. Documents are deleted if they
have no retention rule causing them to be kept and if they are not included
by some document that cannot yet be deleted. If $delete is
false, the document versions are not actually deleted and instead
a list of the documents that would have been deleted is returned. This function
returns a list of URIs that it would/did delete.
If you set $retain-history to true, you can use
xdmp:document-properties to view the deleted document's properties
fragment in the database.
|
Parameters:
|
$delete
:
Determines whether or not to delete the
documents. Set to true to delete the documents or false
to list which documents would have been deleted.
|
|
$retain-history
:
Determines whether to retain the deleted documents' property fragments in the database.
Set to true to retain the property fragments, or false to delete.
|
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:document-purge(fn:true(), fn:true())
(: Deletes all of the versions of the 'baz.xml' document and its
referenced documents. :)
|
|
|
|
dls:retention-rule(
|
|
$name as xs:string,
|
|
$comment as item()*,
|
|
$num-versions as xs:unsignedInt?,
|
|
$duration as xs:duration?,
|
|
$document-query-text as xs:string?,
|
|
$document-query as cts:query?
|
| ) as element(dls:retention-rule) |
|
|
Summary:
This function creates and returns a retention rule element.
Use dls:insert-retention-rule to insert the retention rule into
the database.
Specifying multiple constraints implies AND between them. For example,
specifying both $num-versions and $duration
retains a numbered
version only if it is both one of the N most recent versions and it was
created more recently than "now - duration." If neither
$num-versions or $duration is specified,
then any numbered version matching the document query is kept forever.
The $document-query-text parameter is intended to be
used for the human readable form of a query that was used to produce the
corresponding cts:query. This may be the text that a user
typed into a search text field in the UI. This parameter does NOT affect
the retention policy.
|
Parameters:
|
$name
:
The name of the retention rule. The name must be unique to this rule.
|
|
$comment
:
Comment that describes this retention rule.
|
|
$num-versions
:
The number of most recent versions to be retained. This means to keep versions
greater than (but not equal to) num-versions - current-version, if they still exist.
|
|
$duration
:
Retain all versions that were created on or after the duration date/time.
|
|
$document-query-text
:
Comment that describes the document query.
|
|
$document-query
:
The document query. Typically returned by a Query Constructor Function.
|
|
|
Required Privilege:
The dls-admin role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-admin
|
Example:
xquery version "1.0-ml";
import module namespace dls="http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:retention-rule(
"All Versions Retention Rule",
"Retain all versions of all documents",
(),
(),
"Locate all of the documents",
cts:and-query(() )
(: Returns a retention rule in XML format. :)
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:retention-rule(
"Rule1",
"Keep the five most recent versions of Jim's documents that are
15 days old or newer",
5,
xs:duration("P15D"),
"Locate documents authored by Jim",
dls:author-query(xdmp:user("Jim"))))
(: Returns a retention rule in XML format. :)
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:retention-rule(
"Rule2",
"Keep the five most recent versions of Jim's documents in the 'foo'
collection that are 15 days old or newer",
5,
xs:duration("P15D"),
"Locate documents in the 'foo' collection authored by Jim",
cts:and-query((
cts:collection-query("http://marklogic.com/documents/foo"),
dls:author-query(xdmp:user("Jim")) )) )
(: Returns a retention rule in XML format. :)
|
|
|
|
dls:retention-rule-insert(
|
|
$rules as element(dls:retention-rule)*
|
| ) as empty-sequence() |
|
|
|
Summary:
This function inserts retention rules into the database.
They will be readable by the dls-user role and modifiable/deletable by
the dls-admin role.
|
Parameters:
|
$rules
:
The retention
rule to be inserted.
|
|
|
Required Privilege:
The dls-admin role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-admin
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:retention-rule-insert((
dls:retention-rule(
"Rule1",
"Keep the five most recent versions of Jim's documents that are 15 days old or newer",
5,
xs:duration("P15D"),
"Locate all documents authored by Jim",
dls:author-query(xdmp:user("Jim"))),
dls:retention-rule(
"Rule2",
"Retain the five most recent versions of documents that match the query below",
5,
(),
"Locate only docs that include 'Baz' and 'Disco'" ,
cts:and-query((
cts:word-query("Baz"),
cts:word-query("Disco"))) ) ))
(: Inserts the retention rules, 'Rule1' and 'Rule2', into the database. :)
|
|
|
|
dls:retention-rules(
|
|
$names as xs:string*
|
| ) as element(dls:retention-rule)* |
|
|
|
Summary:
This function returns the specified retention rules from the database.
|
Parameters:
|
$names
:
The names of the retention rules to be returned. The name can include wild cards.
For example, a * can be used to retrieve all of the retention rules.
|
|
Required Privilege:
The dls-user role is required to run
this function, or the privilege:
http://marklogic.com/xdmp/privileges/dls-user
You must have read permissions on the rentention-rule
document to see the rules.
|
Example:
xquery version "1.0-ml";
import module namespace dls = "http://marklogic.com/xdmp/dls"
at "/MarkLogic/dls.xqy";
dls:retention-rules("Rule1")
(: Returns the 'Rule1' retention rule in XML format. :)
|
|
|