Loading TOC...
JavaScript admin.databaseSetName

MarkLogic 10 Product Documentation
admin:database-set-name

admin:database-set-name(
   $config as element(configuration),
   $database-id as xs:unsignedLong,
   $value as xs:string
) as element(configuration)

Summary

This function changes the name of the database with the specified ID to the specified name.

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
database-id The ID of the database (for example, xdmp:database("myDatabase") ).
value The new name for the database.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/database

http://marklogic.com/xdmp/privileges/admin/database/{id}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
		  at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $dbid := xdmp:database("myDatabase")
  return
  admin:database-set-name($config, $dbid, "myNewDatabaseName")

  (: returns the new configuration element -- use admin:save-configuration
     to save the changes to the configuration or pass the configuration
     to other Admin API functions to make other changes.  :)

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.