xdmp.directoryCreate

xdmp.directorycreatexdmpdirectorycreate

/apidoc/8.0/xdmp:directory-create.xml

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

The URI of the directory to be inserted.

uri

String

Security permission objects corresponding to the permissions for the document.

permissions

Object[]

The collections to which the new directory belongs.

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 directory is created. If the directory 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 directory is created in one of the specifed forests.

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();
xdmp.directoryCreate("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.

declareUpdate();
xdmp.directoryCreate("/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/").