JavaScript admin.databaseGetPreloadReplicaMappedData

admin:database-get-preload-replica-mapped-data

admin:database-get-preload-replica-mapped-data(
   $config as element(configuration),
   $database-id as xs:unsignedLong
) as xs:boolean

Summary

This function returns the preload replica mapped data setting for the specified database from the configuration.

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")`).

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()
  return
  admin:database-get-preload-replica-mapped-data($config,
       xdmp:database("myDatabase"))

  (: returns the preload mapped data setting :)