如何在 MarkLogic 中重命名文档？

Question

I have simple task to do but unable to find the exact solutions for this.I have saved a file as abc.xml in MarkLogic.How can i rename the file as some example.xml using XQuery?

Code which I tried:

xquery version "1.0-ml";
xdmp:document-rename ("/aaa.xml","/final.xml");

This is showing an error.

Answer 1

There is no way, that I know of, to change the document URI of an existing document. The only way I can think of is to create a new document with the same content and the new URI, and delete the existing one, in the same transaction.

Where it gets tricky is to make sure to preserve the ownership, the permissions, all the properties, the property document, make sure that the old URI is not used anywhere to link to the existing document, etc.

But usually, the document URI is never really used. You should first considering whether you really need to rename the document, and why.

(Note that saying "this is showing an error" is rarely useful on SO or on mailing lists, if you do not show what the error is.)

Answer 2

Florent is correct, a true 'rename' is not possible, or perhaps not even meaningful. ( analogy - rename a file from one disk to another )

"Move" however is meaningful (copy then delete in a transaction). Defining "Move" is use case dependent - ie what metatdata also needs to 'move' ? permissions? collections ? document properties ? inherited permissions ?

xmlsh ( http://www.xmlsh.org ) implements a 'rename' ( http://www.xmlsh.org/MarkLogicRename ) command for the marklogic extension which is really a 'move', with the implemenation borrowed from postings on markmail ( http://markmail.org/ )

The implementation is the following XQuery - it doesnt do everything you might want and it might do more then you want. YMMV

https://github.com/DALDEI/xmlsh/blob/master/extensions/marklogic/src/org/xmlsh/marklogic/resources/rename.xquery

( it was also written long ago - it is likely to benefit from improvement )

Answer 3

I have working example this works for me.

xquery version "1.0-ml";

 declare function local:document-rename( $old-uri as xs:string, $new-uri as xs:string) as empty-sequence() { xdmp:document-delete($old-uri), let $permissions := xdmp:document-get-permissions($old-uri) let $collections := xdmp:document-get-collections($old-uri) return xdmp:document-insert( $new-uri, doc($old-uri), if ($permissions) then $permissions else xdmp:default-permissions(), if ($collections) then $collections else xdmp:default-collections(), xdmp:document-get-quality($old-uri) ) , let $prop-ns := namespace-uri(<prop:properties/>) let $properties := xdmp:document-properties($old-uri)/node() [ namespace-uri(.) ne $prop-ns ] return xdmp:document-set-properties($new-uri, $properties) }; 

(: function call :) local:document-rename ("/opt/backup/x.xml","y.xml");

Answer 4

MarkLogic has a tutorial up addressing file renaming (moving):

https://developer.marklogic.com/recipe/move-a-document/

Importantly, it uses the function xdmp:lock-for-update() to prevent modifications to the source file while it is being copied to the target location.

Also, if you are doing a batch renaming you'll want to make sure that each file URI you rename corresponds to a document in the database or you'll get runtime errors.