| XQUERY/XSLT API DOCUMENTATION 4.2 |
All XQuery & XSLT Functions MarkLogic Built-In Functions Admin (xdmp:) AppServer (xdmp:) Classifier (cts:) Debug (dbg:) Document Conversion (xdmp:) Extension (xdmp:) Documents, Directories, Properties, and Locks Functions Extension Functions Function Values Functions HTTP Functions JSON Functions MarkLogic Server Functions Search Functions XML Functions XQuery Context Functions XSLT Functions map (map:) Math (math:) Profile (prof:) Search (cts:) cts:query Constructors Functions Geospatial Functions Geospatial Lexicon Functions Lexicon Functions Search Functions Search Clustering Functions Security (xdmp:) Server Monitoring (xdmp:) Spell (spell:) Update (xdmp:) XQuery Library Modules Admin Library (admin:) Actions Functions Appserver Functions Database Functions Forest Functions Group Functions Host Functions Mimetypes Functions Scheduler Functions Alerting (alert:) Elastic Compute Cloud (ec2:) Entity Enrichment (entity:) Flexible Replication (flexrep:) Geospatial Supporting Functions GEO Functions GeoRSS Functions GML Functions KML Functions MCGM Functions Information Studio (info:) Information Studio Developer (infodev:) Library Services (dls:) cts:query Constructor Functions Document Management Functions Document Update Functions Retention Policy Functions XInclude Functions Modular Documents XInclude Functions XPointer Functions PKI (pki:) Plugin (plugin:) Search (search:) Security-sec (sec:) Spelling Dictionary Management (spell:) Thesaurus (thsr:) Triggers (trgr:) Triggers Library (trgr:) WordProcessingML (ooxml:) ZIP Package (ooxml:) CPF Functions Content Processing Framework (cpf:) CSS Conversion (css:) DocBook Conversion (dbk:) Domains (dom:) Excel Conversion (excel:) Generic Conversion (cvt:) Links (lnk:) MSWord Conversion (msword:) PDF Conversion (pdf:) Pipelines (p:) Powerpoint Conversion (ppt:) XHTML Conversion (xhtml:) W3C-Standard Functions Accessor (fn:) AnyURI (fn:) Boolean (fn:) Context (fn:) DurationDateTime (fn:) Error and Trace (fn:) Node (fn:) Numeric (fn:) QName (fn:) Sequence (fn:) String (fn:) XSLT (fn:) W3C XQuery/XSLT Reference W3C XQuery Functions W3C XQuery Language W3C XSLT Language
This page was generated September 12, 2012 5:59 AM | XQuery & XSLT Built-In & Modules Function Reference
Module: Admin Library
The Admin module is an XQuery library module that allows you to script administrative tasks that you otherwise would need the Admin Interface to perform. Most functions in this library perform adminstrative tasks and therefore require the user who runs the XQuery program to have the Admin role. Many of these functions provide new configuration information. In most cases, you must save the configuration (with `admin:save-configuration`, for example) in the same statement that you use the functions in order for them to take effect. To use the Admin module as part of your own XQuery module, include the following line in your XQuery prolog: `import module namespace admin = "http://marklogic.com/xdmp/admin" at "/MarkLogic/admin.xqy" ;` The library namespace prefix `admin` is not predefined in the server.
Function Summary
admin:appserver-add-namespace | Add one or more namespaces to an App Server configuration, which will predefine the namespace(s) for all requests evaluated against the App Server.
admin:appserver-add-request-blackout | This function adds a request blackout specification for a appserver to a configuration.
admin:appserver-add-schema | This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified App Server.
admin:appserver-copy | This function creates a new App Server specification with the same settings as the App Server with the specified ID.
admin:appserver-delete | This function deletes one or more App Servers in the configuration.
admin:appserver-delete-namespace | This function deletes a namespace configuration from the configuration for the specified App Server.
admin:appserver-delete-request-blackout | This function deletes a request blackout specification for a appserver from a configuration.
admin:appserver-delete-schema | This function deletes a schema definition in the configuration for the specified App Server.
admin:appserver-exists | This function determines whether or not the specified App Server exists.
admin:appserver-get-address | This function returns the IP address of the App Server configuration.
admin:appserver-get-authentication | This function returns the authentication scheme (basic, digest, digestbasic, or application-level) configured for the specified App Server.
admin:appserver-get-backlog | This function returns the socket listen backlog setting for the specified App Server.
admin:appserver-get-collation | This function returns the collation URI set in the configuration for the specified App Server.
admin:appserver-get-compute-content-length | This function returns the value of whether the WebDAV server computes content length.
admin:appserver-get-concurrent-request-limit | This function returns the concurrent request limit for any user for the specified App Server.
admin:appserver-get-database | This function returns the ID of the database to which the App Server is set to execute queries against for the specified database.
admin:appserver-get-debug-allow | This function returns the value of debug allow setting configured for this App Server, where true indicates that the App Server will allow queries to be debugged, and false indicates that it will not.
admin:appserver-get-default-time-limit | This function returns the default time limit value configured for the specified App Server.
admin:appserver-get-default-user | This function returns the default user value configured for the specified App Server.
admin:appserver-get-default-xquery-version | This function returns the value of the default xquery version configured for the specified App Server.
admin:appserver-get-display-last-login | This function returns the value of the whether or not the appserver should display users' last login information.
admin:appserver-get-enabled | This function returns the enabled state for the specified App Server.
admin:appserver-get-error-handler | This function returns the path to the error handler configured for this App Server.
admin:appserver-get-group-id | This function returns the ID of the specified App Server's group.
admin:appserver-get-host-ids | This function returns the ID(s) of the hosts the specified App Server's is currently running on.
admin:appserver-get-id | This function returns the ID of the specified App Server.
admin:appserver-get-keep-alive-timeout | This function returns the keep alive timeout value configured for the specified App Server.
admin:appserver-get-last-login | This function returns the ID of the database to which the App Server stores users' last login information.
admin:appserver-get-log-errors | This function returns the value of the log errors setting configured for this App Server, where true indicates that the App Server will send uncaught exceptions to the ErrorLog.txt file, and false indicates that it will not.
admin:appserver-get-max-time-limit | This function returns the max time limit value configured for the specified App Server.
admin:appserver-get-modules-database | This function returns the ID of the database set as the modules database for the specified database.
admin:appserver-get-name | This function returns the name of the appserver with the specified ID.
admin:appserver-get-namespaces | This function returns the value of any namespace definitions predefined for the specified App Server.
admin:appserver-get-output-encoding | This function returns the value for the output encoding setting for the specified App Server.
admin:appserver-get-output-sgml-character-entities | This function returns the value for the output sgml character entities setting for the specified App Server.
admin:appserver-get-port | This function returns the port for the specified App Server.
admin:appserver-get-pre-commit-trigger-depth | This function returns the pre commit trigger depth value configured for the specified App Server.
admin:appserver-get-pre-commit-trigger-limit | This function returns the pre commit trigger limit value configured for the specified App Server.
admin:appserver-get-privilege | This function returns the privilege ID for the specified App Server.
admin:appserver-get-profile-allow | This function returns the value of the profile allow setting configured for this App Server, where true indicates that the App Server will allow queries to be profiled, and false indicates that it will not.
admin:appserver-get-request-blackouts | This function returns the request blackouts specification for the specified appserver from the configuration.
admin:appserver-get-request-timeout | This function returns the request timeout value configured for the specified App Server.
admin:appserver-get-root | This function returns the root for the specified App Server.
admin:appserver-get-schemas | This function returns the value of any schemas definitions predefined for the specified App Server.
admin:appserver-get-session-timeout | This function returns the session timeout value configured for the specified App Server.
admin:appserver-get-ssl-allow-sslv3 | This function returns true if the SSL v3 protocol is enabled for the specified App Server, or false if SSL v3 is disabled.
admin:appserver-get-ssl-allow-tls | This function returns true if the TLS protocol is enabled for the specified App Server, or false if TLS is disabled.
admin:appserver-get-ssl-certificate-template | This function returns the id of the SSL certificate template used by the specified App Server.
admin:appserver-get-ssl-ciphers | This function returns the SSL ciphers set for the App Server.
admin:appserver-get-ssl-client-certificate-authorities | This function returns the id(s) of the client certificate authority for the specified App Server.
admin:appserver-get-ssl-hostname | This function returns the SSL hostname for the specified App Server.
admin:appserver-get-ssl-require-client-certificate | This function returns true if a client certificate is required for the specified App Server.
admin:appserver-get-static-expires | This function returns the value of the "expires" HTTP header for static content to expire after this many seconds port for the specified App Server.
admin:appserver-get-threads | This function returns the maximum number of threads configured for the specified App Server.
admin:appserver-get-type | This function returns the type of appserver with the specified ID.
admin:appserver-get-url-rewriter | This function returns the path to the URL rewriter configured for this App Server.
admin:appserver-one-time-request-blackout | This function constructs a one-time request-blackout specification.
admin:appserver-recurring-request-blackout | This function constructs a request-blackout specification.
admin:appserver-set-address | This function changes the IP Address in the configuration for the specified App Server to the specified address.
admin:appserver-set-authentication | This function sets the authentication scheme in the configuration for the specified App Server.
admin:appserver-set-backlog | This function sets the value in the configuration of the backlog (the maximum number of pending connections allowed on the HTTP socket) for the specified App Server.
admin:appserver-set-collation | This function sets the default collation in the configuration for the specified App Server.
admin:appserver-set-compute-content-length | This function changes the value whether a WebDAV server computes content length.
admin:appserver-set-concurrent-request-limit | This function sets the limit on concurrent requests that any user may have on a particular appserver.
admin:appserver-set-database | This function sets the value in the configuration of the database for the specified App Server.
admin:appserver-set-debug-allow | This function sets the debug allow setting in the configuration for the specified App Server.
admin:appserver-set-default-time-limit | This function sets the default time limit (the maximum total amount of time to service a request before the App Server throws a timeout exception) in the configuration for the specified App Server.
admin:appserver-set-default-user | This function sets the default user (for use with application-level authentication) in the configuration for the specified App Server.
admin:appserver-set-default-xquery-version | This function sets the default XQuery version setting in the configuration for this App Server.
admin:appserver-set-display-last-login | This function sets the display last login setting in the configuration for the specified App Server.
admin:appserver-set-enabled | This function sets the enabled state in the configuration for the specified App Server.
admin:appserver-set-error-handler | This function sets the value of the path to the error handler in the configuration for the specified App Server.
admin:appserver-set-keep-alive-timeout | This function sets the keep-alive timeout (the maximum number of second for subsequent socket requests to time out) in the configuration for the specified App Server.
admin:appserver-set-last-login | This function sets the value in the configuration of the last login database for the specified App Server.
admin:appserver-set-log-errors | This function sets the log errors setting in the configuration for the specified App Server.
admin:appserver-set-max-time-limit | This function sets the max time limit (the maximum total amount of time to service a request before the App Server throws a timeout exception) in the configuration for the specified App Server.
admin:appserver-set-modules-database | This function sets the value in the configuration of modules database for the specified App Server to the specified database ID.
admin:appserver-set-name | This function changes the name of an existing App Server to the newly specified value.
admin:appserver-set-output-encoding | This function sets the value for the default output encoding in the configuration for the specified App Server.
admin:appserver-set-output-sgml-character-entities | This function sets the SGML character entity output setting in the configuration for the specified App Server.
admin:appserver-set-port | This function changes the port in the configuration for the specified App Server to the specified number.
admin:appserver-set-pre-commit-trigger-depth | This function sets the maximum depth (how many triggers can cause other triggers to fire, which in turn cause others to fire, and so on) in the configuration for the specifed App Server.
admin:appserver-set-pre-commit-trigger-limit | This function sets the value in the configuration for the maximum number of pre-commit triggers a single statement can invoke for the specified App Server.
admin:appserver-set-privilege | This function sets an execute privilege in the configuration for the specified App Server.
admin:appserver-set-profile-allow | This function sets the profile allow setting in the configuration for the specified App Server.
admin:appserver-set-request-timeout | This function sets the value of the socket request timeout (the number of seconds before the socket times out) in the configuration for the specified App Server.
admin:appserver-set-root | This function changes the root for a specified App Server to the newly specified value.
admin:appserver-set-session-timeout | This function sets the session timeout value (in seconds) in the configuration for the specified App Server.
admin:appserver-set-ssl-allow-sslv3 | This function enables or disables the SSL v3 protocol for the specified App Server.
admin:appserver-set-ssl-allow-tls | This function enables or disables the TLS protocol for the specified App Server.
admin:appserver-set-ssl-certificate-template | This function sets an SSL certificate template for the specified App Server.
admin:appserver-set-ssl-ciphers | This function sets SSL ciphers for the specified App Server.
admin:appserver-set-ssl-client-certificate-authorities | This function sets one or more client certificate authorities that sign client certificates for the specified App Server.
admin:appserver-set-ssl-hostname | This function sets an SSL hostname for the specified App Server.
admin:appserver-set-ssl-require-client-certificate | This function determines whether or not a client certificate is required for the specified App Server.
admin:appserver-set-static-expires | This function changes the value of the "expires" HTTP header for a specified App Server to the newly specified value.
admin:appserver-set-threads | This function sets the value in the configuration of the maximum number of threads for the specified App Server.
admin:appserver-set-url-rewriter | This function sets the value of the path to the URL rewriter in the configuration for the specified App Server.
admin:database-add-backup | This function adds scheduled backup specifications for a database to a configuration.
admin:database-add-element-attribute-word-lexicon | This function adds an element attribute word lexicon to the specified database in the configuration.
admin:database-add-element-word-lexicon | This function adds an element word lexicon to the specified database in the configuration.
admin:database-add-element-word-query-through | This function adds an element word query through to the specified database in the configuration.
admin:database-add-field | This function adds the field specification to the specified database in the configuration.
admin:database-add-field-excluded-element | This function adds the field excluded element specification in the specified database in the configuration.
admin:database-add-field-included-element | This function adds the field included element specification tn the specified database in the configuration.
admin:database-add-field-word-lexicon | This function adds a word lexicon to the specified database in the configuration.
admin:database-add-fragment-parent | This function adds the specified fragment parent to the specified database in the configuration.
admin:database-add-fragment-root | This function adds the specified fragment root to the specified database in the configuration.
admin:database-add-geospatial-element-attribute-pair-index | This function adds a geospatial element attribute pair index to the specified database in the configuration.
admin:database-add-geospatial-element-child-index | This function adds a geospatial element child index to the specified database in the configuration.
admin:database-add-geospatial-element-index | This function adds a range element index to the specified database in the configuration.
admin:database-add-geospatial-element-pair-index | This function adds a geospatial element pair index to the specified database in the configuration.
admin:database-add-merge-blackout | This function adds a merge blackout specification for a database to a configuration.
admin:database-add-phrase-around | This function adds a phrase around to the specified database in the configuration.
admin:database-add-phrase-through | This function adds a phrase through to the specified database in the configuration.
admin:database-add-range-element-attribute-index | This function adds a range element attribute index to the specified database in the configuration.
admin:database-add-range-element-index | This function adds a range element index to the specified database in the configuration.
admin:database-add-word-lexicon | This function adds a word lexicon to the specified database in the configuration.
admin:database-add-word-query-excluded-element | This function adds the word query excluded element specification for the specified database to the configuration.
admin:database-add-word-query-included-element | This function adds the word query included element specification to the specified database in the configuration.
admin:database-attach-forest | This function attaches the specified forest to the specified database.
admin:database-copy | This function creates a new database specification with the same settings as the database with the specified ID.
admin:database-create | This function creates a new database specification.
admin:database-daily-backup | This function constructs a daily scheduled database backup.
admin:database-delete | This function deletes the configuration from the specified database(s).
admin:database-delete-backup | This function deletes scheduled backup specifications for a database from a configuration.
admin:database-delete-element-attribute-word-lexicon | This function deletes an element attribute word lexicon for the specified database from the configuration.
admin:database-delete-element-word-lexicon | This function deletes an element word lexicon for the specified database from the configuration.
admin:database-delete-element-word-query-through | This function deletes an element word query through for the specified database from the configuration.
admin:database-delete-field | This function deletes the field specification in the specified database from the configuration.
admin:database-delete-field-excluded-element | This function deletes the field excluded element specification in the specified database from the configuration.
admin:database-delete-field-included-element | This function deletes the field included element specification in the specified database from the configuration.
admin:database-delete-field-word-lexicon | This function deletes a word lexicon for the specified database from the configuration.
admin:database-delete-fragment-parent | This function deletes the specified fragment parent in the specified database from the configuration.
admin:database-delete-fragment-root | This function deletes the specified fragment root in the specified database from the configuration.
admin:database-delete-geospatial-element-attribute-pair-index | This function deletes a geospatial element attribute pair index in the specified database from the configuration.
admin:database-delete-geospatial-element-child-index | This function deletes a geospatial element child index for the specified database in the configuration.
admin:database-delete-geospatial-element-index | This function deletes a geospatial element index for the specified database in the configuration.
admin:database-delete-geospatial-element-pair-index | This function deletes a geospatial element pair index for the specified database from the configuration.
admin:database-delete-merge-blackout | This function deletes a merge blackout specification for a database from a configuration.
admin:database-delete-phrase-around | This function deletes a phrase around for the specified database from the configuration.
admin:database-delete-phrase-through | This function deletes a phrase through for the specified database from the configuration.
admin:database-delete-range-element-attribute-index | This function deletes a range element attribute index for the specified database in the configuration.
admin:database-delete-range-element-index | This function deletes a range element index for the specified database in the configuration.
admin:database-delete-word-lexicon | This function deletes a word lexicon for the specified database from the configuration.
admin:database-delete-word-query-excluded-element | This function deletes the word query excluded element specification in the specified database from the configuration.
admin:database-delete-word-query-included-element | This function deletes the word query included element specification in the specified database from the configuration.
admin:database-detach-forest | This function detaches the specified forest from the specified database.
admin:database-element-attribute-word-lexicon | This function constructs an element attribute word lexicon specification.
admin:database-element-word-lexicon | This function constructs an element word lexicon specification.
admin:database-element-word-query-through | This function constructs an element word query through specification.
admin:database-excluded-element | This function constructs an excluded element specification.
admin:database-exists | This function determines whether or not the specified database exists.
admin:database-field | This function constructs a field specification.
admin:database-fragment-parent | This function constructs a fragment parent specification.
admin:database-fragment-root | This function constructs a fragment root specification.
admin:database-geospatial-element-attribute-pair-index | This function constructs a geospatial element attribute pair index specification.
admin:database-geospatial-element-child-index | This function constructs a geospatial element child index specification.
admin:database-geospatial-element-index | This function constructs a geospatial element index specification.
admin:database-geospatial-element-pair-index | This function constructs a geospatial element pair index specification.
admin:database-get-attached-forests | This function returns the attached forest IDs for the specified database from the configuration.
admin:database-get-attribute-value-positions | This function returns the attribute value positions setting for the specified database from the configuration.
admin:database-get-backups | This function returns the scheduled backups for the specified database from the configuration.
admin:database-get-collection-lexicon | This function returns the collection lexicon setting for the specified database from the configuration.
admin:database-get-directory-creation | This function returns the directory creation setting for the specified database from the configuration.
admin:database-get-element-attribute-word-lexicons | This function returns the element attribute word lexicons specification(s) for the specified database from the configuration.
admin:database-get-element-value-positions | This function returns the element value positions setting for the specified database from the configuration.
admin:database-get-element-word-lexicons | This function returns the element word lexicons specification(s) for the specified database from the configuration.
admin:database-get-element-word-positions | This function returns the element word positions setting for the specified database from the configuration.
admin:database-get-element-word-query-throughs | This function returns the element word query throughs specification(s) for the specified database from the configuration.
admin:database-get-enabled | This function returns the enabled value for the specified database from the configuration.
admin:database-get-expunge-locks | This function returns the expunge locks setting for the specified database from the configuration.
admin:database-get-fast-case-sensitive-searches | This function returns the fast case sensitive searches setting for the specified database from the configuration.
admin:database-get-fast-diacritic-sensitive-searches | This function returns the fast diacritic sensitive searches setting for the specified database from the configuration.
admin:database-get-fast-element-character-searches | This function returns the fast element character searches setting for the specified database from the configuration.
admin:database-get-fast-element-phrase-searches | This function returns the fast element phrase searches setting for the specified database from the configuration.
admin:database-get-fast-element-trailing-wildcard-searches | This function returns the trailing wildcard searches setting for the specified database from the configuration.
admin:database-get-fast-element-word-searches | This function returns the fast element word searches setting for the specified database from the configuration.
admin:database-get-fast-phrase-searches | This function returns the fast phrase searches setting for the specified database from the configuration.
admin:database-get-fast-reverse-searches | This function returns the fast reverse searches setting for the specified database from the configuration.
admin:database-get-field | This function returns the field specification for the specified database from the configuration.
admin:database-get-field-excluded-elements | This function returns the field excluded elements specification for the specified database from the configuration.
admin:database-get-field-fast-case-sensitive-searches | This function returns true if the fast case sensitive searches setting for the specified field is enabled.
admin:database-get-field-fast-diacritic-sensitive-searches | This function returns true if the fast diacritic sensitive searches setting for the specified field is enabled.
admin:database-get-field-fast-phrase-searches | This function returns true if the fast phrase searches setting for the specified field is enabled.
admin:database-get-field-include-document-root | This function returns the field include document root setting for the specified field from the configuration.
admin:database-get-field-included-elements | This function returns the fields included elements specification for the specified database from the configuration.
admin:database-get-field-one-character-searches | This function returns true if the one character searches setting for the specified field is enabled.
admin:database-get-field-stemmed-searches | This function returns stemmed searches setting for the specified field if configured.
admin:database-get-field-three-character-searches | This function returns true if the three character searches setting for the specified field is enabled.
admin:database-get-field-three-character-word-positions | This function returns true if the three character word positions setting for the specified field is enabled.
admin:database-get-field-trailing-wildcard-searches | This function returns true if the trailing wildcard searches setting for the specified field is enabled.
admin:database-get-field-trailing-wildcard-word-positions | This function returns true if the trailing wildcard word positions setting for the specified field is enabled.
admin:database-get-field-two-character-searches | This function returns true if the two character searches setting for the specified field is enabled.
admin:database-get-field-word-lexicons | This function returns the word lexicons specification(s) for the specified database from the configuration.
admin:database-get-field-word-searches | This function returns true if the word searches setting for the specified field is enabled.
admin:database-get-fields | This function returns the fields specification(s) for the specified database from the configuration.
admin:database-get-format-compatibility | This function returns the format compatibility setting for the specified database from the configuration.
admin:database-get-fragment-parents | This function returns the fragment parents specification for the specified database from the configuration.
admin:database-get-fragment-roots | This function returns the fragment roots specification for the specified database from the configuration.
admin:database-get-geospatial-element-attribute-pair-indexes | This function returns the geospatial element attribute pair indexes specification(s) for the specified database from the configuration.
admin:database-get-geospatial-element-child-indexes | This function returns the geospatial element child indexes specification(s) for the specified database from the configuration.
admin:database-get-geospatial-element-indexes | This function returns the geospatial element indexes specification(s) for the specified database from the configuration.
admin:database-get-geospatial-element-pair-indexes | This function returns the geospatial element pair indexes specification(s) for the specified database from the configuration.
admin:database-get-id | This function returns the ID for the specified database from the configuration.
admin:database-get-in-memory-limit | This function returns the in memory limit setting for the specified database from the configuration.
admin:database-get-in-memory-list-size | This function returns the in memory list size setting for the specified database from the configuration.
admin:database-get-in-memory-range-index-size | This function returns the in memory range index size setting for the specified database from the configuration.
admin:database-get-in-memory-reverse-index-size | This function returns the in memory reverse index size setting for the specified database from the configuration.
admin:database-get-in-memory-tree-size | This function returns the in memory tree size setting for the specified database from the configuration.
admin:database-get-index-detection | This function returns the index detection setting for the specified database from the configuration.
admin:database-get-inherit-collections | This function returns the inherit collections setting for the specified database from the configuration.
admin:database-get-inherit-permissions | This function returns the inherit positions setting for the specified database from the configuration.
admin:database-get-inherit-quality | This function returns the inherit quality setting for the specified database from the configuration.
admin:database-get-journal-size | This function returns the journal size setting for the specified database from the configuration.
admin:database-get-journaling | This function returns the journaling setting for the specified database in the configuration.
admin:database-get-language | This function returns the language for the specified database from the configuration.
admin:database-get-locking | This function returns the locking setting for the specified database in the configuration.
admin:database-get-maintain-directory-last-modified | This function returns the maintain directory last modified setting for the specified database from the configuration.
admin:database-get-maintain-last-modified | This function returns the maintain last modified setting for the specified database from the configuration.
admin:database-get-merge-blackouts | This function returns the merge blackouts specification for the specified database from the configuration.
admin:database-get-merge-enable | This function returns the merge enable setting for the specified database from the configuration.
admin:database-get-merge-max-size | This function returns the merge max size setting for the specified database from the configuration.
admin:database-get-merge-min-ratio | This function returns the merge min ratio setting for the specified database from the configuration.
admin:database-get-merge-min-size | This function returns the merge min size setting for the specified database from the configuration.
admin:database-get-merge-priority | This function returns the CPU scheduler priority for merges for the specified database from the configuration.
admin:database-get-merge-timestamp | This function returns the merge timestamp setting for the specified database from the configuration.
admin:database-get-name | This function returns the name for the specified database from the configuration.
admin:database-get-one-character-searches | This function returns the one character searches setting for the specified database from the configuration.
admin:database-get-phrase-arounds | This function returns the phrase arounds specification(s) for the specified database from the configuration.
admin:database-get-phrase-throughs | This function returns the phrase throughs specification(s) for the specified database from the configuration.
admin:database-get-positions-list-max-size | This function returns the positions list max size setting for the specified database from the configuration.
admin:database-get-preallocate-journals | This function returns the preallocate journals setting for the specified database from the configuration.
admin:database-get-preload-mapped-data | This function returns the preload mapped data setting for the specified database from the configuration.
admin:database-get-range-element-attribute-indexes | This function returns the range element attribute indexes specification(s) for the specified database from the configuration.
admin:database-get-range-element-indexes | This function returns the range element indexes specification(s) for the specified database from the configuration.
admin:database-get-range-index-optimize | This function returns the range index optimize setting for the specified database from the configuration.
admin:database-get-reindexer-enable | This function returns the reindexer enable setting for the specified database from the configuration.
admin:database-get-reindexer-throttle | This function returns the reindexer throttle setting for the specified database from the configuration.
admin:database-get-reindexer-timestamp | This function returns the reindexer timestamp setting for the specified database from the configuration.
admin:database-get-schema-database | This function returns the ID of the schema database for the specified database from the configuration.
admin:database-get-security-database | This function returns the ID of the security database for the specified database from the configuration.
admin:database-get-stemmed-searches | This function returns the stemmed searches setting for the specified database from the configuration.
admin:database-get-tf-normalization | This function returns the current term-frequency normalization setting for the database.
admin:database-get-three-character-searches | This function returns the three character searches setting for the specified database from the configuration.
admin:database-get-three-character-word-positions | This function returns the three character word positions setting for the specified database from the configuration.
admin:database-get-trailing-wildcard-searches | This function returns the trailing wildcard searches setting for the specified database from the configuration.
admin:database-get-trailing-wildcard-word-positions | This function returns the trailing wildcard word positions setting for the specified database from the configuration.
admin:database-get-triggers-database | This function returns the ID of the triggers database for the specified database from the configuration.
admin:database-get-two-character-searches | This function returns the two character searches setting for the specified database from the configuration.
admin:database-get-uri-lexicon | This function returns the URI lexicon setting for the specified database from the configuration.
admin:database-get-word-lexicons | This function returns the word lexicons specification(s) for the specified database from the configuration.
admin:database-get-word-positions | This function returns the word positions setting for the specified database from the configuration.
admin:database-get-word-query-excluded-elements | This function returns the word query excluded elements setting for the specified database from the configuration.
admin:database-get-word-query-fast-case-sensitive-searches | This function returns true if the word query fast case sensitive searches setting is enabled for the specified database in the configuration.
admin:database-get-word-query-fast-diacritic-sensitive-searches | This function returns true if the word query fast diacritic sensitive searches setting is enabled for the specified database in the configuration.
admin:database-get-word-query-fast-phrase-searches | This function returns true if the word query fast phrase searches setting for the specified database is set in the configuration.
admin:database-get-word-query-include-document-root | This function returns the word query include document root setting for the specified database from the configuration.
admin:database-get-word-query-included-elements | This function returns the word query included elements setting for the specified database from the configuration.
admin:database-get-word-query-one-character-searches | This function returns true if the word query one character searches setting is enabled for the specified database in the configuration.
admin:database-get-word-query-stemmed-searches | This function returns the reindexer word query stemmed searches setting for the specified database from the configuration.
admin:database-get-word-query-three-character-searches | This function returns true if the word query three character searches setting is enabled for the specified database in the configuration.
admin:database-get-word-query-three-character-word-positions | This function returns true if the word query three character word positions setting is enabled for the specified database from the configuration.
admin:database-get-word-query-trailing-wildcard-searches | This function returns true if the word query trailing wildcard searches setting is enabled for the specified database in the configuration.
admin:database-get-word-query-trailing-wildcard-word-positions | This function returns true if the word query trailing wildcard word positions setting is enabled for the specified database in the configuration.
admin:database-get-word-query-two-character-searches | This function returns true if the word query two character searches setting is enabled for the specified database in the configuration.
admin:database-get-word-query-word-searches | This function returns true if the word query searches setting for the specified database is enabled in the configuration.
admin:database-get-word-searches | This function returns the word searches setting for the specified database from the configuration.
admin:database-hourly-backup | This function constructs a hourly scheduled database backup.
admin:database-included-element | This function constructs an included element specification.
admin:database-minutely-backup | This function constructs a scheduled database backup on a number-of-minutes basis.
admin:database-monthly-backup | This function constructs a monthly scheduled backup.
admin:database-one-time-backup | This function constructs a one-time backup.
admin:database-one-time-merge-blackout | This function constructs a one-time merge-blackout specification.
admin:database-phrase-around | This function constructs a phrase through specification.
admin:database-phrase-through | This function constructs a phrase through specification.
admin:database-range-element-attribute-index | This function constructs a range element attribute index specification.
admin:database-range-element-index | This function constructs a range element index specification.
admin:database-recurring-merge-blackout | This function constructs a merge-blackout specification.
admin:database-set-attribute-value-positions | This function sets the attribute value positions setting for the specified database in the configuration.
admin:database-set-collection-lexicon | This function sets the collection lexicon setting for the specified database in the configuration.
admin:database-set-directory-creation | This function sets the directory creation setting for the specified database in the configuration.
admin:database-set-element-value-positions | This function sets the element value positions setting for the specified database in the configuration.
admin:database-set-element-word-positions | This function sets the element word positions setting for the specified database in the configuration.
admin:database-set-enabled | This function sets the enabled value for the specified database in the configuration.
admin:database-set-expunge-locks | This function sets the expunge locks setting for the specified database in the configuration.
admin:database-set-fast-case-sensitive-searches | This function sets the fast case sensitive searches setting for the specified database in the configuration.
admin:database-set-fast-diacritic-sensitive-searches | This function sets the fast diacritic-sensitive searches setting for the specified database in the configuration.
admin:database-set-fast-element-character-searches | This function sets the fast element character searches setting for the specified database in the configuration.
admin:database-set-fast-element-phrase-searches | This function sets the fast element phrase searches setting for the specified database in the configuration.
admin:database-set-fast-element-trailing-wildcard-searches | This function sets the fast element trailing wildcard searches setting for the specified database in the configuration.
admin:database-set-fast-element-word-searches | This function sets the element word searches setting for the specified database in the configuration.
admin:database-set-fast-phrase-searches | This function sets the fast phrase searches setting for the specified database in the configuration.
admin:database-set-fast-reverse-searches | This function sets the fast reverse searches setting for the specified database in the configuration.
admin:database-set-field-fast-case-sensitive-searches | This function sets the field fast case sensitive searches setting for the specified field in the configuration.
admin:database-set-field-fast-diacritic-sensitive-searches | This function sets the field fast diacritic sensitive searches setting for the specified field in the configuration.
admin:database-set-field-fast-phrase-searches | This function sets the field fast phrase searches setting for the specified field in the configuration.
admin:database-set-field-include-document-root | This function sets the field include document root setting for the specified field in the configuration.
admin:database-set-field-name | This function sets the field name setting for the specified field in the configuration.
admin:database-set-field-one-character-searches | This function sets the field one character searches setting for the specified field in the configuration.
admin:database-set-field-stemmed-searches | This function sets the field stemmed searches setting for the specified field in the configuration.
admin:database-set-field-three-character-searches | This function sets the field three character searches setting for the specified field in the configuration.
admin:database-set-field-three-character-word-positions | This function sets the field three character word positions setting for the specified field in the configuration.
admin:database-set-field-trailing-wildcard-searches | This function sets the field trailing wildcard searches setting for the specified database in the configuration.
admin:database-set-field-trailing-wildcard-word-positions | This function sets the field trailing wildcard word positions setting for the specified field in the configuration.
admin:database-set-field-two-character-searches | This function sets the field two character searches setting for the specified field in the configuration.
admin:database-set-field-word-searches | This function sets the field word searches setting for the specified field in the configuration.
admin:database-set-format-compatibility | This function sets the format cpmpatibility setting for the specified database in the configuration.
admin:database-set-in-memory-limit | This function sets the in-memory limit setting for the specified database in the configuration.
admin:database-set-in-memory-list-size | This function sets the in-memory list size setting for the specified database in the configuration.
admin:database-set-in-memory-range-index-size | This function sets the in-memory range index size setting for the specified database in the configuration.
admin:database-set-in-memory-reverse-index-size | This function sets the in-memory range reverse index size setting for the specified database in the configuration.
admin:database-set-in-memory-tree-size | This function sets the in-memory tree size setting for the specified database in the configuration.
admin:database-set-index-detection | This function sets the index detection setting for the specified database in the configuration.
admin:database-set-inherit-collections | This function sets the inherit collections setting for the specified database in the configuration.
admin:database-set-inherit-permissions | This function sets the inherit permissions setting for the specified database in the configuration.
admin:database-set-inherit-quality | This function sets the inherit quality setting for the specified database in the configuration.
admin:database-set-journal-size | This function sets the journal size setting for the specified database in the configuration.
admin:database-set-journaling | This function sets the journaling setting for the specified database in the configuration.
admin:database-set-language | This function sets the language for the specified database in the configuration.
admin:database-set-locking | This function sets the locking setting for the specified database in the configuration.
admin:database-set-maintain-directory-last-modified | This function sets the maintain directory last modified setting for the specified database in the configuration.
admin:database-set-maintain-last-modified | This function sets the maintain last modified setting for the specified database in the configuration.
admin:database-set-merge-enable | This function sets the merge enable setting for the specified database in the configuration.
admin:database-set-merge-max-size | This function sets the merge max size setting for the specified database in the configuration.
admin:database-set-merge-min-ratio | This function sets the merge min ratio setting for the specified database in the configuration.
admin:database-set-merge-min-size | This function sets the merge minimum size setting for the specified database in the configuration.
admin:database-set-merge-priority | This function sets the CPU scheduler priority for merges.
admin:database-set-merge-timestamp | This function sets the merge timestamp setting for the specified database in the configuration.
admin:database-set-name | This function changes the name of the database with the specified ID to the specified name.
admin:database-set-one-character-searches | This function sets the one character searches setting for the specified database in the configuration.
admin:database-set-positions-list-max-size | This function sets the positions list max size setting for the specified database in the configuration.
admin:database-set-preallocate-journals | This function sets the preallocate journals setting for the specified database in the configuration.
admin:database-set-preload-mapped-data | This function sets the preload mapped data setting for the specified database in the configuration.
admin:database-set-range-index-optimize | This function sets the range index optimize setting for the specified database in the configuration.
admin:database-set-reindexer-enable | This function sets the reindexer enable setting for the specified database in the configuration.
admin:database-set-reindexer-throttle | This function sets the reindexer throttle setting for the specified database in the configuration.
admin:database-set-reindexer-timestamp | This function sets the reindexer timestamp setting for the specified database in the configuration.
admin:database-set-schema-database | This function sets the schema database for a database to the specified database in the configuration.
admin:database-set-security-database | This function sets the security database for a database to the specified database in the configuration.
admin:database-set-stemmed-searches | This function sets the stemmed searches setting for the specified database in the configuration.
admin:database-set-tf-normalization | This function specifies whether to use the default term-frequency normalization (scaled-log), which scales the term frequency based on the size of the document, or to use the unscaled-log, which uses term frequency as a function of the actual term frequency in a document, regardless of the document size.
admin:database-set-three-character-searches | This function sets the three character searches setting for the specified database in the configuration.
admin:database-set-three-character-word-positions | This function sets the three character word positions setting for the specified database in the configuration.
admin:database-set-trailing-wildcard-searches | This function sets the trailing wildcard searches setting for the specified database in the configuration.
admin:database-set-trailing-wildcard-word-positions | This function sets the trailing wildcard word positions setting for the specified database in the configuration.
admin:database-set-triggers-database | This function sets the triggers database to the specified database ID for the specified database in the configuration.
admin:database-set-two-character-searches | This function sets the two character searches setting for the specified database in the configuration.
admin:database-set-uri-lexicon | This function sets the URI lexicon setting for the specified database in the configuration.
admin:database-set-word-positions | This function sets the word positions setting for the specified database in the configuration.
admin:database-set-word-query-fast-case-sensitive-searches | This function returns the word query fast case sensitive searches setting for the specified database from the configuration.
admin:database-set-word-query-fast-diacritic-sensitive-searches | This function sets the word query fast diacritic sensitive searches setting for the specified database in the configuration.
admin:database-set-word-query-fast-phrase-searches | This function sets the word query fast phrase searches setting for the specified database in the configuration.
admin:database-set-word-query-include-document-root | This function sets the word query include document root setting for the specified field in the configuration.
admin:database-set-word-query-one-character-searches | This function sets the word query one character searches setting for the specified field in the configuration.
admin:database-set-word-query-stemmed-searches | This function sets the word query stemmed searches setting for the specified database in the configuration.
admin:database-set-word-query-three-character-searches | This function sets the word query three character searches setting for the specified database in the configuration.
admin:database-set-word-query-three-character-word-positions | This function sets the word query three character word positions setting for the specified database in the configuration.
admin:database-set-word-query-trailing-wildcard-searches | This function sets the word query trailing wildcard searches setting for the specified database in the configuration.
admin:database-set-word-query-trailing-wildcard-word-positions | This function sets the word query trailing wildcard word positions setting for the specified database in the configuration.
admin:database-set-word-query-two-character-searches | This function sets the word query two character searches setting for the specified database in the configuration.
admin:database-set-word-query-word-searches | This function sets the word query word searches setting for the specified database in the configuration.
admin:database-set-word-searches | This function sets the word searches setting for the specified database in the configuration.
admin:database-weekly-backup | This function constructs a weekly scheduled backup.
admin:database-word-lexicon | This function constructs a word lexicon specification.
admin:forest-add-backup | This function adds scheduled backup specifications for a forest to a configuration.
admin:forest-add-failover-host | This function adds a failover host to the list of failover hosts for the specified forest in the specified configuration.
admin:forest-add-replica | This function adds a forest replica to a master forest.
admin:forest-copy | This function creates a new forest specification with the same settings as the forest with the specified ID.
admin:forest-create | This function creates a new forest configuration.
admin:forest-daily-backup | This function constructs a daily scheduled forest backup.
admin:forest-delete | This function deletes the configuration for the specified forest from the configuration.
admin:forest-delete-backup | This function deletes scheduled backup specifications for a forest from a configuration.
admin:forest-delete-failover-host | This function deletes the specified failover host(s) from the failover-host list in the specified configuration.
admin:forest-exists | This function determines whether or not the specified forest exists.
admin:forest-get-backups | This function returns the scheduled backups for the specified forest from the configuration.
admin:forest-get-data-directory | This function returns the name of the data directory of the specified forest.
admin:forest-get-database | This function returns the ID of the database that uses the specified forest.
admin:forest-get-enabled | This function returns the enabled state of the specified forest.
admin:forest-get-failover-enable | This function returns the state of whether failover is enabled for the specified forest.
admin:forest-get-failover-hosts | This function returns the IDs of the hosts defined as failover hosts for this forest.
admin:forest-get-host | This function returns the ID of the host in which the specified forest resides.
admin:forest-get-id | This function returns the ID of the forest with the specified name, from the specified configuration.
admin:forest-get-name | This function returns the name of the specified forest, given the forest ID.
admin:forest-get-replicas | This function returns the IDs of the forest replicas for the specified forest.
admin:forest-get-updates-allowed | This function returns the state of what kinds of updates are allowed for the specified forest.
admin:forest-hourly-backup | This function constructs a hourly scheduled forest backup.
admin:forest-minutely-backup | This function constructs a scheduled forest backup on a number-of-minutes basis.
admin:forest-monthly-backup | This function constructs a monthly scheduled backup.
admin:forest-one-time-backup | This function constructs a one-time backup.
admin:forest-remove-replica | This function removes a forest replica from a master forest.
admin:forest-set-enabled | This function sets the enabled state for a forest configuration.
admin:forest-set-failover-enable | This function sets the forest failover enabled state for a forest configuration.
admin:forest-set-host | This function sets a forest configuration to a new host.
admin:forest-set-updates-allowed | This function sets the updates-allowed state for a forest configuration.
admin:forest-weekly-backup | This function constructs a weekly scheduled backup.
admin:get-appserver-ids | This function returns all the appserver IDs from the configuration.
admin:get-configuration | Loads the admin configuration into memory for use by other functions in the Admin module.
admin:get-database-ids | This function returns all the database IDs from the configuration.
admin:get-forest-ids | This function returns all the forest IDs from the configuration.
admin:get-group-ids | This function returns all the group IDs from the configuration.
admin:get-host-ids | This function returns all the host IDs from the configuration.
admin:group-add-namespace | Add one or more namespaces to a Group configuration, which will predefine the namespace(s) for all requests evaluated against any App Server in the Group.
admin:group-add-scheduled-task | This function adds one or more scheduled tasks to the specified group.
admin:group-add-schema | This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified Group.
admin:group-add-trace-event | This function adds trace events to the configuration.
admin:group-copy | This function creates a new group specification with the same settings as the group with the specified ID.
admin:group-create | This function creates a new group with the specified name in the configuration.
admin:group-daily-scheduled-task | This function constructs a task to be invoked at daily intervals.
admin:group-delete | This function deletes one or more groups in the configuration.
admin:group-delete-namespace | This function deletes the specified namespaces from the configuration for the specified group.
admin:group-delete-scheduled-task | This function deletes one or more scheduled tasks from the specified group.
admin:group-delete-schema | This function deletes a schema binding definition to the existing schema binding definitions in the configuration for the specified Group.
admin:group-delete-trace-event | This function deletes the specified trace events from the configuration.
admin:group-disable-audit-event-type | This function changes the audit event type(s) enabled setting for the audit configuration.
admin:group-enable-audit-event-type | This function changes the audit event type(s) enabled setting for the audit configuration.
admin:group-exists | This function determines whether or not the specified Group exists.
admin:group-get-appserver-ids | This function returns the IDs of all appservers belonging to the group.
admin:group-get-audit-enabled | This function returns the value for the audit enabled setting from the specified group.
admin:group-get-audit-event-type-enabled | This function returns the audit event type's enabled setting for the audit configuration.
admin:group-get-audit-excluded-roles | This function returns the roles excluded from auditing.
admin:group-get-audit-excluded-uris | This function returns the uris excluded from auditing.
admin:group-get-audit-excluded-users | This function returns the users excluded from auditing.
admin:group-get-audit-included-roles | This function returns the roles included from auditing.
admin:group-get-audit-included-uris | This function returns the uris included from auditing.
admin:group-get-audit-included-users | This function returns the users included from auditing.
admin:group-get-audit-outcome-restriction | This function returns whether auditing events are restricted by a success or failure outcome.
admin:group-get-compressed-tree-cache-partitions | This function returns the value for the compressed tree cache partitions setting from the specified group.
admin:group-get-compressed-tree-cache-size | This function returns the value for the compressed tree cache size setting from the specified group.
admin:group-get-compressed-tree-read-size | This function returns the value for the compressed tree read size (in kilobytes) setting from the specified group.
admin:group-get-expanded-tree-cache-partitions | This function returns the value for the expanded tree cache partitions setting from the specified group.
admin:group-get-expanded-tree-cache-size | This function returns the value for the expanded tree cache size setting from the specified group.
admin:group-get-failover-enable | This function returns the value for the failover enable setting from the specified group.
admin:group-get-file-log-level | This function returns the value for the file log level setting from the specified group.
admin:group-get-host-ids | This function returns the IDs of all hosts belonging to the group.
admin:group-get-host-initial-timeout | This function returns the value for the host initial timeout setting from the specified group.
admin:group-get-host-timeout | This function returns the value for the host timeout setting from the specified group.
admin:group-get-http-timeout | This function returns the value for the http timeout setting from the specified group.
admin:group-get-http-user-agent | This function returns the value for the http user agent setting from the specified group.
admin:group-get-httpserver-ids | This function returns the IDs of all httpservers belonging to the group.
admin:group-get-id | This function returns the ID of the group.
admin:group-get-keep-audit-files | This function returns the value for the keep audit files setting from the specified group.
admin:group-get-keep-log-files | This function returns the value for the keep log files setting from the specified group.
admin:group-get-list-cache-partitions | This function returns the value for the list cache partitions setting from the specified group.
admin:group-get-list-cache-size | This function returns the value for the list cache size setting from the specified group.
admin:group-get-name | This function returns the name of the specified group.
admin:group-get-namespaces | This function returns the value of any namespace definitions predefined for the specified group.
admin:group-get-retry-timeout | This function returns the value for the number of seconds a request will retry before timing out.
admin:group-get-rotate-audit-files | This function returns the value for the rotate audit files setting from the specified group.
admin:group-get-rotate-log-files | This function returns the value for the rotate log files setting from the specified group.
admin:group-get-scheduled-tasks | This function returns all of the tasks scheduled for the specified group.
admin:group-get-schemas | This function returns the value of any schemas definitions predefined for the specified group.
admin:group-get-smtp-relay | This function returns the value for the smtp relay setting from the specified group.
admin:group-get-smtp-timeout | This function returns the value for the smtp timeout setting from the specified group.
admin:group-get-system-log-level | This function returns the value for the system log level setting from the specified group.
admin:group-get-taskserver-id | This function returns the ID of of the taskserver belonging to the group.
admin:group-get-trace-events | This function returns the value of any trace events activated for the specified group.
admin:group-get-trace-events-activated | This function returns the value for the trace events activated setting from the specified group.
admin:group-get-webdavserver-ids | This function returns the IDs of all webdavservers belonging to the group.
admin:group-get-xdbcserver-ids | This function returns the IDs of all xdbcservers belonging to the group.
admin:group-get-xdqp-ssl-allow-sslv3 | This function returns true if the SSL v3 protocol is enabled for the group.
admin:group-get-xdqp-ssl-allow-tls | This function returns true if the TLS protocol is enabled for the group.
admin:group-get-xdqp-ssl-ciphers | This function returns the SSL ciphers set for the group.
admin:group-get-xdqp-ssl-enabled | This function returns true if SSL is enabled for the group.
admin:group-get-xdqp-timeout | This function returns the value for the xdqp timeout setting from the specified group.
admin:group-hourly-scheduled-task | This function constructs a task to be invoked at hourly intervals.
admin:group-minutely-scheduled-task | This function constructs a task to be invoked at intervals defined in terms of minutes.
admin:group-monthly-scheduled-task | This function constructs a task to be invoked at monthly intervals.
admin:group-namespace | This function constructs a namespace element with the specified prefix and URI.
admin:group-one-time-scheduled-task | This function constructs a task to be invoked once, at a specific calendar day and time.
admin:group-schema | This function constructs a schema element with the specified prefix and URI.
admin:group-set-audit-enabled | This function changes the audit enabled setting for the group in the configuration.
admin:group-set-audit-outcome-restriction | This function restricts the audit configuration by auditing events only if they are "success" or "failure" events.
admin:group-set-audit-role-restriction | This function restricts the audit configuration by excluding or including by role.
admin:group-set-audit-uri-restriction | This function restricts the audit configuration by excluding or including by document uri(s).
admin:group-set-audit-user-restriction | This function restricts the audit configuration by excluding or including by user.
admin:group-set-compressed-tree-cache-partitions | This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value.
admin:group-set-compressed-tree-cache-size | This function changes the compressed tree cache size setting of the group with the specified ID to the specified value.
admin:group-set-compressed-tree-read-size | This function changes the compressed tree read size setting of the group with the specified ID to the specified value.
admin:group-set-expanded-tree-cache-partitions | This function changes the expanded tree cache partitions setting of the group with the specified ID to the specified value.
admin:group-set-expanded-tree-cache-size | This function changes the expanded tree cache size setting of the group with the specified ID to the specified value.
admin:group-set-failover-enable | This function changes the failover enable setting for the group in the configuration.
admin:group-set-file-log-level | This function changes the host file log level setting for the group in the configuration.
admin:group-set-host-initial-timeout | This function changes the host initial timeout setting (the time the cluster will wait for a host to come online during cluster startup) for the group in the configuration.
admin:group-set-host-timeout | This function changes the host timeout setting (the timeout for communication between hosts) for the group in the configuration.
admin:group-set-http-timeout | This function changes the HTTP timeout setting for the group in the configuration.
admin:group-set-http-user-agent | This function changes the HTTP User-Agent setting for the group in the configuration.
admin:group-set-keep-audit-files | This function changes the keep audit files setting for the group in the configuration.
admin:group-set-keep-log-files | This function changes the keep log files setting for the group in the configuration.
admin:group-set-list-cache-partitions | This function changes the list cache partitions setting of the group with the specified ID to the specified value.
admin:group-set-list-cache-size | This function changes the list cache size setting of the group with the specified ID to the specified value.
admin:group-set-name | This function changes the name of the group with the specified ID to the specified name.
admin:group-set-retry-timeout | This function changes the the number of seconds a request will retry before timing out.
admin:group-set-rotate-audit-files | This function changes the rotate audit files setting for the group in the configuration.
admin:group-set-rotate-log-files | This function changes the rotate log files setting for the group in the configuration.
admin:group-set-smtp-relay | This function changes the SMTP relay setting for the group in the configuration.
admin:group-set-smtp-timeout | This function changes the SMTP timeout setting for the group in the configuration.
admin:group-set-system-log-level | This function changes the host system log level setting for the group in the configuration.
admin:group-set-trace-events-activated | This function changes the value for trace events in the group configuration.
admin:group-set-xdqp-ssl-allow-sslv3 | This function enables or disables the SSL v3 protocol for the specified group.
admin:group-set-xdqp-ssl-allow-tls | This function enables or disables the TLS protocol for the specified group.
admin:group-set-xdqp-ssl-ciphers | This function sets SSL ciphers for the specified group.
admin:group-set-xdqp-ssl-enabled | This function enables or disables SSL for the group.
admin:group-set-xdqp-timeout | This function changes the XDQP timeout setting (the timeout for communication between data nodes and evaluator nodes) for the group in the configuration.
admin:group-trace-event | This function constructs an event element for the specified event name.
admin:group-weekly-scheduled-task | This function constructs a task to be invoked at weekly intervals.
admin:host-exists | This function determines whether or not the specified Host exists.
admin:host-get-group | This function returns the group ID for the host with the specified ID.
admin:host-get-id | This function return the ID for the specified host from the configuration.
admin:host-get-name | This function returns the name for the host with the specified ID.
admin:host-get-port | This function returns the bind port for the host with the specified ID.
admin:host-set-group | This function changes the group to which an existing host belongs to the newly specified value.
admin:host-set-name | This function changes the name of an existing host to the newly specified value.
admin:host-set-port | This function changes the bind port value for the host to the newly specified value.
admin:http-server-create | This function creates a new HTTP App Server with the specified name, root, and port in the configuration.
admin:mimetype | This function constructs a mimetype specification.
admin:mimetypes-add | This function adds mimetypes to the configuration.
admin:mimetypes-delete | This function deletes mimetypes from the configuration.
admin:mimetypes-get | This function returns all the mimetypes from the configuration.
admin:restart-hosts | This function restarts MarkLogic Server for the specified hosts.
admin:save-configuration | This function saves a configuration specification to the cluster configuration files.
admin:save-configuration-without-restart | This function saves a configuration specification to the cluster configuration files, without restarting MarkLogic Server.
admin:taskserver-get-debug-allow | This function returns the value for the debug-allow setting configured on the task server for the specified group.
admin:taskserver-get-debug-threads | This function returns the number of debug threads configured on the task server for the specified group.
admin:taskserver-get-default-time-limit | This function returns the default time limit configured on the task server for the specified group.
admin:taskserver-get-log-errors | This function returns the value for the log-errors setting configured on the task server for the specified group.
admin:taskserver-get-max-time-limit | This function returns the maximum time limit configured on the task server for the specified group.
admin:taskserver-get-name | This function returns the name of the task server for the specified group from the configuration.
admin:taskserver-get-post-commit-trigger-depth | This function returns the maximum post-commit trigger depth configured on the task server for the specified group.
admin:taskserver-get-pre-commit-trigger-depth | This function returns the maximum pre-commit trigger depth configured on the task server for the specified group.
admin:taskserver-get-pre-commit-trigger-limit | This function returns the pre-commit trigger limit configured on the task server for the specified group.
admin:taskserver-get-profile-allow | This function returns the value for the profile-allow setting configured on the task server for the specified group.
admin:taskserver-get-queue-size | This function returns the number queue size configured on the task server for the specified group.
admin:taskserver-get-threads | This function returns the number of threads configured on the task server for the specified group.
admin:taskserver-set-debug-allow | This function sets the value for the debug allow setting for the task server in the configuration.
admin:taskserver-set-debug-threads | This function sets the value in the configuration of the maximum number of debug threads for the specified task server.
admin:taskserver-set-default-time-limit | This function sets the task server default time limit in the configuration.
admin:taskserver-set-log-errors | This function sets the value for the log errors setting for the task server in the configuration.
admin:taskserver-set-max-time-limit | This function sets the task server max time limit in the configuration.
admin:taskserver-set-post-commit-trigger-depth | This function sets the value for the task server post-commit trigger depth in the configuration.
admin:taskserver-set-pre-commit-trigger-depth | This function sets the value for the task server pre-commit trigger depth in the configuration.
admin:taskserver-set-pre-commit-trigger-limit | This function sets the value for the task server pre-commit trigger depth in the configuration.
admin:taskserver-set-profile-allow | This function sets the value for the profile allow setting for the task server in the configuration.
admin:taskserver-set-queue-size | This function sets the value in the configuration of the maximum queue size for the specified task server.
admin:taskserver-set-threads | This function sets the value in the configuration of the maximum number of threads for the specified task server.
admin:webdav-server-create | This function creates a new WebDAV App Server with the specified name, library, and port in the configuration.
admin:xdbc-server-create | This function creates a new XDBC App Server with the specified name, root, and port in the configuration.
Function Detail
admin:appserver-add-namespace(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $namespaces as element(gr:namespace)*
) as element(configuration)
Summary: Add one or more namespaces to an App Server configuration, which will predefine the namespace(s) for all requests evaluated against the App Server.
Parameters:
$config : The configuration for the cluster, typically the result of `admin:get-configuration()` call.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$namespaces : A list of namespaces to add. Each namespace specification has the following form:
      <namespace xmlns="http://marklogic.com/xdmp/group">
        <prefix>myprefix</prefix>
        <namespace-uri>http://myuri/forthisprefix</namespace-uri>
      </namespace>
Typically the result of an `admin:group-namespace` call.
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:appserver-add-namespace($config,
        admin:appserver-get-id($config,(), "Docs"),
        <namespace xmlns="http://marklogic.com/xdmp/group">
          <prefix>myprefix</prefix>
          <namespace-uri>http://myuri/forthisprefix</namespace-uri>
        </namespace>)

      => The XML for new configuration with this namespace added.  Use
         this as the argument to admin:save-configuration to change
         the configuration.
admin:appserver-add-request-blackout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $request-blackouts as element(gr:request-blackout)*
) as element(configuration)
Summary: This function adds a request blackout specification for a appserver to a configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The id of the appserver (for example, `xdmp:server("myAppserver")`).
$request-blackouts : The request blackout specification(s), typically the result of an `admin:appserver-one-time-request-blackout` or an `admin:appserver-recurring-request-blackout` call
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 $app-id := xdmp:server("myAppserver")
      let $requestspec := admin:appserver-one-time-request-blackout((),(),
            xs:dateTime("2008-02-14T09:45:00"),
            (), xs:dayTimeDuration("PT3H") )
      return
      admin:appserver-add-request-blackout($config, $app-id, $requestspec)
      (: 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.  :)
admin:appserver-add-schema(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $schemas as element(gr:schema)*
) as element(configuration)
Summary: This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified App Server. Schemas with a schema binding definition are automatically imported into queries run against the App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$schemas : A list of schema specification elements of the form:
    <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
      <namespace-uri>foo</namespace-uri>
      <schema-location>/foo.xsd</schema-location>
    </schema>
Typically the result of an `admin:group-schema` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-add-schema($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
      <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
         <namespace-uri>foo</namespace-uri>
         <schema-location>/foo.xsd</schema-location>
      </schema>)
      (: 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.  :)
admin:appserver-copy(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $target-group-id as xs:unsignedLong?,
| $appserver-name as xs:string,
| $port as xs:unsignedLong
) as element(configuration)
Summary: This function creates a new App Server specification with the same settings as the App Server with the specified ID. The new App Server configuration will have the specified name. You can copy the App Server to a new one either in the same group (by specifying $old-group-id and $new-group-id with the same group ID) or in a different group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$target-group-id : The optional group ID of the new group to which the App Server is copied. If no ID is provided, the appserver will be copied to the same group it exists in. Typically, this is the result of an `admin:group-get-id` call.
$appserver-name : The new name for the App Server.
$port : The port number for the new App Server.
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 $group-id := admin:group-get-id($config, "Default")
      let $appserver-id := admin:appserver-get-id($config, $group-id,
                           "myAppServer")
      return
      admin:appserver-copy($config, $appserver-id, $group-id,
                           "myNewAppServer", 8012)

      (: 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.  :)
admin:appserver-delete(
| $config as element(configuration),
| $appserver-ids as xs:unsignedLong*
) as element(configuration)
Summary: This function deletes one or more App Servers in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-ids : The ID(s) of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "myGroup")
      return
      admin:appserver-delete($config,
            admin:appserver-get-id($config, $groupid, "myAppServer") )
      (: 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.  :)
admin:appserver-delete-namespace(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $namespaces as element(gr:namespace)*
) as element(configuration)
Summary: This function deletes a namespace configuration from the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$namespaces : A list of namespaces to add. Each namespace specification has the following form:
      <namespace xmlns="http://marklogic.com/xdmp/group">
        <prefix>myprefix</prefix>
        <namespace-uri>http://myuri/forthisprefix</namespace-uri>
      </namespace>
Typically the result of an `admin:group-namespace` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-delete-namespace($config,
           admin:appserver-get-id($config, $groupid, "myAppServer"),
       <namespace xmlns="http://marklogic.com/xdmp/group">
         <prefix>myprefix</prefix>
         <namespace-uri>http://myuri/forthisprefix</namespace-uri>
       </namespace>)
      (: 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.  :)
admin:appserver-delete-request-blackout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $blackouts as element(gr:request-blackout)*
) as element(configuration)
Summary: This function deletes a request blackout specification for a appserver from a configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The id of the appserver (for example, `xdmp:server("myAppserver")`).
$blackouts : The request blackout(s) to delete. Typically, the result of an `admin:appserver-get-request-blackouts` call.
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 $app-id := xdmp:server("myAppserver")
      let $requestspec := admin:appserver-get-request-blackouts($config,
            $app-id )
      return
      admin:appserver-delete-request-blackout($config, $app-id, $requestspec)
      (: 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.  :)
admin:appserver-delete-schema(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $schemas as element(gr:schema)*
) as element(configuration)
Summary: This function deletes a schema definition in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$schemas : A list of schema specification elements of the form:
    <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
      <namespace-uri>foo</namespace-uri>
      <schema-location>/foo.xsd</schema-location>
    </schema>
Typically the result of an `admin:group-schema` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-delete-schema($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
      <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
         <namespace-uri>foo</namespace-uri>
         <schema-location>/foo.xsd</schema-location>
      </schema>)
      (: 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.  :)
admin:appserver-exists(
| $config as element(configuration),
| $group-ids as xs:unsignedLong*,
| $appserver-name as xs:string
) as xs:boolean
Summary: This function determines whether or not the specified App Server exists. Returns `true` if the App Server exists, otherwise `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-ids : The list of group IDs returned from the `admin:get-group-ids` function.
$appserver-name : The name of the App Server to check.
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 $groups := admin:get-group-ids($config)

      return admin:appserver-exists($config, $groups, "Admin")

      (: Returns true, if the Admin App Server exists. :)
admin:appserver-get-address(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the IP address of the App Server configuration. The default is `0.0.0.0`.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-address($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-authentication(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the authentication scheme (basic, digest, digestbasic, or application-level) configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-authentication($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-backlog(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the socket listen backlog setting for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-backlog($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-collation(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the collation URI set in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-collation($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-compute-content-length(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value of whether the WebDAV server computes content length.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-compute-content-length($config,
                 admin:appserver-get-id($config, $groupid, "myWebDAVServer"))
admin:appserver-get-concurrent-request-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the concurrent request limit for any user for the specified App Server. 0 indicates no bound on the number of concurrent requests.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-concurrent-request-limit($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-database(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the database to which the App Server is set to execute queries against for the specified database.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-database($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-debug-allow(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value of debug allow setting configured for this App Server, where true indicates that the App Server will allow queries to be debugged, and false indicates that it will not.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-debug-allow($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-default-time-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the default time limit value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-default-time-limit($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-default-user(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the default user value configured for the specified App Server. The default user only is used with application-level authentication.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-default-user($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-default-xquery-version(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value of the default xquery version configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-default-xquery-version($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-display-last-login(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value of the whether or not the appserver should display users' last login information.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-display-last-login($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-enabled(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the enabled state for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-enabled($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-error-handler(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the path to the error handler configured for this App Server. If no error handler is configured, returns the empty string.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-error-handler($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-group-id(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the specified App Server's group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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:appserver-get-group-id($config, admin:appserver-get-id($config, (),
        "myAppServer"))
admin:appserver-get-host-ids(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the ID(s) of the hosts the specified App Server's is currently running on.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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:appserver-get-host-ids($config, admin:appserver-get-id($config, (),
        "myAppServer"))
admin:appserver-get-id(
| $config as element(configuration),
| $group-ids as xs:unsignedLong*,
| $appserver-name as xs:string
) as xs:unsignedLong*
Summary: This function returns the ID of the specified App Server. The difference between this function and `xdmp:server()` is that the ID from this function can come from an appserver that has not yet been saved (that is, from an appserver that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files). This ID enables you to completely configure a newly created appserver without the need to first save the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-ids : The optional group-ids in which to restrict the appserver ids returned. If no group-id is specified, this function will return all matching appservers across all groups.
$appserver-name : The name of the App Server.
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:appserver-get-id($config, admin:group-get-id($config, "Default"),
             "myAppServer")
admin:appserver-get-keep-alive-timeout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the keep alive timeout value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-keep-alive-timeout($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-last-login(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the database to which the App Server stores users' last login information.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-last-login($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-log-errors(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value of the log errors setting configured for this App Server, where true indicates that the App Server will send uncaught exceptions to the `ErrorLog.txt` file, and false indicates that it will not.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-log-errors($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-max-time-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the max time limit value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-max-time-limit($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-modules-database(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the database set as the modules database for the specified database.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
Usage Notes: This function throws an exception if the specified App Server is a WebDAV server (because WebDAV servers do not use a modules database).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-modules-database($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-name(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name of the appserver with the specified ID.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-name($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-namespaces(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as element(gr:namespace)*
Summary: This function returns the value of any namespace definitions predefined for the specified App Server. If none are defined, returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-namespaces($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-output-encoding(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the output encoding setting for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-output-encoding($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-output-sgml-character-entities(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the output sgml character entities setting for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-output-sgml-character-entities($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-port(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the port for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-port($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-pre-commit-trigger-depth(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the pre commit trigger depth value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-pre-commit-trigger-depth($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-pre-commit-trigger-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the pre commit trigger limit value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-pre-commit-trigger-limit($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-privilege(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the privilege ID for the specified App Server. If no privilege is configured, It returns 0.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-privilege($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-profile-allow(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value of the profile allow setting configured for this App Server, where true indicates that the App Server will allow queries to be profiled, and false indicates that it will not.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-profile-allow($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-request-blackouts(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as element(gr:request-blackout)*
Summary: This function returns the request blackouts specification for the specified appserver from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The id of the appserver (for example, `xdmp:server("myAppserver")`).
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:appserver-get-request-blackouts($config, xdmp:server("myAppserver") )
      (: returns the request-blackouts specification for the appserver :)
admin:appserver-get-request-timeout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the request timeout value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-request-timeout($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-root(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the root for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-root($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-schemas(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as element(gr:schema)*
Summary: This function returns the value of any schemas definitions predefined for the specified App Server. If none are defined, returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-schemas($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-session-timeout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the session timeout value configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-session-timeout($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-ssl-allow-sslv3(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns true if the SSL v3 protocol is enabled for the specified App Server, or false if SSL v3 is disabled.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
          admin:appserver-get-ssl-allow-sslv3($config, $appServer)

       (: Returns true if SSL v3 is enabled for the "Docs" App Server.  Otherwise false. :)
admin:appserver-get-ssl-allow-tls(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns true if the TLS protocol is enabled for the specified App Server, or false if TLS is disabled.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
          admin:appserver-get-ssl-allow-tls($config, $appServer)

       (: Returns true if TLS is enabled for the "Docs" App Server.  Otherwise false. :)
admin:appserver-get-ssl-certificate-template(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the id of the SSL certificate template used by the specified App Server. If no template is set for the App Server, 0 is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
         admin:appserver-get-ssl-certificate-template($config, $appServer)

        (: returns the id of the SSL certificate template. :)
admin:appserver-get-ssl-ciphers(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the SSL ciphers set for the App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
         admin:appserver-get-ssl-ciphers($config, $appServer)

      (: returns the SSL ciphers set for the App Server. :)
admin:appserver-get-ssl-client-certificate-authorities(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the id(s) of the client certificate authority for the specified App Server. If no client certificate authority is set, this function returns an empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
         admin:appserver-get-ssl-client-certificate-authorities($config, $appServer)

      (: Returns the id(s) of the client certificate authority for the "Docs" App Server, if set.
      Otherwise returns an empty sequence. :)
admin:appserver-get-ssl-hostname(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string?
Summary: This function returns the SSL hostname for the specified App Server. If no hostname is set, nothing is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
         admin:appserver-get-ssl-hostname($config, $appServer)

      (: returns the SSL hostname for the App Server, if set. :)
admin:appserver-get-ssl-require-client-certificate(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns true if a client certificate is required for the specified App Server. Otherwise, it returns false.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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:appserver-get-ssl-require-client-certificate($config,
             admin:appserver-get-id($config,(), "Docs"))

      (: Returns true if a client certificate is required for the "Docs" App Server.  Otherwise, false.  :)
admin:appserver-get-static-expires(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value of the "expires" HTTP header for static content to expire after this many seconds port for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-static-expires($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-threads(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the maximum number of threads configured for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-threads($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-get-type(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the type of appserver with the specified ID. It will be either "http", "xdbc", or "WebDAV".
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-type($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
      (: returns "http", "xdbc", or "WebDAV" :)
admin:appserver-get-url-rewriter(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong
) as xs:string
Summary: This function returns the path to the URL rewriter configured for this App Server. If no URL rewriter is configured, returns the empty string.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-get-url-rewriter($config,
                 admin:appserver-get-id($config, $groupid, "myAppServer"))
admin:appserver-one-time-request-blackout(
| $users as xs:unsignedLong*,
| $roles as xs:unsignedLong*,
| $start as xs:dateTime,
| $end as xs:dateTime?,
| $duration as xs:duration?
) as element(gr:request-blackout)
Summary: This function constructs a one-time request-blackout specification.
Parameters:
$users : A sequence of user ID(s) that the request blackout applies too.
$roles : A sequence of role ID(s) that the request blackout applies too.
$start : The starting dateTime of the request blackout.
$end : The ending dateTime of the request blackout.
$duration : The amount of time for the blackout to last.
Example:
      xquery version "1.0-ml";

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

      admin:appserver-one-time-request-blackout((),(),
            xs:dateTime("2008-02-14T09:45:00"),
            (), xs:dayTimeDuration("PT3H") )
      (: returns the one-time request-blackout specification :)
admin:appserver-recurring-request-blackout(
| $users as xs:unsignedLong*,
| $roles as xs:unsignedLong*,
| $days as xs:string*,
| $start-time as xs:time?,
| $end-time as xs:time?,
| $duration as xs:duration?
) as element(gr:request-blackout)
Summary: This function constructs a request-blackout specification.
Parameters:
$users : A sequence of user ID(s) that the request blackout applies too.
$roles : A sequence of role ID(s) that the request blackout applies too.
$days : The day(s) of the week. Must be a sequence of zero or more of `monday`, `tuesday`, `wednesday`, `thusday`, `friday`, `saturday`, `sunday`.
$start-time : A time for the request blackout to start.
$end-time : A time for the request blackout to end.
$duration : The amount of time for the blackout to last.
Example:
      xquery version "1.0-ml";

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

      admin:appserver-recurring-request-blackout((),(), "monday",
            xs:time("09:45:00"), xs:time("11:45:00"), () )
      (: returns the request-blackout specification :)
admin:appserver-set-address(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the IP Address in the configuration for the specified App Server to the specified address. Changing the address is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new value for the IP address for the specified App Server.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-address(
             $config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "127.0.0.1")
      (: 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.  :)
admin:appserver-set-authentication(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the authentication scheme in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The authentication scheme (`basic`, `digest`, `digestbasic`, or `application-level`).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-authentication($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "digest")
      (: 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.  :)
admin:appserver-set-backlog(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value in the configuration of the backlog (the maximum number of pending connections allowed on the HTTP socket) for the specified App Server. This is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new integer value for the backlog.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-backlog($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             64)
      (: 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.  :)
admin:appserver-set-collation(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the default collation in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A valid collation URI (for example, `http://marklogic.com/collation/`).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-collation($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
    	 "http://marklogic.com/collation/")
      (: 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.  :)
admin:appserver-set-compute-content-length(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function changes the value whether a WebDAV server computes content length.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new value for compute content length.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-compute-content-length($config,
             admin:appserver-get-id($config, $groupid, "myWebDAVServer"),
             fn:true())
      (: 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.  :)
admin:appserver-set-concurrent-request-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the limit on concurrent requests that any user may have on a particular appserver. Setting the limit to 0 indicates there is no bound on the number of concurrent requests.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The limit of concurrent requests.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-concurrent-request-limit($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             15)
      (: 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.  :)
admin:appserver-set-database(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets the value in the configuration of the database for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The database ID for the database to set as the database for the specified App Server.
Usage Notes: Any database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the database, do so in a separate transaction before using them in in this function.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-database($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             xdmp:database("myDatabase"))
      (: 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.  :)
admin:appserver-set-debug-allow(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the debug allow setting in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value specifying whether to allow debugging on this App Server (true) or not (false).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-debug-allow($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             fn:true())
      (: 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.  :)
admin:appserver-set-default-time-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the default time limit (the maximum total amount of time to service a request before the App Server throws a timeout exception) in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new integer timeout value (specifies the number of seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-default-time-limit($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10000)
      (: 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.  :)
admin:appserver-set-default-user(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets the default user (for use with application-level authentication) in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The user ID of the user to set as the default user.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-default-user($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
    	 xdmp:eval('
                      xquery version "1.0-ml";
                      import module "http://marklogic.com/xdmp/security"
    		    at "/MarkLogic/security.xqy";
    	          sec:uid-for-name("annabelle")', (),
    	   <options xmlns="xdmp:eval">
    		 <database>{xdmp:security-database()}</database>
    	   </options>))
      (: 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.  :)
admin:appserver-set-default-xquery-version(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the default XQuery version setting in the configuration for this App Server. This setting determines the XQuery dialect used in queries against this App Server when one is not explicitly specified in the XQuery version declaration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The default XQuery version value, one of `1.0-ml`, `1.0`, or `0.9-ml`.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-default-xquery-version($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "1.0-ml")
      (: 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.  :)
admin:appserver-set-display-last-login(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the display last login setting in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value specifying whether to indicate if the appserver should display last login information.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-display-last-login($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             fn:true())
      (: 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.  :)
admin:appserver-set-enabled(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the enabled state in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The enabled state of the App Server to set, true for enabled and false for disabled.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-enabled($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             fn:true())
      (: 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.  :)
admin:appserver-set-error-handler(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the value of the path to the error handler in the configuration for the specified App Server. The path should specify a relative or absolute path to an XQuery module that is executed in the event of any 400 or 500 series HTTP errors (sometime known as a "sorry" server to give the user a clean error page).
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The path to the XQuery main module to execute when 400 or 500 series errors occur on the App Server.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-error-handler($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "sorry.xqy")
      (: 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.  :);
admin:appserver-set-keep-alive-timeout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the keep-alive timeout (the maximum number of second for subsequent socket requests to time out) in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new integer timeout value (specifies the number of seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-keep-alive-timeout($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10)
      (: 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.  :)
admin:appserver-set-last-login(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedLong?
) as element(configuration)
Summary: This function sets the value in the configuration of the last login database for the specified App Server. If the value is equal to 0, then the last-login feature is disabled for this appserver.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The database ID for the database to set as the database for the specified App Server. To disable the last-login feature, use the empty sequence or 0 for this value
Usage Notes: Any database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the database, do so in a separate transaction before using them in in this function.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-last-login($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             xdmp:database("Last-Login"))
      (: 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.  :)
admin:appserver-set-log-errors(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the log errors setting in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value specifying whether to allow send uncaught exceptions on this App Server to the `ErrorLog.txt` file (true) or not (false).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-log-errors($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             fn:true())
      (: 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.  :)
admin:appserver-set-max-time-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the max time limit (the maximum total amount of time to service a request before the App Server throws a timeout exception) in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new integer timeout value (specifies the number of seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-max-time-limit($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10000)
      (: 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.  :)
admin:appserver-set-modules-database(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as item()
) as element(configuration)
Summary: This function sets the value in the configuration of modules database for the specified App Server to the specified database ID.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The database ID for the database to set as the modules database. To specify the filesystem, use 0 or "file-system"
Usage Notes: Any database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the database, do so in a separate transaction before using them in in this function.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-modules-database($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             xdmp:database("Modules"))
      (: 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.  :)
admin:appserver-set-name(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the name of an existing App Server to the newly specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new name for the specified App Server.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-name($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "myNewAppServerName")
      (: 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.  :)
admin:appserver-set-output-encoding(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the value for the default output encoding in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The default value for outputting characters. The value must be the name of a valid character set (for example, `UTF-8`, `ASCII`, and so on.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-output-encoding($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "ascii")
      (: 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.  :)
admin:appserver-set-output-sgml-character-entities(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the SGML character entity output setting in the configuration for the specified App Server. The SGML setting determines how characters that can be represented as SGML entites are serialized upon output by default in a query against the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The default value for outputting SGML entities, one of `none`, `default`, `math`, or `pub`.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-output-sgml-character-entities($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "default")
      (: 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.  :)
admin:appserver-set-port(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the port in the configuration for the specified App Server to the specified number. Changing the port is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new port number.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-port($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             1234)
      (: 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.  :)
admin:appserver-set-pre-commit-trigger-depth(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the maximum depth (how many triggers can cause other triggers to fire, which in turn cause others to fire, and so on) in the configuration for the specifed App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The maximum depth (how many triggers can cause other triggers to fire, which in turn cause others to fire, and so on) for pre-commit triggers.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-pre-commit-trigger-depth($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10000)
      (: 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.  :)
admin:appserver-set-pre-commit-trigger-limit(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value in the configuration for the maximum number of pre-commit triggers a single statement can invoke for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The limit for the number of pre-commit triggers a single statement can invoke.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-pre-commit-trigger-limit($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             1000)
      (: 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.  :)
admin:appserver-set-privilege(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets an execute privilege in the configuration for the specified App Server. When a privilege is set, the user who makes a request to the App Server must have been granted (via a role, either directly or indirectly) the specified privilege.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The privilege ID of an execute privilege needed to access this App Server.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-privilege($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
    	 xdmp:eval('
                    xquery version "1.0-ml";
                    import module "http://marklogic.com/xdmp/security"
          at "/MarkLogic/security.xqy";
          sec:get-privilege("http://marklogic.com/my.uri",
             "execute")/sec:privilege-id',
          (),
         <options xmlns="xdmp:eval">
         <database>{xdmp:security-database()}</database>
         </options>))
      (: 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.  :)
admin:appserver-set-profile-allow(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the profile allow setting in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value specifying whether to allow profiling on this App Server (true) or not (false).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-profile-allow($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             fn:true())
      (: 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.  :)
admin:appserver-set-request-timeout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value of the socket request timeout (the number of seconds before the socket times out) in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : An integer specifying the number of seconds before a socket request times out.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-request-timeout($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10)
      (: 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.  :)
admin:appserver-set-root(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the root for a specified App Server to the newly specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new value for the root. The root must be either a fully qualified path (for example, `/space/myRoot` or `c:/space/myRoot`) or a relative path (for example, `myRoot`); relative paths are resolved relative to the directory in which MarkLogic Server is installed.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-root($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "myNewRoot")
      (: 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.  :)
admin:appserver-set-session-timeout(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the session timeout value (in seconds) in the configuration for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new integer timeout value (specifies the number of seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-session-timeout($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10000)
      (: 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.  :)
admin:appserver-set-ssl-allow-sslv3(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function enables or disables the SSL v3 protocol for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
          admin:appserver-set-ssl-allow-sslv3($config, $appServer, fn:false())

       (: Disables SSL v3 for the "Docs" App Server. :)
admin:appserver-set-ssl-allow-tls(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function enables or disables the TLS protocol for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
           admin:appserver-set-ssl-allow-tls($config, $appServer, fn:true())

       (: Enables TLS for the "Docs" App Server. :)
admin:appserver-set-ssl-certificate-template(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets an SSL certificate template for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The id of the certificate template. This would typically be the result of a `pki:insert-template(pki:create-template())` call.
Example:
      xquery version "1.0-ml";

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

      let $config := admin:get-configuration()
      let $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "myAppServer")
      let $tid := pki:template-get-id(pki:get-template-by-name("mycert"))

      return
         admin:appserver-set-ssl-certificate-template(
                              $config,
                              $appServer,
                              $tid)

      (: Sets the certificate template, "mycert," for the "myAppServer" App Server. :)
admin:appserver-set-ssl-ciphers(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets SSL ciphers for the specified App Server. This is the standard cipher specification string for OpenSSL.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The SSL ciphers to set.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
         admin:appserver-set-ssl-ciphers($config, $appServer, "All")

      (: Sets the ciphers for the "Docs" App Server to "All".  :)
admin:appserver-set-ssl-client-certificate-authorities(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedLong*
) as element(configuration)
Summary: This function sets one or more client certificate authorities that sign client certificates for the specified App Server. This function is typically used along with the `pki:insert-trusted-certificates` and `pki:get-trusted-certificate-ids` functions to import trusted Certificate Authorities for client certificates.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : One or more ids for trusted certificates generated by the certificate authority to be set.
Example:
      xquery version "1.0-ml";

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

      declare namespace x509 = "http://marklogic.com/xdmp/x509";

      let $config := admin:get-configuration()
      let $groupid := admin:group-get-id($config, "Default")
      let $appservid := admin:appserver-get-id($config, $groupid, "myAppServer")

      let $cert-id :=
        for $cert in pki:get-certificates(pki:get-trusted-certificate-ids())
          where $cert/x509:cert/x509:subject/x509:commonName eq "Acme Certificate Authority" and
                $cert/x509:cert/x509:subject/x509:organizationName eq "Acme Corporation"
        return
          fn:data($cert/pki:certificate-id)

      return
        admin:appserver-set-ssl-client-certificate-authorities(
    	$config,
            $appservid,
    	$cert-id)

      (: Locates the trusted certificates from the Certificate Authority, "Acme
         Corporation," with the common name of "Acme Certificate Authority" and
         adds the Certificate Authority to the list of Client Certificate Authorities
         for the App Server, "myAppServer." :)
admin:appserver-set-ssl-hostname(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets an SSL hostname for the specified App Server. The SSL hostname should only be set when a proxy or load balancer is used to represent multiple servers. In this case, you can specify an SSL hostname with this function and all instances of the application server will identify themselves as that host.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The SSL hostname.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
         admin:appserver-set-ssl-hostname($config, $appServer, "AllHost")

      (: Sets the SSL hostname for the "Docs" App Server to "AllHost".  :)
admin:appserver-set-ssl-require-client-certificate(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function determines whether or not a client certificate is required for the specified App Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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 $appServer := admin:appserver-get-id($config,
              admin:group-get-id($config, "Default"),
              "Docs")

      return
          admin:appserver-set-ssl-require-client-certificate($config, $appServer, fn:false())

      (: Specifies that the "Docs" App Server does not require a client certificate. :)
admin:appserver-set-static-expires(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the value of the "expires" HTTP header for a specified App Server to the newly specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new value for the "expires" header.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-static-expires($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             3600)
      (: 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.  :)
admin:appserver-set-threads(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value in the configuration of the maximum number of threads for the specified App Server. This is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The new integer value for the number of threads.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-threads($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             10)
      (: 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.  :)
admin:appserver-set-url-rewriter(
| $config as element(configuration),
| $appserver-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the value of the path to the URL rewriter in the configuration for the specified App Server. The path should specify a relative or absolute path to an XQuery module that is executed to rewrite incoming URLs.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$appserver-id : The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
$value : The path to the XQuery main module to execute to rewrite URLs.
Example:
      xquery version "1.0-ml";

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

      let $config := admin:get-configuration()
      let $groupid := admin:group-get-id($config, "Default")
      return
      admin:appserver-set-url-rewriter($config,
             admin:appserver-get-id($config, $groupid, "myAppServer"),
             "rewriter.xqy")
      (: 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.  :);
admin:database-add-backup(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $backups as element(db:database-backup)*
) as element(configuration)
Summary: This function adds scheduled backup specifications for a database to a 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")`).
$backups : The scheduled backup specification(s), typically the result of an `admin:database-one-time-backup` or an `admin:database-monthly-backup` or an `admin:database-weekly-backup` call
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 $database := xdmp:database("mydatabase")
      let $backup := admin:database-one-time-backup("/backup-dir",
            xs:dateTime("2008-02-14T09:45:00"))
      return
      admin:database-add-backup($config, $database, $backup)
      (: 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.  :)
admin:database-add-element-attribute-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $element-attribute-word-lexicons as element(db:element-attribute-word-lexicon)*
) as element(configuration)
Summary: This function adds an element attribute word lexicon to the specified database in 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")`).
$element-attribute-word-lexicons : An element word lexicon specification, typically the result of an `admin:database-element-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-element-attribute-word-lexicon("my/namepsace",
         "elementname", "", "myAttribute", "http://marklogic.com/collation/" )
      return
      admin:database-add-element-attribute-word-lexicon($config, $dbid, $lexspec)
      (: 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.  :)
admin:database-add-element-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $element-word-lexicons as element(db:element-word-lexicon)*
) as element(configuration)
Summary: This function adds an element word lexicon to the specified database in 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")`).
$element-word-lexicons : An element word lexicon specification, typically the result of an `admin:database-element-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-element-word-lexicon("my/namepsace",
         "elementname", "http://marklogic.com/collation/" )
      return
      admin:database-add-element-word-lexicon($config, $dbid, $lexspec)
      (: 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.  :)
admin:database-add-element-word-query-through(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $element-word-query-throughs as element(db:element-word-query-through)*
) as element(configuration)
Summary: This function adds an element word query through to the specified database in 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")`).
$element-word-query-throughs : An element word query through specification, typically the result of an `admin:database-element-word-query-through` call.
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("Documents")
      let $ewqtspec := admin:database-element-word-query-through("my/namepsace",
         "elementname" )
      return
      admin:database-add-element-word-query-through($config, $dbid, $ewqtspec)
      (: 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.  :)
admin:database-add-field(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $fields as element(db:field)*
) as element(configuration)
Summary: This function adds the field specification to the specified database in 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")`).
$fields : The field specification, typically the result of an `admin:database-field` call.
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")
      let $fieldspec := admin:database-field("myField", fn:true() )
      return
      admin:database-add-field($config, $dbid, $fieldspec)
      (: 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.  :)
admin:database-add-field-excluded-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $excluded-elements as element(db:excluded-element)*
) as element(configuration)
Summary: This function adds the field excluded element specification in the specified database in 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")`).
$field-name : The name of the field.
$excluded-elements : The excluded elements specification, typically the result of an `admin:database-excluded-element` call.
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")
      let $fieldspec := admin:database-excluded-element("http://myuri/namespace",
    	"element-name")
      return
      admin:database-add-field-excluded-element($config, $dbid,
           "myField", $fieldspec)
      (: 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.  :)
admin:database-add-field-included-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $included-elements as element(db:included-element)*
) as element(configuration)
Summary: This function adds the field included element specification tn the specified database in 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")`).
$field-name : The name of the field.
$included-elements : The included elements specification, typically the result of an `admin:database-included-element` call.
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")
      let $fieldspec :=   admin:database-included-element("http://myuri/namespace",
      "element-name", 1.0, "", "myAttribute", "some value")
      return
      admin:database-add-field-included-element($config, $dbid,
           "myField", $fieldspec)
      (: 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.  :)
admin:database-add-field-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $word-lexicons as element(db:word-lexicon)*
) as element(configuration)
Summary: This function adds a word lexicon to the specified database in 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")`).
$field-name : The name of the field.
$word-lexicons : A word lexicon specification, typically the result of an `admin:database-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-word-lexicon("http://marklogic.com/collation/")
      return
      admin:database-add-field-word-lexicon($config, $dbid, "myField", $lexspec)
      (: 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.  :)
admin:database-add-fragment-parent(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $fragment-parents as element(db:fragment-parent)*
) as element(configuration)
Summary: This function adds the specified fragment parent to the specified database in 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")`).
$fragment-parents : A fragment parent specification, typically the result of an `admin:database-fragment-parent` call.
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("Documents")
      let $fragspec := admin:database-fragment-parent("my/namespace", "element-name")
      return
      admin:database-add-fragment-parent($config, $dbid, $fragspec)
      (: 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.  :)
admin:database-add-fragment-root(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $fragment-roots as element(db:fragment-root)*
) as element(configuration)
Summary: This function adds the specified fragment root to the specified database in 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")`).
$fragment-roots : A fragment root specification, typically the result of an `admin:database-fragment-root` call.
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("Documents")
      let $fragspec := admin:database-fragment-root("my/namespace", "element-name")
      return
      admin:database-add-fragment-root($config, $dbid, $fragspec)
      (: 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.  :)
admin:database-add-geospatial-element-attribute-pair-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-attribute-pair-indexes as element(db:geospatial-element-attribute-pair-index)*
) as element(configuration)
Summary: This function adds a geospatial element attribute pair index to the specified database in 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")`).
$geospatial-element-attribute-pair-indexes : A geospatial element attribute pair index specification, typically the result of an `admin:database-geospatial-element-attribute-pair-index` call.
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 $geospec := admin:database-geospatial-element-attribute-pair-index(
    	  "/my/namespace", "elementname", "/my/namespace", "lat",
    	  "/my/namespace", "long", "wgs84", fn:false() )
      return
      admin:database-add-geospatial-element-attribute-pair-index($config,
         xdmp:database("myDatabase"), $geospec)
      (: 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.  :)
admin:database-add-geospatial-element-child-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-child-indexes as element(db:geospatial-element-child-index)*
) as element(configuration)
Summary: This function adds a geospatial element child index to the specified database in 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")`).
$geospatial-element-child-indexes : A geospatial element child index specification, typically the result of an `admin:database-geospatial-element-child-index` call.
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("Documents")
      let $geospec := admin:database-geospatial-element-child-index("/my/namespace",
              "elementname", "/my/namespace", "child-element",
              "wgs84", fn:false() )
      return
      admin:database-add-geospatial-element-child-index($config, $dbid, $geospec)
      (: 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.  :)
admin:database-add-geospatial-element-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-indexes as element(db:geospatial-element-index)*
) as element(configuration)
Summary: This function adds a range element index to the specified database in 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")`).
$geospatial-element-indexes : A geospatial element index specification, typically the result of an `admin:database-geospatial-element-index` call.
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("Documents")
      let $geospec := admin:database-geospatial-element-index("/my/namespace",
                    "elementname", "wgs84", fn:false() )
      return
      admin:database-add-geospatial-element-index($config, $dbid, $geospec)
      (: 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.  :)
admin:database-add-geospatial-element-pair-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-pair-indexes as element(db:geospatial-element-pair-index)*
) as element(configuration)
Summary: This function adds a geospatial element pair index to the specified database in 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")`).
$geospatial-element-pair-indexes : A geospatial element pair index specification, typically the result of an `admin:database-geospatial-element-pair-index` call.
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 $geospec :=  admin:database-geospatial-element-pair-index("/my/namespace",
              "elementname", "/my/namespace", "lat",
    	  "/my/namespace", "long", "wgs84", fn:false() )
      return
      admin:database-add-geospatial-element-pair-index($config,
         xdmp:database("myDatabase"), $geospec)
      (: 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.  :)
admin:database-add-merge-blackout(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $merge-blackouts as element(db:merge-blackout)*
) as element(configuration)
Summary: This function adds a merge blackout specification for a database to a 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")`).
$merge-blackouts : The merge blackout specification(s), typically the result of an `admin:database-one-time-merge-blackout` or an `admin:database-recurring-merge-blackout` call
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")
      let $mergespec := admin:database-one-time-merge-blackout(500, "lower",
            xs:dateTime("2008-02-14T09:45:00"),
            (), xs:dayTimeDuration("PT3H") )
      return
      admin:database-add-merge-blackout($config, $dbid, $mergespec)
      (: 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.  :)
admin:database-add-phrase-around(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $phrase-arounds as element(db:phrase-around)*
) as element(configuration)
Summary: This function adds a phrase around to the specified database in 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")`).
$phrase-arounds : A phrase around specification, typically the result of an `admin:database-phrase-around` call.
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("Documents")
      let $paspec := admin:database-phrase-around("my/namepsace",
         "elementname" )
      return
      admin:database-add-phrase-around($config, $dbid, $paspec)
      (: 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.  :)
admin:database-add-phrase-through(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $phrase-throughs as element(db:phrase-through)*
) as element(configuration)
Summary: This function adds a phrase through to the specified database in 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")`).
$phrase-throughs : A phrase through specification, typically the result of an `admin:database-phrase-through` call.
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("Documents")
      let $ptspec := admin:database-phrase-through("my/namepsace",
         "elementname" )
      return
      admin:database-add-phrase-through($config, $dbid, $ptspec)
      (: 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.  :)
admin:database-add-range-element-attribute-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $attribute-indexes as element(db:range-element-attribute-index)*
) as element(configuration)
Summary: This function adds a range element attribute index to the specified database in 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")`).
$attribute-indexes : An element attribute range index specification, typically the result of an `admin:database-range-element-attribute-index` call.
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("Documents")
      let $rangespec := admin:database-range-element-attribute-index("string",
           "/my/namespace", "elementname", "", "myAttribute",
           "http://marklogic.com/collation/", fn:false() )
      return
      admin:database-add-range-element-attribute-index($config, $dbid, $rangespec)
      (: 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.  :)
admin:database-add-range-element-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $range-indexes as element(db:range-element-index)*
) as element(configuration)
Summary: This function adds a range element index to the specified database in 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")`).
$range-indexes : An element range index specification, typically the result of an `admin:database-range-element-index` call.
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("Documents")
      let $rangespec := admin:database-range-element-index("string", "/my/namespace",
                    "elementname", "http://marklogic.com/collation/",
    		fn:false() )
      return
      admin:database-add-range-element-index($config, $dbid, $rangespec)
      (: 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.  :)
admin:database-add-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $word-lexicons as element(db:word-lexicon)*
) as element(configuration)
Summary: This function adds a word lexicon to the specified database in 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")`).
$word-lexicons : A word lexicon specification, typically the result of an `admin:database-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-word-lexicon("http://marklogic.com/collation/")
      return
      admin:database-add-word-lexicon($config, $dbid, $lexspec)
      (: 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.  :)
admin:database-add-word-query-excluded-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $excluded-elements as element(db:excluded-element)*
) as element(configuration)
Summary: This function adds the word query excluded element specification for the specified database to 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")`).
$excluded-elements : The excluded elements specification, typically the result of an `admin:database-excluded-element` call.
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")
      let $wqspec := admin:database-excluded-element("http://myuri/namespace",
    	"element-name")
      return
      admin:database-add-word-query-excluded-element($config, $dbid, $wqspec)
      (: 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.  :)
admin:database-add-word-query-included-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $included-elements as element(db:included-element)*
) as element(configuration)
Summary: This function adds the word query included element specification to the specified database in 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")`).
$included-elements : The included elements specification, typically the result of an `admin:database-included-element` call.
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")
      let $wqspec :=   admin:database-included-element("http://myuri/namespace",
      "element-name", 1.0, "", "myAttribute", "some value")
      return
      admin:database-add-word-query-included-element($config, $dbid, $wqspec)
      (: 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.  :)
admin:database-attach-forest(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $forest-id as xs:unsignedLong
) as element(configuration)
Summary: This function attaches the specified forest to the specified database.
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")`).
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
Usage Notes: Any forest whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the forest, do so in a separate transaction before using them in this function.
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-attach-forest($config, xdmp:database("myDatabase"),
          xdmp:forest("myForest") )
admin:database-copy(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $database-name as xs:string
) as element(configuration)
Summary: This function creates a new database specification with the same settings as the database with the specified ID. The new database configuration will have 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 to copy (for example, `xdmp:database("myDatabase")`).
$database-name : The name of the new database to create.
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-copy($config, xdmp:database("myOldDatabase"),
                        "myNewDatabase")

       => Creates a configuration with a new database specification
          having the same settings as the database named "myOldDatabase".
admin:database-create(
| $config as element(configuration),
| $database-name as xs:string,
| $security-db as xs:unsignedLong,
| $schema-db as xs:unsignedLong
) as element(configuration)
Summary: This function creates a new database specification.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$database-name : The name the database to create. The name must not be used by any other database in the cluster.
$security-db : The ID of the security database (for example, `xdmp:database("Security")` used by this database.
$schema-db : The ID of the schemas database (for example, `xdmp:database("Schemas")` used by this database.
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-create($config, "myNewDatabase",
            xdmp:database("Security"), xdmp:database("Schemas"))
admin:database-daily-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $start-time as xs:time,
| $max-backups as xs:unsignedLong,
| $backup-security-db as xs:boolean,
| $backup-schemas-db as xs:boolean,
| $backup-triggers-db as xs:boolean,
| [$include-replicas as xs:boolean]
) as element(db:database-backup)
Summary: This function constructs a daily scheduled database backup.
Parameters:
$backup-dir : The directory to save the backup.
$backup-period : The number of days to elapse between each backup
$start-time : The time of day of the backup, in 24:00:00 notation.
$max-backups : The maximum number of backups to keep. When you reach the specified maximum number of backups, the next backup will delete the oldest backup. Specify 0 to keep an unlimited number of backups.
$backup-security-db : Whether to backup the security database alongside the current backup.
$backup-schemas-db : Whether to backup the schemas database alongside the current backup.
$backup-triggers-db : Whether to backup the triggers database alongside the current backup.
$include-replicas (optional): If set to `false`, do not include the replicas in the backup. The default is `true`, which means to include all replicas in the backup.
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-daily-backup("/backup-dir", 2,
          xs:time("19:45:00"),10,true(),true(),true())

      (: returns the daily database backup specification :)
admin:database-delete(
| $config as element(configuration),
| $database-ids as xs:unsignedLong*
) as element(configuration)
Summary: This function deletes the configuration from the specified database(s). It does not delete the configuration or data for any forests attached to the deleted database(s).
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$database-ids : The id(s) for the specified database(s) (for example, `xdmp:database("myDatabase")`).
Usage Notes: Any database whose ID you pass into this function must not have any appservers targeting it when the transaction begins, otherwise an exception is thrown. If you need to delete the database, make sure no appserver targets the database in a separate transaction before calling this function.
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-delete($config, admin:database-get-id($config, "foo"))

      => The new configuration with the specified databases removed.
         Use admin:save-configuration to save these changes.
admin:database-delete-backup(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $backups as element(db:database-backup)*
) as element(configuration)
Summary: This function deletes scheduled backup specifications for a database from a 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")`).
$backups : The scheduled backup(s) to delete. Typically, the result of an `admin:database-get-backups` call.
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("Documents")
      let $backups := admin:database-get-backups($config, $database)[1 to 3]
      return
      admin:database-delete-backup($config, $dbid, $backups)
      (: 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.  :)
admin:database-delete-element-attribute-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $lexicons as element(db:element-attribute-word-lexicon)*
) as element(configuration)
Summary: This function deletes an element attribute word lexicon 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")`).
$lexicons : An element attribute word lexicon specification, typically the result of an `admin:database-element-attribute-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-element-attribute-word-lexicon("my/namepsace",
         "elementname", "", "myAttribute", "http://marklogic.com/collation/" )
      return
      admin:database-delete-element-attribute-word-lexicon($config, $dbid, $lexspec)
      (: 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.  :)
admin:database-delete-element-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $element-word-lexicons as element(db:element-word-lexicon)*
) as element(configuration)
Summary: This function deletes an element word lexicon 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")`).
$element-word-lexicons : An element word lexicon specification, typically the result of an `admin:database-element-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-element-word-lexicon("my/namepsace",
         "elementname", "http://marklogic.com/collation/" )
      return
      admin:database-delete-element-word-lexicon($config, $dbid, $lexspec)
      (: 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.  :)
admin:database-delete-element-word-query-through(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $throughs as element(db:element-word-query-through)*
) as element(configuration)
Summary: This function deletes an element word query through 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")`).
$throughs : An element word query through specification, typically the result of an `admin:database-element-word-query-through` call.
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("Documents")
      let $ewqtspec := admin:database-element-word-query-through("my/namepsace",
         "elementname" )
      return
      admin:database-delete-element-word-query-through($config, $dbid, $ewqtspec)
      (: 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.  :)
admin:database-delete-field(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-names as xs:string*
) as element(configuration)
Summary: This function deletes the field specification in 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")`).
$field-names : The name(s) of the field(s) to delete.
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-delete-field($config, $dbid, "myField")
      (: 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.  :)
admin:database-delete-field-excluded-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $excluded-elements as element(db:excluded-element)*
) as element(configuration)
Summary: This function deletes the field excluded element specification in 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")`).
$field-name : The name of the field.
$excluded-elements : The excluded elements specification, typically the result of an `admin:database-excluded-element` call.
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")
      let $fieldspec := admin:database-excluded-element("http://myuri/namespace",
    	"element-name")
      return
      admin:database-delete-field-excluded-element($config, $dbid,
           "myField", $fieldspec)
      (: 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.  :)
admin:database-delete-field-included-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $included-elements as element(db:included-element)*
) as element(configuration)
Summary: This function deletes the field included element specification in 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")`).
$field-name : The name of the field.
$included-elements : The included elements specification, typically the result of an `admin:database-included-element` call.
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")
      let $fieldspec :=   admin:database-included-element("http://myuri/namespace",
      "element-name", 1.0, "", "myAttribute", "some value")
      return
      admin:database-delete-field-included-element($config, $dbid,
           "myField", $fieldspec)
      (: 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.  :)
admin:database-delete-field-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $word-lexicons as element(db:word-lexicon)*
) as element(configuration)
Summary: This function deletes a word lexicon 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")`).
$field-name : The name of the field.
$word-lexicons : A word lexicon specification, typically the result of an `admin:database-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-word-lexicon("http://marklogic.com/collation/")
      return
      admin:database-delete-field-word-lexicon($config, $dbid, "myField", $lexspec)
      (: 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.  :)
admin:database-delete-fragment-parent(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $fragment-parents as element(db:fragment-parent)*
) as element(configuration)
Summary: This function deletes the specified fragment parent in 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")`).
$fragment-parents : A fragment parent specification, typically the result of an `admin:database-fragment-parent` call.
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("Documents")
      let $fragspec := admin:database-fragment-parent("my/namespace", "element-name")
      return
      admin:database-delete-fragment-parent($config, $dbid, $fragspec)
      (: 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.  :)
admin:database-delete-fragment-root(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $fragment-roots as element(db:fragment-root)*
) as element(configuration)
Summary: This function deletes the specified fragment root in 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")`).
$fragment-roots : A fragment root specification, typically the result of an `admin:database-fragment-root` call.
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("Documents")
      let $fragspec := admin:database-fragment-root("my/namespace", "element-name")
      return
      admin:database-delete-fragment-root($config, $dbid, $fragspec)
      (: 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.  :)
admin:database-delete-geospatial-element-attribute-pair-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $indexes as element(db:geospatial-element-attribute-pair-index)*
) as element(configuration)
Summary: This function deletes a geospatial element attribute pair index in 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")`).
$indexes : A geospatial element attribute pair index specification, typically the result of an `admin:database-geospatial-element-attribute-pair-index` call.
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 $geospec := admin:database-geospatial-element-attribute-pair-index(
    	  "/my/namespace", "elementname", "/my/namespace", "lat",
    	  "/my/namespace", "long", "wgs84", fn:false() )
      return
      admin:database-delete-geospatial-element-pair-index($config,
         xdmp:database("myDatabase"), $geospec)
      (: 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.  :)
admin:database-delete-geospatial-element-child-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-child-indexes as element(db:geospatial-element-child-index)*
) as element(configuration)
Summary: This function deletes a geospatial element child index for the specified database in 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")`).
$geospatial-element-child-indexes : A geospatial element child index specification, typically the result of an `admin:database-geospatial-element-child-index` call.
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("Documents")
      let $geospec := admin:database-geospatial-element-child-index("/my/namespace",
            "elementname", "/my/namespace", "child-element", "wgs84", fn:false() )
      return
      admin:database-delete-geospatial-element-child-index($config, $dbid, $geospec)
      (: 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.  :)
admin:database-delete-geospatial-element-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-indexes as element(db:geospatial-element-index)*
) as element(configuration)
Summary: This function deletes a geospatial element index for the specified database in 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")`).
$geospatial-element-indexes : A geospatial element index specification, typically the result of an `admin:database-geospatial-element-index` call.
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("Documents")
      let $geospec := admin:database-geospatial-element-index("/my/namespace",
                    "elementname", "wgs84", fn:false() )
      return
      admin:database-delete-geospatial-element-index($config, $dbid, $geospec)
      (: 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.  :)
admin:database-delete-geospatial-element-pair-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $geospatial-element-pair-indexes as element(db:geospatial-element-pair-index)*
) as element(configuration)
Summary: This function deletes a geospatial element pair index 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")`).
$geospatial-element-pair-indexes : A geospatial element pair index specification, typically the result of an `admin:database-geospatial-element-pair-index` call.
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 $geospec :=  admin:database-geospatial-element-pair-index("/my/namespace",
              "elementname", "/my/namespace", "lat",
    	  "/my/namespace", "long", "wgs84", fn:false() )
      return
      admin:database-delete-geospatial-element-pair-index($config,
         xdmp:database("myDatabase"), $geospec)
      (: 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.  :)
admin:database-delete-merge-blackout(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $blackouts as element(db:merge-blackout)*
) as element(configuration)
Summary: This function deletes a merge blackout specification for a database from a 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")`).
$blackouts : The merge blackout(s) to delete. Typically, the result of an `admin:database-get-merge-blackouts` call.
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("Documents")
      let $mergespec := admin:database-get-merge-blackouts($config,
            $dbid )
      return
      admin:database-delete-merge-blackout($config, $dbid, $mergespec)
      (: 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.  :)
admin:database-delete-phrase-around(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $phrase-arounds as element(db:phrase-around)*
) as element(configuration)
Summary: This function deletes a phrase around 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")`).
$phrase-arounds : A phrase specification, typically the result of an `admin:database-phrase-through` call.
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("Documents")
      let $paspec := admin:database-phrase-around("my/namepsace",
         "elementname" )
      return
      admin:database-delete-phrase-around($config, $dbid, $paspec)
      (: 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.  :)
admin:database-delete-phrase-through(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $phrase-throughs as element(db:phrase-through)*
) as element(configuration)
Summary: This function deletes a phrase through 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")`).
$phrase-throughs : A phrase through specification, typically the result of an `admin:database-phrase-through` call.
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("Documents")
      let $ptspec := admin:database-phrase-through("my/namepsace",
         "elementname" )
      return
      admin:database-delete-phrase-through($config, $dbid, $ptspec)
      (: 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.  :)
admin:database-delete-range-element-attribute-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $attribute-indexes as element(db:range-element-attribute-index)*
) as element(configuration)
Summary: This function deletes a range element attribute index for the specified database in 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")`).
$attribute-indexes : An element attribute range index specification, typically the result of an `admin:database-range-element-attribute-index` call.
Usage Notes: Note that the index specification to delete must exist in the configuration exactly as specified, even if the specification includes multiple QNames. If you have a range index configuration that specifies multiple QNames in a single entry, then if you want to delete the index for only one of the QNames, you must first delete the range index specification with multiple QNames and then add the indexes that you do not want to delete. To see the specifications as they are stored in the configuration, use `admin:database-get-range-element-attribute-index`.
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("Documents")
      let $rangespec := admin:database-range-element-attribute-index("string",
          "/my/namespace", "elementname", "", "myAttribute",
          "http://marklogic.com/collation/", fn:false() )
      return
      admin:database-delete-range-element-attribute-index($config, $dbid, $rangespec)
      (: 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.  :)
admin:database-delete-range-element-index(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $range-indexes as element(db:range-element-index)*
) as element(configuration)
Summary: This function deletes a range element index for the specified database in 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")`).
$range-indexes : An element range index specification, typically the result of an `admin:database-range-element-index` call.
Usage Notes: Note that the index specification to delete must exist in the configuration exactly as specified, even if the specification includes multiple QNames. If you have a range index configuration that specifies multiple QNames in a single entry, then if you want to delete the index for only one of the QNames, you must first delete the range index specification with multiple QNames and then add the indexes that you do not want to delete. To see the specifications as they are stored in the configuration, use `admin:database-get-range-element-index`.
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("Documents")
      let $rangespec := admin:database-range-element-index("string", "/my/namespace",
                    "elementname", "http://marklogic.com/collation/",
    		fn:false() )
      return
      admin:database-delete-range-element-index($config, $dbid, $rangespec)
      (: 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.  :)
admin:database-delete-word-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $word-lexicons as element(db:word-lexicon)*
) as element(configuration)
Summary: This function deletes a word lexicon 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")`).
$word-lexicons : A word lexicon specification, typically the result of an `admin:database-word-lexicon` call.
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("Documents")
      let $lexspec := admin:database-word-lexicon("http://marklogic.com/collation/")
      return
      admin:database-delete-word-lexicon($config, $dbid, $lexspec)
      (: 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.  :)
admin:database-delete-word-query-excluded-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $excluded-elements as element(db:excluded-element)*
) as element(configuration)
Summary: This function deletes the word query excluded element specification in 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")`).
$excluded-elements : The excluded elements specification, typically the result of an `admin:database-excluded-element` call.
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")
      let $wqspec := admin:database-excluded-element("http://myuri/namespace",
    	"element-name")
      return
      admin:database-delete-word-query-excluded-element($config, $dbid, $wqspec)
      (: 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.  :)
admin:database-delete-word-query-included-element(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $included-elements as element(db:included-element)*
) as element(configuration)
Summary: This function deletes the word query included element specification in 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")`).
$included-elements : The included elements specification, typically the result of an `admin:database-included-element` call.
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")
      let $wqspec :=   admin:database-included-element("http://myuri/namespace",
      "element-name", 1.0, "", "myAttribute", "some value")
      return
      admin:database-delete-word-query-included-element($config, $dbid, $wqspec)
      (: 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.  :)
admin:database-detach-forest(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $forest-id as xs:unsignedLong
) as element(configuration)
Summary: This function detaches the specified forest from the specified database.
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")`).
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
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-detach-forest($config, xdmp:database("myDatabase"),
          xdmp:forest("myForest") )
admin:database-element-attribute-word-lexicon(
| $parent-namespace as xs:string?,
| $parent-localname as xs:string,
| $namespace as xs:string?,
| $localname as xs:string,
| $collation as xs:string
) as element(db:element-attribute-word-lexicon)
Summary: This function constructs an element attribute word lexicon specification.
Parameters:
$parent-namespace : The namespace of the parent element for the attribute.
$parent-localname : The local name of the parent element for the attribute.
$namespace : The namespace URI.
$localname : The local name for the node.
$collation : The collation URI (for example, `http://marklogic.com/collation/`.
Example:
      xquery version "1.0-ml";

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

      admin:database-element-attribute-word-lexicon("my/namepsace", "elementname",
    	"", "myAttribute", "http://marklogic.com/collation/" )
      (: returns the element attribute word lexicon specification :)
admin:database-element-word-lexicon(
| $namespace as xs:string?,
| $localname as xs:string,
| $collation as xs:string
) as element(db:element-word-lexicon)
Summary: This function constructs an element word lexicon specification.
Parameters:
$namespace : The namespace URI.
$localname : The local name for the node.
$collation : The collation URI (for example, `http://marklogic.com/collation/`).
Example:
      xquery version "1.0-ml";

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

      admin:database-element-word-lexicon("my/namepsace", "elementname",
    	"http://marklogic.com/collation/" )
      (: returns the element word lexicon specification :)
admin:database-element-word-query-through(
| $namespace as xs:string?,
| $localname as xs:string
) as element(db:element-word-query-through)
Summary: This function constructs an element word query through specification.
Parameters:
$namespace : The namespace URI.
$localname : The local name for the node.
Example:
      xquery version "1.0-ml";

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

      admin:database-element-word-query-through("my/namepsace", "elementname" )
      (: returns the element word query through specification :)
admin:database-excluded-element(
| $namespace as xs:string?,
| $localname as xs:string
) as element(db:excluded-element)
Summary: This function constructs an excluded element specification.
Parameters:
$namespace : The namespace URI. Specify an empty string if the element is in no namespace.
$localname : The local name for the node.
Example:
      xquery version "1.0-ml";

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

      admin:database-excluded-element("http://myuri/namespace",
    	"element-name")
      (: the constructed element :)
admin:database-exists(
| $config as element(configuration),
| $database-name as xs:string
) as xs:boolean
Summary: This function determines whether or not the specified database exists. Returns `true` if the database exists, otherwise `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$database-name : The name of the database to check.
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-exists($config, "Documents")

      (: Returns true if the Documents database exists. :)
admin:database-field(
| $field-name as xs:string,
| $include-root as xs:boolean
) as element(db:field)
Summary: This function constructs a field specification.
Parameters:
$field-name : The name of the field.
$include-root : A boolean value, true to start including at the root, false to not include until an included element is reached.
Example:
      xquery version "1.0-ml";

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

      admin:database-field("myField", fn:true() )
      (: the constructed element :)
admin:database-fragment-parent(
| $namespace as xs:string?,
| $localname as xs:string
) as element(db:fragment-parent)
Summary: This function constructs a fragment parent specification.
Parameters:
$namespace : The namespace URI. Specify an empty string if the element is in no namespace.
$localname : The local name for the node.
Example:
      xquery version "1.0-ml";

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

      let $namespace := "my/namespace"
      let $localname := "some-element-name"
      return
      admin:database-fragment-parent($namespace, $localname )
      (: returns the fragments parent specification :)
admin:database-fragment-root(
| $namespace as xs:string?,
| $localname as xs:string
) as element(db:fragment-root)
Summary: This function constructs a fragment root specification.
Parameters:
$namespace : The namespace URI. Specify an empty string if the element is in no namespace.
$localname : The local name for the node.
Example:
      xquery version "1.0-ml";

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

      let $namespace := "my/namespace"
      let $localname := "some-element-name"
      return
      admin:database-fragment-root($namespace, $localname )
      (: returns the fragments root specification :)
admin:database-geospatial-element-attribute-pair-index(
| $parent-namespace as xs:string?,
| $parent-localname as xs:string,
| $latitude-namespace as xs:string?,
| $latitude-localname as xs:string,
| $longitude-namespace as xs:string?,
| $longitude-localname as xs:string,
| $coordinate-system as xs:string,
| $range-value-positions as xs:boolean
) as element(db:geospatial-element-attribute-pair-index)
Summary: This function constructs a geospatial element attribute pair index specification.
Parameters:
$parent-namespace : The namespace of the parent element for the attribute.
$parent-localname : The local name of the parent element for the attribute.
$latitude-namespace : The namespace for the element containing the latitude.
$latitude-localname : The local name for the element containing the latitude.
$longitude-namespace : The namespace for the element containing the longitude.
$longitude-localname : The local name for the element containing the longitude.
$coordinate-system : The coordinate system. Must be one of `wgs84` or `raw`.
$range-value-positions : A boolean specifying whether to maintain value postions in this index (used with co-occurrences).
Example:
      xquery version "1.0-ml";

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

      admin:database-geospatial-element-attribute-pair-index("/my/namespace",
              "elementname", "/my/namespace", "lat",
              "/my/namespace", "long", "wgs84", fn:false() )
      (: returns the geospatial element attribute pair index specification :)
admin:database-geospatial-element-child-index(
| $parent-namespace as xs:string?,
| $parent-localname as xs:string,
| $namespace as xs:string?,
| $localname as xs:string,
| $coordinate-system as xs:string,
| $range-value-positions as xs:boolean,
| [$point-format as xs:string]
) as element(db:geospatial-element-child-index)
Summary: This function constructs a geospatial element child index specification.
Parameters:
$parent-namespace : The namespace of the parent element for the attribute.
$parent-localname : The local name of the parent element for the attribute.
$namespace : The namespace URI. Specify an empty string if the element is in no namespace.
$localname : The local name for the node.
$coordinate-system : The coordinate system. Must be one of `wgs84` or `raw`.
$range-value-positions : A boolean specifying whether to maintain value postions in this index (used with co-occurrences).
$point-format (optional): The point format in the data: "point" means latitude precedes longitude (this is the default); "long-lat-point" means longitude precedes latitude. To use the default value of "point", simply omit this parameter. Do not specify an empty string.
Example:
      xquery version "1.0-ml";

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

      admin:database-geospatial-element-child-index(
            "/my/namespace",
            "elementname",
    	"/my/namespace",
    	"child-element",
            "wgs84",
    	fn:false() )

      (: returns the geospatial element child index specification :)
admin:database-geospatial-element-index(
| $namespace as xs:string?,
| $localname as xs:string,
| $coordinate-system as xs:string,
| $range-value-positions as xs:boolean,
| [$point-format as xs:string]
) as element(db:geospatial-element-index)
Summary: This function constructs a geospatial element index specification.
Parameters:
$namespace : The namespace URI.
$localname : The local name for the node.
$coordinate-system : The coordinate system. Must be one of `wgs84` or `raw`.
$range-value-positions : A boolean specifying whether to maintain value postions in this index (used with co-occurrences).
$point-format (optional): The point format in the data: "point" means latitude precedes longitude (this is the default); "long-lat-point" means longitude precedes latitude. To use the default value of "point", simply omit this parameter. Do not specify an empty string.
Example:
      xquery version "1.0-ml";

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

      admin:database-geospatial-element-index(
               "/my/namespace",
               "elementname",
    	   "wgs84",
    	   fn:false(),
    	   "long-lat-point" )

      (: returns the geospatial element index specification :)
admin:database-geospatial-element-pair-index(
| $parent-namespace as xs:string?,
| $parent-localname as xs:string,
| $latitude-namespace as xs:string?,
| $latitude-localname as xs:string,
| $longitude-namespace as xs:string?,
| $longitude-localname as xs:string,
| $coordinate-system as xs:string,
| $range-value-positions as xs:boolean
) as element(db:geospatial-element-pair-index)
Summary: This function constructs a geospatial element pair index specification.
Parameters:
$parent-namespace : The namespace of the parent element for the attribute.
$parent-localname : The local name of the parent element for the attribute.
$latitude-namespace : The namespace for the element containing the latitude.
$latitude-localname : The local name for the element containing the latitude.
$longitude-namespace : The namespace for the element containing the longitude.
$longitude-localname : The local name for the element containing the longitude.
$coordinate-system : The coordinate system. Must be one of `wgs84` or `raw`.
$range-value-positions : A boolean specifying whether to maintain value postions in this index (used with co-occurrences).
Example:
      xquery version "1.0-ml";

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

      admin:database-geospatial-element-pair-index("/my/namespace",
              "elementname", "/my/namespace", "lat",
              "/my/namespace", "long", "wgs84", fn:false() )
      (: returns the geospatial element pair index specification :)
admin:database-get-attached-forests(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the attached forest IDs 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")`).
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-attached-forests($config, xdmp:database("myDatabase"))
      (: returns the IDs of the attached forests :)
admin:database-get-attribute-value-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the attribute value positions 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")`).
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-attribute-value-positions($config,
            xdmp:database("myDatabase"))
      (: returns the attribute value positions setting :)
admin:database-get-backups(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:database-backup)*
Summary: This function returns the scheduled backups 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")`).
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-backups($config, xdmp:database("mydatabase") )
      (: returns the scheduled backups for the database :)
admin:database-get-collection-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the collection lexicon 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")`).
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-collection-lexicon($config, xdmp:database("myDatabase"))
      (: returns the collection lexicon setting :)
admin:database-get-directory-creation(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the directory creation 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")`).
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-directory-creation($config, xdmp:database("myDatabase"))
      (: returns the directory creation setting :)
admin:database-get-element-attribute-word-lexicons(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:element-attribute-word-lexicon)*
Summary: This function returns the element attribute word lexicons specification(s) 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")`).
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-element-attribute-word-lexicons($config,
            xdmp:database("myDatabase") )
      (: returns the element attribute word lexicon specifications for the database :)
admin:database-get-element-value-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the element value positions 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")`).
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-element-value-positions($config,
            xdmp:database("myDatabase"))
      (: returns the element value positions setting :)
admin:database-get-element-word-lexicons(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:element-word-lexicon)*
Summary: This function returns the element word lexicons specification(s) 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")`).
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-element-word-lexicons($config, xdmp:database("myDatabase") )
      (: returns the element word lexicon specifications for the database :)
admin:database-get-element-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the element word positions 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")`).
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-element-word-postions($config, xdmp:database("myDatabase"))
      (: returns the element word positions setting :)
admin:database-get-element-word-query-throughs(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:element-word-query-through)*
Summary: This function returns the element word query throughs specification(s) 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")`).
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-element-word-query-throughs($config,
            xdmp:database("myDatabase") )
      (: returns the element word query through specifications for the database :)
admin:database-get-enabled(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the enabled value 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")`).
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-enabled($config, xdmp:database("myDatabase"))
      (: returns the enabled setting :)
admin:database-get-expunge-locks(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the expunge locks 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")`).
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-expunge-locks($config, xdmp:database("myDatabase"))
      (: returns the expunge-locks setting :)
admin:database-get-fast-case-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast case sensitive searches 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")`).
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-fast-case-sensitive-searches($config, xdmp:database("myDatabase"))
      (: returns the fast case sensitive searches setting :)
admin:database-get-fast-diacritic-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast diacritic sensitive searches 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")`).
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-fast-diacritic-sensitive-searches($config,
          xdmp:database("myDatabase"))
      (: returns the fast diacritic sensitive searches setting :)
admin:database-get-fast-element-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast element character searches 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")`).
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-fast-element-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the fast element character searches setting :)
admin:database-get-fast-element-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast element phrase searches 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")`).
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-fast-element-phrase-searches($config,
           xdmp:database("myDatabase"))
      (: returns the fast element phrase searches setting :)
admin:database-get-fast-element-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the trailing wildcard searches 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")`).
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-fast-element-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"))
      (: returns the fast element trailing wildcard searches setting :)
admin:database-get-fast-element-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast element word searches 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")`).
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-fast-element-word-searches($config,
           xdmp:database("myDatabase"))
      (: returns the element word searches setting :)
admin:database-get-fast-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast phrase searches 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")`).
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-fast-phrase-searches($config, xdmp:database("myDatabase"))
      (: returns the fast phrase searches setting :)
admin:database-get-fast-reverse-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the fast reverse searches 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")`).
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-fast-reverse-searches($config, xdmp:database("myDatabase"))
      (: returns the stemmed searches setting :)
admin:database-get-field(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as element(db:field)
Summary: This function returns the field specification 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")`).
$field-name : The name of the field.
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-field($config,
          xdmp:database("myDatabase"), "myField")
      (: returns the field settings :)
admin:database-get-field-excluded-elements(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as element(db:excluded-element)*
Summary: This function returns the field excluded elements specification 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")`).
$field-name : The name of the field.
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-field-excluded-elements($config,
          xdmp:database("myDatabase"), "myField")
      (: returns the field settings :)
admin:database-get-field-fast-case-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the fast case sensitive searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-fast-case-sensitive-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-fast-diacritic-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the fast diacritic sensitive searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-fast-diacritic-sensitive-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-fast-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the fast phrase searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-fast-phrase-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-include-document-root(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean
Summary: This function returns the field include document root setting for the specified field 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")`).
$field-name : The name of the field.
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-field-include-document-root($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-included-elements(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as element(db:included-element)*
Summary: This function returns the fields included elements specification 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")`).
$field-name : The name of the field.
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-field-included-elements($config,
          xdmp:database("myDatabase"), "myField")
      (: returns the field settings :)
admin:database-get-field-one-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the one character searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-one-character-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-stemmed-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:string?
Summary: This function returns stemmed searches setting for the specified field if configured. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-stemmed-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the word query stemmed searches setting :)
admin:database-get-field-three-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the three character searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-three-character-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-three-character-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the three character word positions setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-three-character-word-positions($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the trailing wildcard searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-trailing-wildcard-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the trailing wildcard word positions setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-wildcard-word-positions($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-two-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the two character searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-two-character-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-field-word-lexicons(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as element(db:word-lexicon)*
Summary: This function returns the word lexicons specification(s) 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")`).
$field-name : The name of the field.
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-field-word-lexicons($config, xdmp:database("myDatabase"),
        "myField")
      (: returns the word lexicon specifications for the database's field :)
admin:database-get-field-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string
) as xs:boolean?
Summary: This function returns true if the word searches setting for the specified field is enabled. Otherwise, it returns the empty sequence.
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")`).
$field-name : The name of the field.
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-field-word-searches($config,
            xdmp:database("myDatabase"), "myField")
      (: returns the setting :)
admin:database-get-fields(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:field)*
Summary: This function returns the fields specification(s) 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")`).
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-fields($config, xdmp:database("myDatabase"))
      (: returns the field settings :)
admin:database-get-format-compatibility(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the format compatibility 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")`).
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-format-compatibility($config, xdmp:database("myDatabase"))
      (: returns the format compatibility setting :)
admin:database-get-fragment-parents(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:fragment-parent)*
Summary: This function returns the fragment parents specification 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")`).
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-fragment-parents($config, xdmp:database("myDatabase") )
      (: returns the fragments parent specifications for the database :)
admin:database-get-fragment-roots(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:fragment-root)*
Summary: This function returns the fragment roots specification 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")`).
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-fragment-roots($config, xdmp:database("myDatabase") )
      (: returns the fragments root specifications for the database :)
admin:database-get-geospatial-element-attribute-pair-indexes(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:geospatial-element-attribute-pair-index)*
Summary: This function returns the geospatial element attribute pair indexes specification(s) 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")`).
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-geospatial-element-attribute-pair-indexes($config,
            xdmp:database("myDatabase") )
      (: returns the geospatial element attribute pair index specifications for the database :)
admin:database-get-geospatial-element-child-indexes(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:geospatial-element-child-index)*
Summary: This function returns the geospatial element child indexes specification(s) 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")`).
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-geospatial-element-child-indexes($config,
            xdmp:database("myDatabase") )
      (: returns the geospatial element child index specifications for the database :)
admin:database-get-geospatial-element-indexes(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:geospatial-element-index)*
Summary: This function returns the geospatial element indexes specification(s) 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")`).
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-geospatial-element-indexes($config,
            xdmp:database("myDatabase") )
      (: returns the geospatial index specifications for the database :)
admin:database-get-geospatial-element-pair-indexes(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:geospatial-element-pair-index)*
Summary: This function returns the geospatial element pair indexes specification(s) 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")`).
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-geospatial-element-pair-indexes($config,
           xdmp:database("myDatabase"))
      (: returns the specification :)
admin:database-get-id(
| $config as element(configuration),
| $database-name as xs:string
) as xs:unsignedLong
Summary: This function returns the ID for the specified database from the configuration. The difference between this function and `xdmp:database()` is that the ID from this function can come from a database that has not yet been saved (that is, from a database that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files). This ID enables you to completely configure a newly created database without the need to first save the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$database-name : The name of the database.
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 $config := admin:database-create($config, "myNewDatabase",
                      xdmp:database("Security"), xdmp:database("Schemas"))
      let $databaseID := admin:database-get-id($config, "myNewDatabase")
      let $fieldspec := admin:database-field("myField", fn:true() )
      let $config := admin:database-add-field($config, $databaseID, $fieldspec)

      return
          admin:database-attach-forest($config, $databaseID,
              xdmp:forest("newForest") )

      (: Attaches "newForest" and adds the field, "myField" to the newly created
         database, "myNewDatabase" :)
admin:database-get-in-memory-limit(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the in memory limit 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")`).
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-in-memory-limit($config, xdmp:database("myDatabase"))
      (: returns the in memory limit setting :)
admin:database-get-in-memory-list-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the in memory list size 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")`).
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-in-memory-list-size($config, xdmp:database("myDatabase"))
      (: returns the in memory list size setting :)
admin:database-get-in-memory-range-index-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the in memory range index size 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")`).
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-in-memory-range-index-size($config,
            xdmp:database("myDatabase"))
      (: returns the in memory range index size setting :)
admin:database-get-in-memory-reverse-index-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the in memory reverse index size 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")`).
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-in-memory-reverse-index-size($config,
            xdmp:database("myDatabase"))
      (: returns the in memory reverse index size setting :)
admin:database-get-in-memory-tree-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the in memory tree size 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")`).
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-in-memory-tree-size($config, xdmp:database("myDatabase"))
      (: returns the in memory tree size setting :)
admin:database-get-index-detection(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the index detection 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")`).
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-index-detection($config, xdmp:database("myDatabase"))
      (: returns the index detection setting :)
admin:database-get-inherit-collections(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the inherit collections 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")`).
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-inherit-collections($config, xdmp:database("myDatabase"))
      (: returns the inherit collections setting :)
admin:database-get-inherit-permissions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the inherit positions 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")`).
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-inherit-permissions($config, xdmp:database("myDatabase"))
      (: returns the inherit permissions setting :)
admin:database-get-inherit-quality(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the inherit quality 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")`).
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-inherit-quality($config, xdmp:database("myDatabase"))
      (: returns the inherit quality setting :)
admin:database-get-journal-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the journal size 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")`).
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-journal-size($config, xdmp:database("myDatabase"))
      (: returns the journal size setting :)
admin:database-get-journaling(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the journaling setting for the specified database in the configuration. When set to `strict`, the journal protects against MarkLogic Server process failures, host operating system kernel failures, and host hardware failures. When set to `fast`, the journal protects against MarkLogic Server process failures but not against host operating system kernel failures or host hardware failures. When set to `off`, the journal does not protect against MarkLogic Server process failures, host operating system kernel failures, or host hardware failures.
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")`).
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-journaling($config, xdmp:database("myDatabase"))
      (: returns the journaling setting :)
admin:database-get-language(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the language 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")`).
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-language($config, xdmp:database("myDatabase"))
      (: returns the language setting :)
admin:database-get-locking(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the locking setting for the specified database in the configuration. When set to `strict`, locking enforces mutual exclusion on existing documents and on new documents. When set to `fast`, locking enforces mutual exclusion on existing documents but not on new documents. When set to `off`, locking does not enforce mutual exclusion on existing documents or on new documents.
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")`).
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-locking($config, xdmp:database("myDatabase"))
      (: returns the locking setting :)
admin:database-get-maintain-directory-last-modified(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the maintain directory last modified 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")`).
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-maintain-directory-last-modified($config, xdmp:database("myDatabase"))
      (: returns the maintain directory last modified setting :)
admin:database-get-maintain-last-modified(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the maintain last modified 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")`).
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-maintain-last-modified($config, xdmp:database("myDatabase"))
      (: returns the maintain last modified setting :)
admin:database-get-merge-blackouts(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:merge-blackout)*
Summary: This function returns the merge blackouts specification 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")`).
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-merge-blackouts($config, xdmp:database("myDatabase") )
      (: returns the merge-blackouts specification for the database :)
admin:database-get-merge-enable(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the merge enable 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")`).
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-merge-enable($config, xdmp:database("myDatabase"))
      (: returns the merge enable setting :)
admin:database-get-merge-max-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the merge max size 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")`).
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-merge-max-size($config, xdmp:database("myDatabase"))
      (: returns the merge max size setting :)
admin:database-get-merge-min-ratio(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the merge min ratio 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")`).
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-merge-min-ratio($config, xdmp:database("myDatabase"))
      (: returns the merge min ratio setting :)
admin:database-get-merge-min-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the merge min size 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")`).
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-merge-min-size($config, xdmp:database("myDatabase"))
      (: returns the merge min size setting :)
admin:database-get-merge-priority(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the CPU scheduler priority for merges 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")`).
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-merge-priority($config, xdmp:database("myDatabase"))
      (: returns the merge priority setting :)
admin:database-get-merge-timestamp(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the merge timestamp 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")`).
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-merge-timestamp($config, xdmp:database("myDatabase"))
      (: returns the merge timestamp setting :)
admin:database-get-name(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name 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")`).
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-name($config, xdmp:database("myDatabase"))
      (: returns the name setting :)
admin:database-get-one-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the one character searches 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")`).
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-one-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the one character searches setting :)
admin:database-get-phrase-arounds(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:phrase-around)*
Summary: This function returns the phrase arounds specification(s) 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")`).
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-phrase-arounds($config,
            xdmp:database("myDatabase") )
      (: returns the phrase arounds specifications for the database :)
admin:database-get-phrase-throughs(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:phrase-through)*
Summary: This function returns the phrase throughs specification(s) 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")`).
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-phrase-throughs($config,
            xdmp:database("myDatabase") )
      (: returns the phrase through specifications for the database :)
admin:database-get-positions-list-max-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the positions list max size 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")`).
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-positions-list-max-size($config,
            xdmp:database("myDatabase"))
      (: returns the in positions list max size setting :)
admin:database-get-preallocate-journals(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the preallocate journals 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")`).
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-preallocate-journals($config, xdmp:database("myDatabase"))
      (: returns the preallocate journals setting :)
admin:database-get-preload-mapped-data(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the preload 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")`).
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-mapped-data($config, xdmp:database("myDatabase"))
      (: returns the preload mapped data setting :)
admin:database-get-range-element-attribute-indexes(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:range-element-attribute-index)*
Summary: This function returns the range element attribute indexes specification(s) 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")`).
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-range-element-attribute-indexes($config,
            xdmp:database("myDatabase") )
      (: returns the range element attribute index specifications for the database :)
admin:database-get-range-element-indexes(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:range-element-index)*
Summary: This function returns the range element indexes specification(s) 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")`).
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-range-element-indexes($config, xdmp:database("myDatabase") )
      (: returns the range index specifications for the database :)
admin:database-get-range-index-optimize(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the range index optimize setting for the specified database from the configuration. When set to `facet-time`, range indexes are optimized to minimize the amount of CPU time used. When set to `memory-size`, range indexes are optimized to minimize the amount of memory used.
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")`).
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-range-index-optimize($config, xdmp:database("myDatabase"))
      (: returns the range index optimize setting :)
admin:database-get-reindexer-enable(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the reindexer enable 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")`).
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-reindexer-enable($config, xdmp:database("myDatabase"))
      (: returns the reindexer enable setting :)
admin:database-get-reindexer-throttle(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the reindexer throttle 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")`).
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-reindexer-throttle($config, xdmp:database("myDatabase"))
      (: returns the reindexer throttle setting :)
admin:database-get-reindexer-timestamp(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the reindexer timestamp 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")`).
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-reindexer-timestamp($config, xdmp:database("myDatabase"))
      (: returns the reindexer timestamp setting :)
admin:database-get-schema-database(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the schema database 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")`).
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-schema-database($config, xdmp:database("myDatabase"))
      (: returns the ID of the schema database :)
admin:database-get-security-database(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the security database 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")`).
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-security-database($config, xdmp:database("myDatabase"))
      (: returns the ID of the security database :)
admin:database-get-stemmed-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the stemmed searches 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")`).
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-stemmed-searches($config, xdmp:database("myDatabase"))
      (: returns the stemmed searches setting :)
admin:database-get-tf-normalization(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string
Summary: This function returns the current term-frequency normalization setting for the database. The returned value is either (`scaled-log`), which means to scale the term frequency based on the size of the document, or `unscaled-log`, which means to use term frequency as a function of the actual term frequency in a document, regardless of the document size.
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")`).
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 $db := admin:database-get-id($config, "myDatabase")

      return
          admin:database-get-tf-normalization($config, $db)

      (: Returns the term-frequency normalization setting for the database, "myDatabase." :)
admin:database-get-three-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the three character searches 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")`).
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-three-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the three character searches setting :)
admin:database-get-three-character-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the three character word positions 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")`).
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-three-character-word-positions($config,
            xdmp:database("myDatabase"))
      (: returns the three character word positions setting :)
admin:database-get-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the trailing wildcard searches 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")`).
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-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"))
      (: returns the trailing wildcard searches setting :)
admin:database-get-trailing-wildcard-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the trailing wildcard word positions 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")`).
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-trailing-wildcard-word-positions($config,
            xdmp:database("myDatabase"))
      (: returns the trailing wildcard word positions setting :)
admin:database-get-triggers-database(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the triggers database 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")`).
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-triggers-database($config, xdmp:database("myDatabase"))
      (: returns the ID of the triggers database :)
admin:database-get-two-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the two character searches 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")`).
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-two-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the two character searches setting :)
admin:database-get-uri-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the URI lexicon 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")`).
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-uri-lexicon($config, xdmp:database("myDatabase"))
      (: returns the uri lexicon setting :)
admin:database-get-word-lexicons(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:word-lexicon)*
Summary: This function returns the word lexicons specification(s) 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")`).
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-word-lexicons($config, xdmp:database("myDatabase") )
      (: returns the word lexicon specifications for the database :)
admin:database-get-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the word positions 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")`).
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-word-positions($config, xdmp:database("myDatabase"))
      (: returns the word positions setting :)
admin:database-get-word-query-excluded-elements(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:excluded-element)*
Summary: This function returns the word query excluded elements 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")`).
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-word-query-excluded-elements($config,
            xdmp:database("myDatabase"))
      (: returns the excluded elements specifications from the configuration :)
admin:database-get-word-query-fast-case-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query fast case sensitive searches setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions. An empty return value means the option is not set (false).
$database-id : The id of the database (for example, `xdmp:database("myDatabase")`).
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-word-query-fast-case-sensitive-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query fast case sensitive searches setting :)
admin:database-get-word-query-fast-diacritic-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query fast diacritic sensitive searches setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-fast-diacritic-sensitive-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query fast iacritic sensitive searches setting :)
admin:database-get-word-query-fast-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query fast phrase searches setting for the specified database is set in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-fast-phrase-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query fast phrase searches setting :)
admin:database-get-word-query-include-document-root(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the word query include document root 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")`).
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-word-query-include-document-root($config,
            xdmp:database("myDatabase"))
      (: returns the word query include document root setting :)
admin:database-get-word-query-included-elements(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as element(db:included-element)*
Summary: This function returns the word query included elements 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")`).
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-word-query-included-elements($config,
            xdmp:database("myDatabase"))
      (: returns the included elements specifications from the configuration :)
admin:database-get-word-query-one-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query one character searches setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-one-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query one character searches setting :)
admin:database-get-word-query-stemmed-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:string?
Summary: This function returns the reindexer word query stemmed searches 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")`).
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-word-query-stemmed-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query stemmed searches setting :)
admin:database-get-word-query-three-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query three character searches setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-three-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query three character searches setting :)
admin:database-get-word-query-three-character-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query three character word positions setting is enabled for the specified database from the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-three-character-word-positions($config,
            xdmp:database("myDatabase"))
      (: returns the word query three character word positions setting :)
admin:database-get-word-query-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query trailing wildcard searches setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query trailing wildcard searches setting :)
admin:database-get-word-query-trailing-wildcard-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query trailing wildcard word positions setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-trailing-wildcard-word-positions($config,
            xdmp:database("myDatabase"))
      (: returns the word query trailing wildcard word positions setting :)
admin:database-get-word-query-two-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query two character searches setting is enabled for the specified database in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-two-character-searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query two character searches setting :)
admin:database-get-word-query-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean?
Summary: This function returns true if the word query searches setting for the specified database is enabled in the configuration. Otherwise, it returns the empty sequence.
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")`).
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-word-query-word searches($config,
            xdmp:database("myDatabase"))
      (: returns the word query word searches setting :)
admin:database-get-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the word searches 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")`).
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-word-searches($config, xdmp:database("myDatabase"))
      (: returns the word searches setting :)
admin:database-hourly-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $start-minute as xs:nonNegativeInteger,
| $max-backups as xs:unsignedLong,
| $backup-security-db as xs:boolean,
| $backup-schemas-db as xs:boolean,
| $backup-triggers-db as xs:boolean,
| [$include-replicas as xs:boolean]
) as element(db:database-backup)
Summary: This function constructs a hourly scheduled database backup.
Parameters:
$backup-dir : The directory to save the backup.
$backup-period : The number of hours to elapse between each backup.
$start-minute : The number of minutes after the hour to start the backup. Note that this setting does not add to the backup period value.
$max-backups : The maximum number of backups to keep. When you reach the specified maximum number of backups, the next backup will delete the oldest backup. Specify 0 to keep an unlimited number of backups.
$backup-security-db : Whether to backup the security database alongside the current backup.
$backup-schemas-db : Whether to backup the schemas database alongside the current backup.
$backup-triggers-db : Whether to backup the triggers database alongside the current backup.
$include-replicas (optional): If set to `false`, do not include the replicas in the backup. The default is `true`, which means to include all replicas in the backup.
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-hourly-backup("/backup-dir", 2,
          30, 10, true(), true(), true())

      (: Returns the hourly database backup specification. For example, if the current
         time is 2:15pm, the backup will run at 4:30pm, 6:30pm, 8:30pm, and so on. :)
admin:database-included-element(
| $namespace as xs:string?,
| $localname as xs:string,
| $weight as xs:double,
| $attribute-namespace as xs:string?,
| $attribute-localname as xs:string,
| $attribute-value as xs:string
) as element(db:included-element)
Summary: This function constructs an included element specification.
Parameters:
$namespace : The namespace URI. Specify an empty string if the element is in no namespace.
$localname : The local name for the node.
$weight : The query weight to use in relavance calculations.
$attribute-namespace : The namespace for the attribute to constrain on. Specify an empty string if there is no attribute to constrain on or if the attribute is in no namespace.
$attribute-localname : The local name of the attribute to constrain on. Specify an empty string if there is no attribute to constrain on.
$attribute-value : The value for the attribute to constrain on (only attributes with this value). Specify an empty string if there is no attribute to constrain on.
Example:
      xquery version "1.0-ml";

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

      admin:database-included-element("http://myuri/namespace",
    	"element-name", 1.0, "", "myAttribute", "some value")
      (: the constructed element :)
admin:database-minutely-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $max-backups as xs:unsignedLong,
| $backup-security-db as xs:boolean,
| $backup-schemas-db as xs:boolean,
| $backup-triggers-db as xs:boolean,
| [$include-replicas as xs:boolean]
) as element(db:database-backup)
Summary: This function constructs a scheduled database backup on a number-of-minutes basis.
Parameters:
$backup-dir : The directory to save the backup.
$backup-period : The number of minutes to elapse between each backup.
$max-backups : The maximum number of backups to keep. When you reach the specified maximum number of backups, the next backup will delete the oldest backup. Specify 0 to keep an unlimited number of backups.
$backup-security-db : Whether to backup the security database alongside the current backup.
$backup-schemas-db : Whether to backup the schemas database alongside the current backup.
$backup-triggers-db : Whether to backup the triggers database alongside the current backup.
$include-replicas (optional): If set to `false`, do not include the replicas in the backup. The default is `true`, which means to include all replicas in the backup.
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-minutely-backup("/backup-dir", 45,
          10, true(), true(), true())

      (: Returns the minutely database backup specification. :)
admin:database-monthly-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $backup-month-day as xs:unsignedLong,
| $start-time as xs:time,
| $max-backups as xs:unsignedLong,
| $backup-security-db as xs:boolean,
| $backup-schemas-db as xs:boolean,
| $backup-triggers-db as xs:boolean,
| [$include-replicas as xs:boolean]
) as element(db:database-backup)
Summary: This function constructs a monthly scheduled backup.
Parameters:
$backup-dir : The directory where the backup will be saved to.
$backup-period : The number of months to elapse between each backup.
$backup-month-day : The day of the month the backup will happen (between 1 and 31)
$start-time : A time for the scheduled backup to start.
$max-backups : The maximum number of backups to keep in the backup directory.
$backup-security-db : Whether to backup the security database alongside the current backup.
$backup-schemas-db : Whether to backup the schemas database alongside the current backup.
$backup-triggers-db : Whether to backup the triggers database alongside the current backup.
$include-replicas (optional): If set to `false`, do not include the replicas in the backup. The default is `true`, which means to include all replicas in the backup.
Example:
      xquery version "1.0-ml";

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

      admin:database-monthly-backup("/backup-dir", 2, 1,
            xs:time("09:45:00"),10,true(),true(),true())
      (: returns the monthly backup specification :)
admin:database-one-time-backup(
| $backup-dir as xs:string,
| $start as xs:dateTime,
| $max-backups as xs:unsignedLong,
| $backup-security-db as xs:boolean,
| $backup-schemas-db as xs:boolean,
| $backup-triggers-db as xs:boolean,
| [$include-replicas as xs:boolean]
) as element(db:database-backup)
Summary: This function constructs a one-time backup.
Parameters:
$backup-dir : The directory where the backup will be saved to.
$start : The starting dateTime of the scheduled backup.
$max-backups : The maximum number of backups to keep in the backup directory.
$backup-security-db : Whether to backup the security database alongside the current backup.
$backup-schemas-db : Whether to backup the schemas database alongside the current backup.
$backup-triggers-db : Whether to backup the triggers database alongside the current backup.
$include-replicas (optional): If set to `false`, do not include the replicas in the backup. The default is `true`, which means to include all replicas in the backup.
Example:
      xquery version "1.0-ml";

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

      admin:database-one-time-backup("/backup-dir",
            xs:dateTime("2008-02-14T09:45:00"),10,true(),true(),true())
      (: returns the one-time backup :)
admin:database-one-time-merge-blackout(
| $limit as xs:unsignedInt,
| $merge-priority as xs:string,
| $start as xs:dateTime,
| $end as xs:dateTime?,
| $duration as xs:duration?
) as element(db:merge-blackout)
Summary: This function constructs a one-time merge-blackout specification.
Parameters:
$limit : The maximum number of megabytes for a merge.
$merge-priority : The CPU scheduler priority for merges. Must be one of `normal` or `lower`.
$start : The starting dateTime of the merge blackout.
$end : The ending dateTime of the merge blackout.
$duration : The amount of time for the blackout to last.
Example:
      xquery version "1.0-ml";

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

      admin:database-one-time-merge-blackout(500, "lower",
            xs:dateTime("2008-02-14T09:45:00"),
            (), xs:dayTimeDuration("PT3H") )
      (: returns the one-time merge-blackout specification :)
admin:database-phrase-around(
| $namespace as xs:string?,
| $localname as xs:string
) as element(db:phrase-around)
Summary: This function constructs a phrase through specification.
Parameters:
$namespace : The namespace URI.
$localname : The local name for the node.
Example:
      xquery version "1.0-ml";

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

      admin:database-phrase-around("my/namepsace", "elementname" )
      (: returns the phrase around specification :)
admin:database-phrase-through(
| $namespace as xs:string?,
| $localname as xs:string
) as element(db:phrase-through)
Summary: This function constructs a phrase through specification.
Parameters:
$namespace : The namespace URI.
$localname : The local name for the node.
Example:
      xquery version "1.0-ml";

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

      admin:database-phrase-through("my/namepsace", "elementname" )
      (: returns the phrase through specification :)
admin:database-range-element-attribute-index(
| $scalar-type as xs:string,
| $parent-namespace as xs:string?,
| $parent-localname as xs:string,
| $namespace as xs:string?,
| $localname as xs:string,
| $collation as xs:string,
| $range-value-positions as xs:boolean
) as element(db:range-element-attribute-index)
Summary: This function constructs a range element attribute index specification.
Parameters:
$scalar-type : A valid type for the range index. Must be one of: `int`, `unsignedInt`, `long`, `unsignedLong`, `float`, `double`, `decimal`, `dateTime`, `time`, `date`, `gYearMonth`, `gYear`, `gMonth`, `gDay`, `yearMonthDuration`, `dayTimeDuration`, `string`, `anyURI`, or `point`.
$parent-namespace : The namespace of the parent element for the attribute.
$parent-localname : The local name of the parent element for the attribute.
$namespace : The namespace URI.
$localname : The local name for the node.
$collation : The collation URI (for example, `http://marklogic.com/collation/`. The collation is only needed for string and anyURI indexes; for other indexes, specify the empty string ("") for this parameter.
$range-value-positions : A boolean specifying whether to maintain value postions in this index (used with co-occurrences).
Example:
      xquery version "1.0-ml";

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

      admin:database-range-element-attribute-index("string", "/my/namespace",
            "elementname", "", "myAtribute", "http://marklogic.com/collation/",
    	fn:false() )
      (: returns the range element attribute-index specification :)
admin:database-range-element-index(
| $scalar-type as xs:string,
| $namespace as xs:string?,
| $localname as xs:string,
| $collation as xs:string,
| $range-value-positions as xs:boolean
) as element(db:range-element-index)
Summary: This function constructs a range element index specification.
Parameters:
$scalar-type : A valid type for the range index. Must be one of: `int`, `unsignedInt`, `long`, `unsignedLong`, `float`, `double`, `decimal`, `dateTime`, `time`, `date`, `gYearMonth`, `gYear`, `gMonth`, `gDay`, `yearMonthDuration`, `dayTimeDuration`, `string`, `anyURI`, or `point`.
$namespace : The namespace URI.
$localname : The local name for the node.
$collation : The collation URI (for example, `http://marklogic.com/collation/`). The collation is only needed for string and anyURI indexes; for other indexes, specify the empty string ("") for this parameter.
$range-value-positions : A boolean specifying whether to maintain value postions in this index (used with co-occurrences).
Example:
      xquery version "1.0-ml";

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

      admin:database-range-element-index("string", "/my/namespace",
                    "elementname", "http://marklogic.com/collation/",
    		fn:false() )
      (: returns the range element index specification :)
admin:database-recurring-merge-blackout(
| $limit as xs:unsignedInt,
| $merge-priority as xs:string,
| $days as xs:string+,
| $start-time as xs:time?,
| $end-time as xs:time?,
| $duration as xs:duration?
) as element(db:merge-blackout)
Summary: This function constructs a merge-blackout specification.
Parameters:
$limit : The maximum number of megabytes for a merge.
$merge-priority : The CPU scheduler priority for merges. Must be one of `normal` or `lower`.
$days : The day(s) of the week. Must be a sequence of zero or more of `monday`, `tuesday`, `wednesday`, `thusday`, `friday`, `saturday`, `sunday`.
$start-time : A time for the merge blackout to start.
$end-time : A time for the merge blackout to end.
$duration : The amount of time for the blackout to last.
Example:
      xquery version "1.0-ml";

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

      admin:database-recurring-merge-blackout(500, "lower", "monday",
            xs:time("09:45:00"), xs:time("11:45:00"), () )
      (: returns the merge-blackout specification :)
admin:database-set-attribute-value-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the attribute value positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-attribute-value-positions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-collection-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the collection lexicon setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-collection-lexicon($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-directory-creation(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the directory creation setting for the specified database in 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")`).
$value : The new directory creation setting. Must be one of: `automatic`, `manual-enforced`, or `manual`.
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-set-directory-creation($config,
            xdmp:database("myDatabase"), "automatic")
      (: 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.  :)
admin:database-set-element-value-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the element value positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-element-value-positions($config, xdmp:database("myDatabase"),
            fn:true())
      (: 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.  :)
admin:database-set-element-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the element word positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-element-word-positions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-enabled(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the enabled value for the specified database in 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")`).
$value : The new boolean value.
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-set-enabled($config, xdmp:database("myDatabase"), fn:false())
      (: 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.  :)
admin:database-set-expunge-locks(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the expunge locks setting for the specified database in 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")`).
$value : The new expunge locks setting. Must be one of: `automatic` or `none`.
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-set-expunge-locks($config,
            xdmp:database("myDatabase"), "automatic")
      (: 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.  :)
admin:database-set-fast-case-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast case sensitive searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-case-sensitive-searches($config, xdmp:database("myDatabase"),
            fn:true())
      (: 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.  :)
admin:database-set-fast-diacritic-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast diacritic-sensitive searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-diacritic-sensitive-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-fast-element-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast element character searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-element-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-fast-element-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast element phrase searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-element-phrase-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-fast-element-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast element trailing wildcard searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-trailing-wildcard-word-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-fast-element-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the element word searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-element-word-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-fast-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast phrase searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-phrase-searches($config, xdmp:database("myDatabase"),
            fn:true())
      (: 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.  :)
admin:database-set-fast-reverse-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the fast reverse searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-fast-reverse-searches($config, xdmp:database("myDatabase"),
            fn:true())
      (: 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.  :)
admin:database-set-field-fast-case-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field fast case sensitive searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-fast-case-sensitive-searches($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-field-fast-diacritic-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field fast diacritic sensitive searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-fast-diacritic-sensitive-searches($config,
            xdmp:database("myDatabase"), "myField", fn:false())
      (: 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.  :)
admin:database-set-field-fast-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field fast phrase searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-fast-phrase-searches($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-field-include-document-root(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the field include document root setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-field-include-document-root($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-field-name(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:string
) as element(configuration)
Summary: This function sets the field name setting for the specified field in 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")`).
$field-name : The name of the field.
$value : The new name for the field.
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-set-field-name($config,
            xdmp:database("myDatabase"), "myField", "myNewFieldName")
      (: 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.  :)
admin:database-set-field-one-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field one character searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-one-character-searches($config,
            xdmp:database("myDatabase"), "myField", fn:false())
      (: 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.  :)
admin:database-set-field-stemmed-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:string?
) as element(configuration)
Summary: This function sets the field stemmed searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : The new stemmed search value. Must be one of `basic`, `advanced`, or `decompounding`. It must be equal to or greater than the database setting. The empty sequence turns this setting off for the field.
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-set-field-stemmed-searches($config,
            xdmp:database("myDatabase"), "myField", "decompounding")
      (: 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.  :)
admin:database-set-field-three-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field three character searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-three-character-searches($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-field-three-character-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field three character word positions setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-three-character-word-positions($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-field-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field trailing wildcard searches setting for the specified database in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-field-trailing-wildcard-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field trailing wildcard word positions setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-wildcard-word-positions($config,
            xdmp:database("myDatabase"), "myField", fn:false())
      (: 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.  :)
admin:database-set-field-two-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field two character searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-field-two-character-searches($config,
            xdmp:database("myDatabase"), "myField", fn:false())
      (: 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.  :)
admin:database-set-field-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $field-name as xs:string,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the field word searches setting for the specified field in 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")`).
$field-name : The name of the field.
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-field-word-searches($config,
            xdmp:database("myDatabase"), "myField", fn:true())
      (: 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.  :)
admin:database-set-format-compatibility(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the format cpmpatibility setting for the specified database in 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")`).
$value : The new format-compatibility setting. Must be one of: `automatic`, `4.0`, `3.2`, `3.1`, `3.0`, or `2.2`.
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-set-format-compatibility($config,
            xdmp:database("myDatabase"), "automatic")
      (: 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.  :)
admin:database-set-in-memory-limit(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the in-memory limit setting for the specified database in 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")`).
$value : The new value, indicating the maximum number of fragments allowed in an in-memory stand before it is saved to disk.
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-set-in-memory-limit($config,
            xdmp:database("myDatabase"), 65536)
      (: 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.  :)
admin:database-set-in-memory-list-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the in-memory list size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-in-memory-list-size($config,
            xdmp:database("myDatabase"), 256)
      (: 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.  :)
admin:database-set-in-memory-range-index-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the in-memory range index size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-in-memory-range-index-size($config,
            xdmp:database("myDatabase"), 8)
      (: 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.  :)
admin:database-set-in-memory-reverse-index-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the in-memory range reverse index size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-in-memory-reverse-index-size($config,
            xdmp:database("myDatabase"), 8)
      (: 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.  :)
admin:database-set-in-memory-tree-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the in-memory tree size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-in-memory-tree-size($config,
            xdmp:database("myDatabase"), 64)
      (: 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.  :)
admin:database-set-index-detection(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the index detection setting for the specified database in 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")`).
$value : The new index detection setting. Must be one of: `automatic` or `none`.
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-set-index-detection($config,
            xdmp:database("myDatabase"), "automatic")
      (: 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.  :)
admin:database-set-inherit-collections(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the inherit collections setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-inherit-collections($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-inherit-permissions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the inherit permissions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-inherit-permissions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-inherit-quality(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the inherit quality setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-inherit-quality($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-journal-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the journal size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-journal-size($config,
            xdmp:database("myDatabase"), 320)
      (: 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.  :)
admin:database-set-journaling(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the journaling setting for the specified database in the configuration. When set to `strict`, the journal protects against MarkLogic Server process failures, host operating system kernel failures, and host hardware failures. When set to `fast`, the journal protects against MarkLogic Server process failures but not against host operating system kernel failures or host hardware failures. When set to `off`, the journal does not protect against MarkLogic Server process failures, host operating system kernel failures, or host hardware failures.
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 journaling value. Must be one of `strict`, `fast`, or `off`.
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-set-journaling($config, xdmp:database("myDatabase"),
            "strict")
      (: 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.  :)
admin:database-set-language(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the language for the specified database in 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")`).
$value : The locale string representing the new language. Must be a valid value for `xml:lang`.
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-set-language($config, xdmp:database("myDatabase"),
            "fr")
      (: 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.  :)
admin:database-set-locking(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the locking setting for the specified database in the configuration. When set to `strict`, locking enforces mutual exclusion on existing documents and on new documents. When set to `fast`, locking enforces mutual exclusion on existing documents but not on new documents. When set to `off`, locking does not enforce mutual exclusion on existing documents or on new documents.
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 locking value. Must be one of `strict`, `fast`, or `off`.
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-set-locking($config, xdmp:database("myDatabase"),
            "fast")
      (: 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.  :)
admin:database-set-maintain-directory-last-modified(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the maintain directory last modified setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-maintain-directory-last-modified($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-maintain-last-modified(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the maintain last modified setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-maintain-last-modified($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-merge-enable(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the merge enable setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-merge-enable($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-merge-max-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the merge max size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-merge-max-size($config,
            xdmp:database("myDatabase"), 500)
      (: 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.  :)
admin:database-set-merge-min-ratio(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the merge min ratio setting for the specified database in 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")`).
$value : The new ratio. Larger ratios trigger more merges.
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-set-merge-min-ratio($config,
            xdmp:database("myDatabase"), 2)
      (: 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.  :)
admin:database-set-merge-min-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the merge minimum size setting for the specified database in 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")`).
$value : The new size, in number of fragments.
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-set-merge-min-size($config,
            xdmp:database("myDatabase"), 5000)
      (: 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.  :)
admin:database-set-merge-priority(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the CPU scheduler priority for merges.
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 CPU scheduler priority value. Must be one of `normal` or `lower`.
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-set-merge-priority($config,
            xdmp:database("myDatabase"), "lower")
      (: 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.  :)
admin:database-set-merge-timestamp(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets the merge timestamp setting for the specified database in 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")`).
$value : The new system timestamp after which to preserve fragments in a merge. A value of 0 indicates to keep only the latest version of fragments.
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-set-merge-timestamp($config,
            xdmp:database("myDatabase"), 0)
      (: 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.  :)
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.
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.  :)
admin:database-set-one-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the one character searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-one-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-positions-list-max-size(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the positions list max size setting for the specified database in 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")`).
$value : The new size, in megabytes.
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-set-positions-list-max-size($config,
            xdmp:database("myDatabase"), 64)
      (: 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.  :)
admin:database-set-preallocate-journals(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the preallocate journals setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-preallocate-journals($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-preload-mapped-data(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the preload mapped data setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-preload-mapped-data($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-range-index-optimize(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the range index optimize setting for the specified database in the configuration. When set to `facet-time`, range indexes are optimized to minimize the amount of CPU time used. When set to `memory-size`, range indexes are optimized to minimize the amount of memory used.
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 range index optimize value. Must be one of `facet-time` or `memory-size`.
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-set-range-index-optimize($config, xdmp:database("myDatabase"),
            "memory-size")
      (: 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.  :)
admin:database-set-reindexer-enable(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the reindexer enable setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-reindexer-enable($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-reindexer-throttle(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the reindexer throttle setting for the specified database in 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")`).
$value : The new setting, which must be a number between 1 and 5 (inclusive). Larger numbers mean to work harder at reindexing.
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-set-reindexer-throttle($config,
            xdmp:database("myDatabase"), 5)
      (: 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.  :)
admin:database-set-reindexer-timestamp(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the reindexer timestamp setting for the specified database in 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")`).
$value : The system timestamp before which fragments will be reindexed. 0 indicates no forced reindex.
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-set-reindexer-timestamp($config,
            xdmp:database("myDatabase"), 0)
      (: 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.  :)
admin:database-set-schema-database(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets the schema database for a database to the specified database in 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")`).
$value : The new database ID for the auxiliary database.
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-set-schema-database($config, xdmp:database("myDatabase"),
            xdmp:database("mySchemasDatabase"))
     (: 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.  :)
admin:database-set-security-database(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets the security database for a database to the specified database in 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")`).
$value : The new database ID for the auxiliary database.
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-set-security-database($config, xdmp:database("myDatabase"),
            xdmp:database("mySecurityDatabase"))
      (: 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.  :)
admin:database-set-stemmed-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the stemmed searches setting for the specified database in 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")`).
$value : The new stemmed search value. Must be one of `off`, `basic`, `advanced`, or `decompounding`.
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-set-stemmed-searches($config, xdmp:database("myDatabase"),
            "advanced")
      (: 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.  :)
admin:database-set-tf-normalization(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function specifies whether to use the default term-frequency normalization (`scaled-log`), which scales the term frequency based on the size of the document, or to use the `unscaled-log`, which uses term frequency as a function of the actual term frequency in a document, regardless of the document size.
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 term-frequency normalization setting. Must be one of: `scaled-log` or `unscaled-log`.
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 $db := admin:database-get-id($config, "myDatabase")

      return   <apidoc:param name="config" type="element(configuration)">
         A configuration specification, typically as returned
         from one of the Admin module functions.
       </apidoc:param>
       <apidoc:param name="group-id" type="xs:unsignedLong">
         The name of the group.
       </apidoc:param>
          admin:database-set-tf-normalization($config, $db, "unscaled-log")

      (: Sets the term-frequency normalization setting to "unscaled-log" for the
         database, "myDatabase." :)
admin:database-set-three-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the three character searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-three-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-three-character-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the three character word positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-three-character-word-positions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the trailing wildcard searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-trailing-wildcard-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the trailing wildcard word positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-trailing-wildcard-word-positions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-triggers-database(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets the triggers database to the specified database ID for the specified database in 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")`).
$value : The new database ID for the auxiliary database.
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-set-triggers-database($config, xdmp:database("myDatabase"),
            xdmp:database("myTriggersDatabase"))
     (: 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.  :)
admin:database-set-two-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the two character searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-two-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-uri-lexicon(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the URI lexicon setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-uri-lexicon($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the word positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-word-positions($config, xdmp:database("myDatabase"),
            fn:true())
      (: 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.  :)
admin:database-set-word-query-fast-case-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function returns the word query fast case sensitive searches 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-fast-case-sensitive-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-fast-diacritic-sensitive-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query fast diacritic sensitive searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-fast-diacritic-sensitive-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-fast-phrase-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query fast phrase searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-fast-phrase-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-include-document-root(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the word query include document root setting for the specified field in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-word-query-include-document-root($config,
            xdmp:database("myDatabase"), fn:false())
      (: 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.  :)
admin:database-set-word-query-one-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query one character searches setting for the specified field in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-one-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-stemmed-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:string?
) as element(configuration)
Summary: This function sets the word query stemmed searches setting for the specified database in 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")`).
$value : The new stemmed search value. Must be one of `basic`, `advanced`, or `decompounding`. It must be equal to or greater than the database setting. The empty sequence turns this setting off for word query.
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-set-word-query-stemmed-searches($config,
            xdmp:database("myDatabase"), "advanced")
      (: 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.  :)
admin:database-set-word-query-three-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query three character searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-three-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-three-character-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query three character word positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-three-character-word-positions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-trailing-wildcard-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query trailing wildcard searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-trailing-wildcard-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-trailing-wildcard-word-positions(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query trailing wildcard word positions setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-trailing-wildcard-word-positions($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-two-character-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query two character searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-two-character-searches($config,
            xdmp:database("myDatabase"), fn:true())
      (: 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.  :)
admin:database-set-word-query-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean?
) as element(configuration)
Summary: This function sets the word query word searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` or the empty sequence to disable.
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-set-word-query-word-searches($config,
                   xdmp:database("myDatabase"), fn:true())

      (: 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.  :)
admin:database-set-word-searches(
| $config as element(configuration),
| $database-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the word searches setting for the specified database in 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")`).
$value : A boolean value, `fn:true()` to enable, `fn:false()` to disable.
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-set-word-searches($config, xdmp:database("myDatabase"),
            fn:true())
      (: 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.  :)
admin:database-weekly-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $days as xs:string+,
| $start-time as xs:time,
| $max-backups as xs:unsignedLong,
| $backup-security-db as xs:boolean,
| $backup-schemas-db as xs:boolean,
| $backup-triggers-db as xs:boolean,
| [$include-replicas as xs:boolean]
) as element(db:database-backup)
Summary: This function constructs a weekly scheduled backup.
Parameters:
$backup-dir : The directory where the backup will be saved to.
$backup-period : The how many weeks between each backup.
$days : The day(s) of the week. Must be a sequence of zero or more of `monday`, `tuesday`, `wednesday`, `thusday`, `friday`, `saturday`, `sunday`.
$start-time : A time for the scheduled backup to start.
$max-backups : The maximum number of backups to keep in the backup directory.
$backup-security-db : Whether to backup the security database alongside the current backup.
$backup-schemas-db : Whether to backup the schemas database alongside the current backup.
$backup-triggers-db : Whether to backup the triggers database alongside the current backup.
$include-replicas (optional): If set to `false`, do not include the replicas in the backup. The default is `true`, which means to include all replicas in the backup.
Example:
      xquery version "1.0-ml";

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

      admin:database-weekly-backup("/backup-dir", 2, "monday",
            xs:time("09:45:00"),10,true(),true(),true())
      (: returns the weekly backup specification :)
admin:database-word-lexicon(
| $collation as xs:string
) as element(db:word-lexicon)
Summary: This function constructs a word lexicon specification.
Parameters:
$collation : The collation URI (for example, `http://marklogic.com/collation/`.
Example:
      xquery version "1.0-ml";

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

      admin:database-word-lexicon("http://marklogic.com/collation/")
      (: returns the word lexicon specification :)
admin:forest-add-backup(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $backups as element(as:forest-backup)*
) as element(configuration)
Summary: This function adds scheduled backup specifications for a forest to a configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The id of the forest (for example, `xdmp:forest("myforest")`).
$backups : The scheduled backup specification(s), typically the result of an `admin:forest-one-time-backup` or an `admin:forest-monthly-backup` or an `admin:forest-weekly-backup` call
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 $forest := xdmp:forest("myforest")
      let $backup := admin:forest-one-time-backup("/backup-dir",
            xs:dateTime("2008-02-14T09:45:00"))
      return
      admin:forest-add-backup($config, $forest, $backup)
      (: 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.  :)
admin:forest-add-failover-host(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $hosts as xs:unsignedLong*
) as element(configuration)
Summary: This function adds a failover host to the list of failover hosts for the specified forest in the specified configuration. If there are already any hosts specified, this host is added to the end of the list of failover hosts.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$hosts : The host ID(s) for the host(s) you want to restart. For example, `xdmp:host()` returns the ID for the current host.
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:forest-add-failover-host($config,
          admin:forest-get-id($config, "Documents"),
          xdmp:host("myFailoverHost"))

          => add the failover host "myFailoverHost" to the end of the
             list of failover hosts
admin:forest-add-replica(
| $config as element(configuration),
| $master-id as xs:unsignedLong,
| $replica-id as xs:unsignedLong
) as element(configuration)
Summary: This function adds a forest replica to a master forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$master-id : The ID of the master forest to which to add the replica forest (for example, `xdmp:forest("MasterForest")`).
$replica-id : The ID of the replica forest to add to the master forest (for example, `xdmp:forest("ReplicaForest")`).
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 $forest := xdmp:forest("Documents")
      let $replica-forest := xdmp:forest("my-replica")

      return admin:forest-add-replica($config, $forest, $replica-forest)

      (: 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.  :)
admin:forest-copy(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $forest-name as xs:string,
| $data-directory as xs:string?
) as element(configuration)
Summary: This function creates a new forest specification with the same settings as the forest with the specified ID. The new forest configuration will have the specified name. It copies the forest configuration, but does not copy the forest data.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$forest-name : The name for the new forest.
$data-directory : The optional data directory of the forest. If no directory is specified, then it will be a private forest.
Example:
      xquery version "1.0-ml";

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

      admin:forest-copy(admin:get-configuration(), xdmp:forest("myForest"),
             "myNewForest",())
admin:forest-create(
| $config as element(configuration),
| $forest-name as xs:string,
| $host-id as xs:unsignedLong,
| $data-directory as xs:string?
) as element(configuration)
Summary: This function creates a new forest configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-name : The name of the forest. The must be unique for all forests in the cluster.
$host-id : The ID of the host (for example, `xdmp:host()` for the current host.
$data-directory : The optional data directory of the forest. If no directory is specified, then it will be a private forest.
Example:
      xquery version "1.0-ml";

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

      admin:forest-create(admin:get-configuration(), "newForest", xdmp:host(), ())
admin:forest-daily-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $start-time as xs:time
) as element(as:forest-backup)
Summary: This function constructs a daily scheduled forest backup.
Parameters:
$backup-dir : The directory to save the backup.
$backup-period : The number of days to elapse between each backup.
$start-time : The time of day of the backup, in 24:00:00 notation.
Example:
      xquery version "1.0-ml";

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

      admin:forest-daily-backup("/backup-dir", 2, xs:time("19:45:00"))

      (: returns a daily forest backup specification. :)
admin:forest-delete(
| $config as element(configuration),
| $forest-ids as xs:unsignedLong*,
| $delete-data as xs:boolean
) as element(configuration)
Summary: This function deletes the configuration for the specified forest from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-ids : One or more forest ids. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$delete-data : If set to true, deletes the data directory as well as the configuration (Note: all documents in the forest will be permanently deleted). If set to false, deletes only the configuration information, leaving the forest data in the data directory on disk.
Usage Notes: Any forest whose ID you pass into this function must not be attached to a database when the transaction begins, otherwise an exception is thrown. If you need to detach the forest, do so in a separate transaction before using them in this function.
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:forest-delete($config, admin:forest-get-id($config, "Documents"),
          fn:false())

          => deletes the forest configuration for the forest
             named "Documents"
admin:forest-delete-backup(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $backups as element(as:forest-backup)*
) as element(configuration)
Summary: This function deletes scheduled backup specifications for a forest from a configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The id of the forest (for example, `xdmp:forest("myforest")`).
$backups : The scheduled backup(s) to delete. Typically, the result of an `admin:forest-get-backups` call.
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 $forest  := xdmp:forest("Documents")
      let $backups := admin:forest-get-backups($config, $forest)[1 to 3]
      return
      admin:forest-delete-backup($config, $forest, $backups)
      (: 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.  :)
admin:forest-delete-failover-host(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $hosts as xs:unsignedLong*
) as element(configuration)
Summary: This function deletes the specified failover host(s) from the failover-host list in the specified configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$hosts : The host ID(s) for the host(s) you want to delete. For example, `xdmp:host()` returns the ID for the current host.
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:forest-delete-failover-host($config,
          admin:forest-get-id($config, "Documents"),
          xdmp:host("myFailoverHost"))

          => deletes the failover host "myFailoverHost" from the
             list of failover hosts
admin:forest-exists(
| $config as element(configuration),
| $forest-name as xs:string
) as xs:boolean
Summary: This function determines whether or not the specified forest exists. Returns `true` if the forest exists, otherwise `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-name : The name of the forest to check.
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:forest-exists($config, "Documents")

      (: Returns true, if the Documents forest exists. :)
admin:forest-get-backups(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as element(as:forest-backup)*
Summary: This function returns the scheduled backups for the specified forest from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The id of the forest (for example, `xdmp:forest("myforest")`).
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:forest-get-backups($config, xdmp:forest("myforest") )
      (: returns the scheduled backups for the forest :)
admin:forest-get-data-directory(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name of the data directory of the specified forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
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:forest-get-data-directory($config,
             admin:forest-get-id($config, "test"))
admin:forest-get-database(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:unsignedLong?
Summary: This function returns the ID of the database that uses the specified forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The id of the forest used by the database to be returned (for example, `xdmp:forest("myForest")`).
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 $forest := xdmp:forest("Documents")

      return admin:forest-get-database($config, $forest)

      (: Returns the ID of the database that uses the Documents forest. :)
admin:forest-get-enabled(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the enabled state of the specified forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
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:forest-get-enabled($config, admin:forest-get-id($config, "test"))
admin:forest-get-failover-enable(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the state of whether failover is enabled for the specified forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
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:forest-get-failover-enable($config,
             admin:forest-get-id($config, "test"))
admin:forest-get-failover-hosts(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of the hosts defined as failover hosts for this forest. The order in which the hosts IDs are returned is significant, with the first ID being the primary host, the second (if there is one) being the secondary, and so on.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
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:forest-get-failover-hosts($config,
             admin:forest-get-id($config, "test"))
admin:forest-get-host(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the ID of the host in which the specified forest resides.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
Example:
      xquery version "1.0-ml";

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

      admin:forest-get-host(admin:get-configuration(), xdmp:forest("myForest"))

      => the ID of the host that services the forest named "myForest"
admin:forest-get-id(
| $config as element(configuration),
| $forest-name as xs:string
) as xs:unsignedLong
Summary: This function returns the ID of the forest with the specified name, from the specified configuration. The difference between this function and `xdmp:forest()` is that the ID from this function can come from a forest that has not yet been saved (that is, from a forest that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files).
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-name : The name of the forest.
Example:
      xquery version "1.0-ml";

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

      admin:forest-get-id(admin:get-configuration(), "myForest")
admin:forest-get-name(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name of the specified forest, given the forest ID.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. If the ID does not correspond to a valid forest ID, then an exception is thrown.
Example:
      xquery version "1.0-ml";

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

      admin:forest-get-name(admin:get-configuration(), 18220031759147104956)
admin:forest-get-replicas(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of the forest replicas for the specified forest. If it returns the empty sequence, then no replacas are assigned to the specified forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest having the replica forests to be returned (for example, `xdmp:forest("myForest")`).
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 $forest := xdmp:forest("Documents")

      return admin:forest-get-replicas($config, $forest)

      (: Returns the forest replicas associated with the Documents forest. :)
admin:forest-get-updates-allowed(
| $config as element(configuration),
| $forest-id as xs:unsignedLong
) as xs:string
Summary: This function returns the state of what kinds of updates are allowed for the specified forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
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:forest-get-updates-allowed($config,
             admin:forest-get-id($config, "test"))
admin:forest-hourly-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $start-minute as xs:nonNegativeInteger
) as element(as:forest-backup)
Summary: This function constructs a hourly scheduled forest backup.
Parameters:
$backup-dir : The directory to save the backup.
$backup-period : The number of hours to elapse between each backup
$start-minute : The number of minutes after the hour to start the backup. Note that this setting does not add to the backup period value.
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:forest-hourly-backup("/backup-dir", 2, 30)

      (: returns the hourly forest backup specification. For example, if the
         current time is 2:15pm, the backup will run at 4:30pm, 6:30pm, 8:30pm,
         and so on. :)
admin:forest-minutely-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger
) as element(as:forest-backup)
Summary: This function constructs a scheduled forest backup on a number-of-minutes basis.
Parameters:
$backup-dir : The directory to save the backup.
$backup-period : The number of minutes to elapse between each backup
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:forest-minutely-backup("/backup-dir", 45)

      (: returns the minutely forest backup specification. :)
admin:forest-monthly-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $backup-month-day as xs:unsignedInt,
| $start-time as xs:time
) as element(as:forest-backup)
Summary: This function constructs a monthly scheduled backup.
Parameters:
$backup-dir : The directory where the backup will be saved to.
$backup-period : The number of months to elapse between each backup.
$backup-month-day : The day of the month the backup will happen (between 1 and 31)
$start-time : A time for the scheduled backup to start.
Example:
      xquery version "1.0-ml";

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

      admin:forest-monthly-backup("/backup-dir", 1, 1, xs:time("09:45:00"))
      (: returns the monthly backup specification :)
admin:forest-one-time-backup(
| $backup-dir as xs:string,
| $start as xs:dateTime
) as element(as:forest-backup)
Summary: This function constructs a one-time backup.
Parameters:
$backup-dir : The directory where the backup will be saved to.
$start : The starting dateTime of the scheduled backup.
Example:
      xquery version "1.0-ml";

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

      admin:forest-one-time-backup("/backup-dir",
            xs:dateTime("2008-02-14T09:45:00"))
      (: returns the one-time backup :)
admin:forest-remove-replica(
| $config as element(configuration),
| $master-id as xs:unsignedLong,
| $replica-id as xs:unsignedLong
) as element(configuration)
Summary: This function removes a forest replica from a master forest.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$master-id : The ID of the master forest from which to remove the replica forest (for example, `xdmp:forest("MasterForest")`).
$replica-id : The ID of the replica forest to remove from the master forest (for example, `xdmp:forest("ReplicaForest")`).
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 $forest := xdmp:forest("failover1")
      let $replica-forest := xdmp:forest("replica1")

      return admin:forest-remove-replica($config, $forest, $replica-forest)

      (: 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.  :)
admin:forest-set-enabled(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the enabled state for a forest configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$value : The new state of the forest, for example `fn:true()` for enabled, `fn:false()` for disabled.
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:forest-set-enabled($config, admin:forest-get-id($config, "Documents"),
          fn:false())

      => sets the forest named "Documents" to the disabled state
admin:forest-set-failover-enable(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the forest failover enabled state for a forest configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$value : The new failover-enable state of the forest, for example `fn:true()` for enabled, `fn:false()` for disabled.
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:forest-set-failover-enable($config,
          admin:forest-get-id($config, "Documents"),
          fn:true())

          => sets the failover state of the forest named "Documents" to
             the enabled state
admin:forest-set-host(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function sets a forest configuration to a new host.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$value : The host ID of the new host.
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:forest-set-host($config, admin:forest-get-id($config, "Documents"),
                  xdmp:host("myNewHost"))
admin:forest-set-updates-allowed(
| $config as element(configuration),
| $forest-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets the updates-allowed state for a forest configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$forest-id : The ID of the forest. For example, `xdmp:forest("myForest")` specified the ID for a forest named "myForest".
$value : The new updates-allowed state of the forest. Must be one of `all` for all updates allowed, `delete-only` for only deletes allowed, `read-only` for no updates allowed and to cause updating transactions to abort immediately, `flash-backup` for no updates allowed and to make updating transactions retry for a time period specified in the group's retry timeout.
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:forest-set-updates-allowed($config,
          admin:forest-get-id($config, "Documents"),
          "delete-only")

          => sets the updates-allowed state of the forest named "Documents" to
             the true state
admin:forest-weekly-backup(
| $backup-dir as xs:string,
| $backup-period as xs:positiveInteger,
| $days as xs:string+,
| $start-time as xs:time
) as element(as:forest-backup)
Summary: This function constructs a weekly scheduled backup.
Parameters:
$backup-dir : The directory where the backup will be saved to.
$backup-period : The how many weeks between each backup.
$days : The day(s) of the week. Must be a sequence of zero or more of `monday`, `tuesday`, `wednesday`, `thusday`, `friday`, `saturday`, `sunday`.
$start-time : A time for the scheduled backup to start.
Example:
      xquery version "1.0-ml";

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

      admin:forest-weekly-backup("/backup-dir", 2, "monday", xs:time("09:45:00"))
      (: returns the weekly backup specification :)
admin:get-appserver-ids(
| $config as element(configuration)
) as xs:unsignedLong*
Summary: This function returns all the appserver IDs from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
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:get-appserver-ids($config)
      (: returns the IDs of all the appservers :)
admin:get-configuration( ) as element(configuration)
Summary: Loads the admin configuration into memory for use by other functions in the Admin module.
Required Privilege: `http://marklogic.com/xdmp/privileges/admin-module-read`
Usage Notes: The configuration is loaded into memory only as it is needed, so it might not contain the entire configuration at any given moment. It loads only the parts of the configuration that are needed at the time they are needed to perform other Admin module operations that specified in the XQuery request. Therefore, if you execute the function without calling any other Admin module functions, it will return the empty sequence (because it never needed any of the config information to perform any of the Admin module operations).
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-range-element-indexes($config,
                               xdmp:database("Documents") )

      => The xml for any element range indexes in the "Documents"
         database, for example:
       <range-element-index xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    	                xmlns="http://marklogic.com/xdmp/database">
          <scalar-type>date</scalar-type>
          <collation/>
          <namespace-uri>mynamespace</namespace-uri>
          <localname>myelementname</localname>
          <range-value-positions>false</range-value-positions>
       </range-element-index>
admin:get-database-ids(
| $config as element(configuration)
) as xs:unsignedLong*
Summary: This function returns all the database IDs from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
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:get-database-ids($config)
      (: returns the IDs of all the databases :)
admin:get-forest-ids(
| $config as element(configuration)
) as xs:unsignedLong*
Summary: This function returns all the forest IDs from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
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:get-forest-ids($config)
      (: returns the IDs of all the forests :)
admin:get-group-ids(
| $config as element(configuration)
) as xs:unsignedLong*
Summary: This function returns all the group IDs from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
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:get-group-ids($config)
      (: returns the IDs of all the groups :)
admin:get-host-ids(
| $config as element(configuration)
) as xs:unsignedLong*
Summary: This function returns all the host IDs from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
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:get-host-ids($config)
      (: returns the IDs of all the hosts :)
admin:group-add-namespace(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $namespaces as element(gr:namespace)*
) as element(configuration)
Summary: Add one or more namespaces to a Group configuration, which will predefine the namespace(s) for all requests evaluated against any App Server in the Group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$namespaces : A list of namespaces to add. Typically the result of an `admin:group-namespace` call. Each namespace specification has the following form:
      <namespace xmlns="http://marklogic.com/xdmp/group">
        <prefix>myprefix</prefix>
        <namespace-uri>http://myuri/forthisprefix</namespace-uri>
      </namespace>
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-add-namespace($config, $groupid,
           <namespace xmlns="http://marklogic.com/xdmp/group">
             <prefix>myprefix</prefix>
             <namespace-uri>http://myuri/forthisprefix</namespace-uri>
            </namespace>)
      (: 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.  :)
admin:group-add-scheduled-task(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $scheduled-tasks as element(gr:scheduled-task)*
) as element(configuration)
Summary: This function adds one or more scheduled tasks to the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group on which the scheduled tasks are configured. Typically, this is the result of an `admin:group-get-id` call.
$scheduled-tasks : One or more scheduled tasks, such as those created by the task-create functions.
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 $task := admin:group-hourly-scheduled-task(
          "/Scheduler_test.xqy",
          "/Docs",
          2,
          30,
          xdmp:database("Documents"),
          0,
          xdmp:user("Jim"),
          0)

      let $addTask := admin:group-add-scheduled-task($config,
          admin:group-get-id($config, "Default"), $task)

      return
          admin:save-configuration($addTask)

      (: Creates an hourly scheduled task and adds it to the "Default" group. :)
admin:group-add-schema(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $schemas as element(gr:schema)*
) as element(configuration)
Summary: This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified Group. Schemas with a schema binding definition are automatically imported into queries run against any App Server in the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$schemas : A list of schema specification elements of the form:
    <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
      <namespace-uri>foo</namespace-uri>
      <schema-location>/foo.xsd</schema-location>
    </schema>
Typically the result of an `admin:group-schema` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-add-schema($config, $groupid,
      <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
         <namespace-uri>foo</namespace-uri>
         <schema-location>/foo.xsd</schema-location>
      </schema>)
      (: 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.  :)
admin:group-add-trace-event(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $events as element(gr:event)*
) as element(configuration)
Summary: This function adds trace events to the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$events : Zero or more event specifications, which you can construct with the `admin:group-trace-event` function.
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:group-add-trace-event($config,
          admin:group-get-id($config, "Default"),
          admin:group-trace-event("CPF on-state-enter"))
      (: 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.  :)
admin:group-copy(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $group-name as xs:string
) as element(configuration)
Summary: This function creates a new group specification with the same settings as the group with the specified ID. The new group configuration will have the specified name.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$group-name : The name of the new group to create.
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:group-copy($config, admin:group-get-id($config, "myOldGroup"),
                        "myNewGroup")

      (: 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.  :)
admin:group-create(
| $config as element(configuration),
| $group-name as xs:string
) as element(configuration)
Summary: This function creates a new group with the specified name in the configuration. The new group has the default values.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-name : The name for the new group.
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:group-create($config, "myNewGroup")
      (: 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.  :)
admin:group-daily-scheduled-task(
| $task-path as xs:string,
| $task-root as xs:string,
| $task-period as xs:positiveInteger,
| $task-start-time as xs:time,
| $task-database as xs:unsignedLong,
| $task-modules as xs:unsignedLong,
| $task-user as xs:unsignedLong,
| $task-host as xs:unsignedLong?
) as element(gr:scheduled-task)
Summary: This function constructs a task to be invoked at daily intervals.
Parameters:
$task-path : The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
$task-root : The root directory (files system) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
$task-period : The number of days to elapse between each invocation of the module.
$task-start-time : The time of day (in 24:00 notation) to invoke the module.
$task-database : The id of the database on which the module is to be invoked.
$task-modules : The id of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
$task-user : The id of the user with permission to invoke the module. For example, xdmp:user("Jim").
$task-host : The id of the host on which to invoke the module. Leave empty, (), to specify all hosts.
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:group-daily-scheduled-task(
            "/Scheduler_test.xqy",
            "/Docs",
            2,
            xs:time("09:30:00"),
            xdmp:database("Documents"),
            xdmp:database("Modules"),
            xdmp:user("Jim"),
            0)

      (: returns a daily scheduled task. :)
admin:group-delete(
| $config as element(configuration),
| $group-ids as xs:unsignedLong*
) as element(configuration)
Summary: This function deletes one or more groups in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-ids : The IDs of the groups to be deleted. Typically, this is the result of an `admin:group-get-id` call.
Usage Notes: Any group whose ID you pass into this function must not have any hosts belonging to it when the transaction begins, otherwise an exception is thrown. If you need to delete the group, remove its hosts in a separate transaction before calling this function.
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:group-delete($config, admin:group-get-id($config, "myOldGroup"))
      (: 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.  :)
admin:group-delete-namespace(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $namespaces as element(gr:namespace)*
) as element(configuration)
Summary: This function deletes the specified namespaces from the configuration for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$namespaces : A list of namespaces to delete. Each namespace specification has the following form:
      <namespace xmlns="http://marklogic.com/xdmp/group">
        <prefix>myprefix</prefix>
        <namespace-uri>http://myuri/forthisprefix</namespace-uri>
      </namespace>
Typically the result of an `admin:group-namespace` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
         admin:group-delete-namespace($config, $groupid,
            admin:group-get-namespaces($config, $groupid))

      (: 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.  :)
admin:group-delete-scheduled-task(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $scheduled-tasks as element(gr:scheduled-task)*
) as element(configuration)
Summary: This function deletes one or more scheduled tasks from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group on which the scheduled tasks are configured. Typically, this is the result of an `admin:group-get-id` call.
$scheduled-tasks : One or more scheduled tasks.
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 $group := admin:group-get-id($config, "Default")
      let $tasks := admin:group-get-scheduled-tasks($config, $group)

      return
       admin:group-delete-scheduled-task($config, $group, $tasks)

      (: Returns a configuration element with the scheduled tasks in the
          "Default" group deleted -- use admin:save-configuration
          to save the changes to the configuration or pass the configuration
          to other Admin API functions to make other changes. :)
admin:group-delete-schema(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $schemas as element(gr:schema)*
) as element(configuration)
Summary: This function deletes a schema binding definition to the existing schema binding definitions in the configuration for the specified Group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$schemas : A list of schema specification elements of the form:
    <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
      <namespace-uri>foo</namespace-uri>
      <schema-location>/foo.xsd</schema-location>
    </schema>
Typically the result of an `admin:group-schema` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-delete-schema($config, $groupid,
      <schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xmlns="http://marklogic.com/xdmp/group">
         <namespace-uri>foo</namespace-uri>
         <schema-location>/foo.xsd</schema-location>
      </schema>)
      (: 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.  :)
admin:group-delete-trace-event(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $events as element(gr:event)*
) as element(configuration)
Summary: This function deletes the specified trace events from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$events : Zero or more event specifications, which you can construct with the `admin:group-trace-event` function.
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:group-delete-trace-event($config,
          admin:group-get-id($config, "Default"),
          admin:group-trace-event("CPF on-state-enter"))
      (: 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.  :)
admin:group-disable-audit-event-type(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $event-type as xs:string*
) as element(configuration)
Summary: This function changes the audit event type(s) enabled setting for the audit configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$event-type : The event types to disable (must be one of: "amp-usage" "audit-configuration-change" "audit-shutdown" "audit-startup" "authentication-failure" "concurrent-request-denial" "configuration-change" "document-execute" "document-insert" "document-read" "document-update" "estimate" "eval" "exists" "lexicon-read" "no-permission" "no-privilege" "permission-change" "request-blackout-denial" "role-change-failure" "search" "security-access" "server-restart" "server-shutdown" "server-startup" "user-configuration-change" "user-role-addition" "user-role-removal" ).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-disable-audit-event-type($config, $groupid,
            ("no-permission","no-privilege"))
      (: 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.  :)
admin:group-enable-audit-event-type(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $event-type as xs:string*
) as element(configuration)
Summary: This function changes the audit event type(s) enabled setting for the audit configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$event-type : The event types to enable (must be one of: "amp-usage" "audit-configuration-change" "audit-shutdown" "audit-startup" "authentication-failure" "concurrent-request-denial" "configuration-change" "document-execute" "document-insert" "document-read" "document-update" "estimate" "eval" "exists" "lexicon-read" "no-permission" "no-privilege" "permission-change" "request-blackout-denial" "role-change-failure" "search" "security-access" "server-restart" "server-shutdown" "server-startup" "user-configuration-change" "user-role-addition" "user-role-removal" ).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-enable-audit-event-type($config, $groupid,
            ("no-permission","no-privilege"))
      (: 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.  :)
admin:group-exists(
| $config as element(configuration),
| $group-name as xs:string
) as xs:boolean
Summary: This function determines whether or not the specified Group exists. Returns `true` if the Group exists, otherwise `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-name : The name of the group to check..
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:group-exists($config, "Default")

      (: Returns true, if the Default group exists. :)
admin:group-get-appserver-ids(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of all appservers belonging to the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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:group-get-appserver-ids($config, admin:group-get-id($config,"myGroup"))
      (: returns the group's appserver IDs :)
admin:group-get-audit-enabled(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value for the audit enabled setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-audit-enabled($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the failover enable value :)
admin:group-get-audit-event-type-enabled(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $event-type as xs:string
) as xs:boolean
Summary: This function returns the audit event type's enabled setting for the audit configuration. A value of `true` is returned is the specified event type is set. Otherwise `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$event-type : The event type to check (must be one of: "amp-usage" "audit-configuration-change" "audit-shutdown" "audit-startup" "authentication-failure" "concurrent-request-denial" "configuration-change" "document-execute" "document-insert" "document-read" "document-update" "estimate" "eval" "exists" "lexicon-read" "no-permission" "no-privilege" "permission-change" "request-blackout-denial" "role-change-failure" "search" "security-access" "server-restart" "server-shutdown" "server-startup" "user-configuration-change" "user-role-addition" "user-role-removal" ).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-get-audit-event-type-enabled($config, $groupid,
            "no-permission")
      (: returns the new enabled status for the No-Permission event-type :)
admin:group-get-audit-excluded-roles(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the roles excluded from auditing. If auditing has a "inclusion" restriction, this function returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-excluded-roles($config, $groupid)
      (: returns a sequence of roles in the excluded role restriction:)
admin:group-get-audit-excluded-uris(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string*
Summary: This function returns the uris excluded from auditing. If auditing has a "inclusion" restriction, this function returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-excluded-uris($config, $groupid)
      (: returns a sequence of uris in the excluded uri restriction:)
admin:group-get-audit-excluded-users(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the users excluded from auditing. If auditing has a "inclusion" restriction, this function returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-excluded-users($config, $groupid)
      (: returns a sequence of users in the excluded user restriction:)
admin:group-get-audit-included-roles(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the roles included from auditing. If auditing has a "exclusion" restriction, this function returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-included-roles($config, $groupid)
      (: returns a sequence of roles in the included role restriction:)
admin:group-get-audit-included-uris(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string*
Summary: This function returns the uris included from auditing. If auditing has a "exclusion" restriction, this function returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-included-uris($config, $groupid)
      (: returns a sequence of uris in the included uri restriction:)
admin:group-get-audit-included-users(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the users included from auditing. If auditing has a "exclusion" restriction, this function returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-included-users($config, $groupid)
      (: returns a sequence of users in the included user restriction:)
admin:group-get-audit-outcome-restriction(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns whether auditing events are restricted by a success or failure outcome. Returns "success","failure", or "both"
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
        admin:group-get-audit-outcome-restriction($config, $groupid)
      (: returns either "success","failure", or "both":)
admin:group-get-compressed-tree-cache-partitions(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the compressed tree cache partitions setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-compressed-tree-cache-partitions($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the compressed tree cache partitions value :)
admin:group-get-compressed-tree-cache-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the compressed tree cache size setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-compressed-tree-cache-size($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the compressed tree cache size value :)
admin:group-get-compressed-tree-read-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the compressed tree read size (in kilobytes) setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-compressed-tree-read-size($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the compressed tree read size value :)
admin:group-get-expanded-tree-cache-partitions(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the expanded tree cache partitions setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-expanded-tree-cache-partitions($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the expanded tree cache partitions value :)
admin:group-get-expanded-tree-cache-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the expanded tree cache size setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-expanded-tree-cache-size($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the expanded tree cache size value :)
admin:group-get-failover-enable(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value for the failover enable setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-failover-enable($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the failover enable value :)
admin:group-get-file-log-level(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the file log level setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-file-log-level($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the file log level value :)
admin:group-get-host-ids(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of all hosts belonging to the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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:group-get-host-ids($config, admin:group-get-id($config,"myGroup"))
      (: returns the group's host IDs :)
admin:group-get-host-initial-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the host initial timeout setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-host-initial-timout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the host initial timeout value :)
admin:group-get-host-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the host timeout setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-host-timeout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the host timeout value :)
admin:group-get-http-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the http timeout setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-http-timeout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the http timeout value :)
admin:group-get-http-user-agent(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the http user agent setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-http-user-agent($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the http user agent value :)
admin:group-get-httpserver-ids(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of all httpservers belonging to the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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:group-get-httpserver-ids($config, admin:group-get-id($config,"myGroup"))
      (: returns the group's httpserver IDs :)
admin:group-get-id(
| $config as element(configuration),
| $group-name as xs:string
) as xs:unsignedLong
Summary: This function returns the ID of the group. The difference between this function and `xdmp:group()` is that the ID from this function can come from a group that has not yet been saved (that is, from a group that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files). This ID enables you to completely configure a newly created group without the need to first save the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-name : The name of the group.
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:group-get-id($config, "myGroup"))
      (: returns the group ID :)
admin:group-get-keep-audit-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the keep audit files setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-keep-audit-files($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the keep audit files value :)
admin:group-get-keep-log-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the keep log files setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-keep-log-files($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the keep log files value :)
admin:group-get-list-cache-partitions(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the list cache partitions setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-list-cache-partitions($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the list cache partitions value :)
admin:group-get-list-cache-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the list cache size setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-list-cache-size($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the list cache size value :)
admin:group-get-name(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name of the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-name($config, admin:group-get-id($config, "myGroup"))
      (: returns the group name :)
admin:group-get-namespaces(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as element(gr:namespace)*
Summary: This function returns the value of any namespace definitions predefined for the specified group. If none are defined, returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-get-namespaces($config, $groupid)
admin:group-get-retry-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the number of seconds a request will retry before timing out.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-host-retry-timout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the host initial timeout value :)
admin:group-get-rotate-audit-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the rotate audit files setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-rotate-audit-files($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the rotate audit files value :)
admin:group-get-rotate-log-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the rotate log files setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-rotate-log-files($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the rotate log files value :)
admin:group-get-scheduled-tasks(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as element(gr:scheduled-task)*
Summary: This function returns all of the tasks scheduled for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group on which the scheduled tasks are configured. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-scheduled-tasks($config,
          admin:group-get-id($config, "Default"))

       =>

      <scheduled-task xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://marklogic.com/xdmp/group">
        <task-path>/Scheduler_test.xqy</task-path>
        <task-root>/Docs</task-root>
        <task-type>minutely</task-type>
        <task-period>15</task-period>
        <task-days/>
        <task-timestamp>2009-02-27T12:16:06.152-08:00</task-timestamp>
        <task-database>3439178527237237454</task-database>
        <task-modules>0</task-modules>
        <task-user>10677693687367813363</task-user>
      </scheduled-task>
admin:group-get-schemas(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as element(gr:schema)*
Summary: This function returns the value of any schemas definitions predefined for the specified group. If none are defined, returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")

      return
         admin:group-get-schemas($config, $groupid)
admin:group-get-smtp-relay(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the smtp relay setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-smtp-relay($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the smtp relay value :)
admin:group-get-smtp-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the smtp timeout setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-smtp-timeout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the smtp timeout value :)
admin:group-get-system-log-level(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the value for the system log level setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-system-log-level($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the system log level value :)
admin:group-get-taskserver-id(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the ID of of the taskserver belonging to the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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:group-get-taskserver-id($config, admin:group-get-id($config,"myGroup"))
      (: returns the group's taskserver ID :)
admin:group-get-trace-events(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as element(gr:event)*
Summary: This function returns the value of any trace events activated for the specified group. If none are defined, returns the empty sequence.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-get-trace-events($config, $groupid)
admin:group-get-trace-events-activated(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value for the trace events activated setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-trace-events-activated($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the trace events activated value :)
admin:group-get-webdavserver-ids(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of all webdavservers belonging to the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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:group-get-webdavserver-ids($config, admin:group-get-id($config,"myGroup"))
      (: returns the group's webdavserver IDs :)
admin:group-get-xdbcserver-ids(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedLong*
Summary: This function returns the IDs of all xdbcservers belonging to the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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:group-get-xdbcserver-ids($config, admin:group-get-id($config,"myGroup"))
      (: returns the group's xdbcserver IDs :)
admin:group-get-xdqp-ssl-allow-sslv3(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns `true` if the SSL v3 protocol is enabled for the group. Otherwise, `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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 $group := admin:group-get-id($config,"Default")

      return
         admin:group-get-xdqp-ssl-allow-sslv3($config, $group)

      (: Returns 'true' if the SSL v3 protocol is enabled for the Default group.
         Otherwise, false. :)
admin:group-get-xdqp-ssl-allow-tls(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns `true` if the TLS protocol is enabled for the group. Otherwise, `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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 $group := admin:group-get-id($config,"Default")

      return
         admin:group-get-xdqp-ssl-allow-tls($config, $group)

      (: Returns 'true' if the TLS protocol is enabled for the Default group.
         Otherwise, false. :)
admin:group-get-xdqp-ssl-ciphers(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the SSL ciphers set for the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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 $group := admin:group-get-id($config,"Default")

      return
         admin:group-get-xdqp-ssl-ciphers($config, $group)

      (: Returns the SSL cipher settings for the Default group. :)
admin:group-get-xdqp-ssl-enabled(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns `true` if SSL is enabled for the group. Otherwise, `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
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 $group := admin:group-get-id($config,"Default")

      return
         admin:group-get-xdqp-ssl-enabled($config, $group)

      (: Returns 'true' if SSL is enabled for the Default group.  Otherwise, false. :)
admin:group-get-xdqp-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the value for the xdqp timeout setting from the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
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:group-get-xdqp-timeout($config,
            admin:group-get-id($config, "myGroup"))
      (: returns the xdqp timeout value :)
admin:group-hourly-scheduled-task(
| $task-path as xs:string,
| $task-root as xs:string,
| $task-period as xs:positiveInteger,
| $task-minute as xs:nonNegativeInteger,
| $task-database as xs:unsignedLong,
| $task-modules as xs:unsignedLong,
| $task-user as xs:unsignedLong,
| $task-host as xs:unsignedLong?
) as element(gr:scheduled-task)
Summary: This function constructs a task to be invoked at hourly intervals.
Parameters:
$task-path : The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
$task-root : The root directory (filesystem) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
$task-period : The number of hours to elapse between each invocation of the module.
$task-minute : The number of minutes after the hour to invoke the module. This value must be 59 or less. Note that this setting does not add to the task-period value.
$task-database : The id of the database on which the module is to be invoked.
$task-modules : The id of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
$task-user : The id of the user with permission to invoke the module. For example, xdmp:user("Jim").
$task-host : The id of the host on which to invoke the module. Leave empty, (), to specify all hosts.
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:group-hourly-scheduled-task(
             "/Scheduler_test.xqy",
             "/Docs",
             2,
             30,
             xdmp:database("Documents"),
             0,
             xdmp:user("Jim"),
             0)

        (: returns an hourly scheduled task. :)
admin:group-minutely-scheduled-task(
| $task-path as xs:string,
| $task-root as xs:string,
| $task-period as xs:positiveInteger,
| $task-database as xs:unsignedLong,
| $task-modules as xs:unsignedLong,
| $task-user as xs:unsignedLong,
| $task-host as xs:unsignedLong?
) as element(gr:scheduled-task)
Summary: This function constructs a task to be invoked at intervals defined in terms of minutes.
Parameters:
$task-path : The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
$task-root : The root directory (filesystem) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
$task-period : The number of minutes to elapse between each invocation of the module.
$task-database : The id of the database on which the module is to be invoked.
$task-modules : The id of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
$task-user : The id of the user with permission to invoke the module. For example, xdmp:user("Jim").
$task-host : The id of the host on which to invoke the module. Leave empty, (), to specify all hosts.
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:group-minutely-scheduled-task(
            "/Scheduler_test.xqy",
            "/Docs",
            45,
            xdmp:database("Documents"),
            0,
            xdmp:user("Jim"),
            0)

        (: returns a minutely scheduled task. :)
admin:group-monthly-scheduled-task(
| $task-path as xs:string,
| $task-root as xs:string,
| $task-period as xs:positiveInteger,
| $task-month-day as xs:unsignedLong,
| $task-start-time as xs:time,
| $task-database as xs:unsignedLong,
| $task-modules as xs:unsignedLong,
| $task-user as xs:unsignedLong,
| $task-host as xs:unsignedLong?
) as element(gr:scheduled-task)
Summary: This function constructs a task to be invoked at monthly intervals.
Parameters:
$task-path : The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
$task-root : The root directory (files system) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
$task-period : The number of months to elapse between each invocation of the module.
$task-month-day : The day of the month to invoke the module.
$task-start-time : The time of day (in 24:00 notation) to invoke the module.
$task-database : The id of the database on which the module is to be invoked.
$task-modules : The id of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
$task-user : The id of the user with permission to invoke the module. For example, xdmp:user("Jim").
$task-host : The id of the host on which to invoke the module. Leave empty, (), to specify all hosts.
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:group-monthly-scheduled-task(
            "/Scheduler_test.xqy",
            "/Docs",
    	2,
    	3,
    	xs:time("14:42:52"),
            xdmp:database("Documents"),
            0,
            xdmp:user("Jim"),
    	0)

         (: returns a monthly scheduled task. :)
admin:group-namespace(
| $prefix as xs:string,
| $namespace-uri as xs:string
) as element(gr:namespace)
Summary: This function constructs a namespace element with the specified prefix and URI.
Parameters:
$prefix : The namespace prefix.
$namespace-uri : The namespace URI.
Example:
      xquery version "1.0-ml";

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

      admin:group-namespace("myprefix", "http://myuri/namespace")
      (: the namespace element :)
admin:group-one-time-scheduled-task(
| $task-path as xs:string,
| $task-root as xs:string,
| $task-start as xs:dateTime,
| $task-database as xs:unsignedLong,
| $task-modules as xs:unsignedLong,
| $task-user as xs:unsignedLong,
| $task-host as xs:unsignedLong?
) as element(gr:scheduled-task)
Summary: This function constructs a task to be invoked once, at a specific calendar day and time.
Parameters:
$task-path : The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
$task-root : The root directory (files system) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
$task-start : The date and time on which the task is to start.
$task-database : The id of the database on which the module is to be invoked.
$task-modules : The id of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
$task-user : The id of the user with permission to invoke the module. For example, xdmp:user("Jim").
$task-host : The id of the host on which to invoke the module. Leave empty, (), to specify all hosts.
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:group-one-time-scheduled-task(
            "/Scheduler_test.xqy",
            "/Docs",
            xs:dateTime("2009-03-29T14:42:52"),
            xdmp:database("Documents"),
            xdmp:database("Documents"),
            xdmp:user("Jim"),
    	admin:host-get-id($config, xdmp:host-name()))

        (: returns a one-time scheduled task. :)
admin:group-schema(
| $namespace-uri as xs:string,
| $schema-location as xs:string
) as element(gr:schema)
Summary: This function constructs a schema element with the specified prefix and URI.
Parameters:
$namespace-uri : The namespace URI for the schema.
$schema-location : The schema location.
Example:
      xquery version "1.0-ml";

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

      admin:group-schema("http://myuri/namespace", "/some/schema.xsd")
      (: the schema element :)
admin:group-set-audit-enabled(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function changes the audit enabled setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new setting (true to enable auditing for the group, false to disable it).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-audit-enabled($config, $groupid, fn:true())
      (: 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.  :)
admin:group-set-audit-outcome-restriction(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $outcome as xs:string*
) as element(configuration)
Summary: This function restricts the audit configuration by auditing events only if they are "success" or "failure" events.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$outcome : The outcomes to audit (must be one of: "success" or "failure" or "both").
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-audit-outcome-restriction($config, $groupid,
            "failure")
      (: 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.  :)
admin:group-set-audit-role-restriction(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $restriction-type as xs:string,
| $roles as xs:string*
) as element(configuration)
Summary: This function restricts the audit configuration by excluding or including by role.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$restriction-type : The restriction type (must be one of: "inclusion" or "exclusion").
$roles : The sequence of roles affected by the restriction type.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-audit-role-restriction($config, $groupid,
            "exclusion",("admin-role","developer-role"))
      (: 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.  :)
admin:group-set-audit-uri-restriction(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $restriction-type as xs:string,
| $uris as xs:string*
) as element(configuration)
Summary: This function restricts the audit configuration by excluding or including by document uri(s).
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$restriction-type : The restriction type (must be one of: "inclusion" or "exclusion").
$uris : The sequence of document-uris affected by the restriction type.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-audit-uri-restriction($config, $groupid,
            "inclusion",("/important/foo.xml","/important/foo1.xml"))
      (: 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.  :)
admin:group-set-audit-user-restriction(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $restriction-type as xs:string,
| $users as xs:string*
) as element(configuration)
Summary: This function restricts the audit configuration by excluding or including by user.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$restriction-type : The restriction type (must be one of: "inclusion" or "exclusion").
$users : The sequence of users affected by the restriction type.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-audit-user-restriction($config, $groupid,
            "exclusion",("admin1","admin2"))
      (: 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.  :)
admin:group-set-compressed-tree-cache-partitions(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the partions.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-compressed-tree-cache-partitions($config, $groupid, 2)
      (: 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.  :)
admin:group-set-compressed-tree-cache-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the compressed tree cache size setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new cache value (in megabytes).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-compressed-tree-cache-size($config, $groupid, 256)
      (: 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.  :)
admin:group-set-compressed-tree-read-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the compressed tree read size setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new read size value (in kilobytes).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-compressed-tree-read-size($config, $groupid, 256)
      (: 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.  :)
admin:group-set-expanded-tree-cache-partitions(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the expanded tree cache partitions setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the partions.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-expanded-tree-cache-partitions($config, $groupid, 2)
      (: 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.  :)
admin:group-set-expanded-tree-cache-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the expanded tree cache size setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new cache value (in megabytes).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-expanded-tree-cache-size($config, $groupid, 256)
      (: 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.  :)
admin:group-set-failover-enable(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function changes the failover enable setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new setting (true to enable failover for the group, false to disable it).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-failover-enable($config, $groupid, fn:true())
      (: 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.  :)
admin:group-set-file-log-level(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the host file log level setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new log level (must be one of `finest`, `finer`, `fine`, `debug`, `config`, `info`, `notice`, `warning`, `error`, `critical`, `alert`, `emergency`).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-file-log-level($config, $groupid, "debug")
      (: 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.  :)
admin:group-set-host-initial-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the host initial timeout setting (the time the cluster will wait for a host to come online during cluster startup) for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new timeout setting (in seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-host-initial-timout($config, $groupid, 300)
      (: 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.  :)
admin:group-set-host-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the host timeout setting (the timeout for communication between hosts) for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new timeout setting (in seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-host-timout($config, $groupid, 60)
      (: 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.  :)
admin:group-set-http-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the HTTP timeout setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new timeout setting (in seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-http-timeout($config, $groupid, 60)
      (: 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.  :)
admin:group-set-http-user-agent(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the HTTP User-Agent setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the HTTP User-Agent.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-http-user-agent($config, $groupid, "MarkLogic")
      (: 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.  :)
admin:group-set-keep-audit-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the keep audit files setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : A number indicating the number of audit log files to keep before deleting them.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-keep-audit-files($config, $groupid, 20)
      (: 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.  :)
admin:group-set-keep-log-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the keep log files setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : A number indicating the number of log files to keep before deleting them.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-keep-log-files($config, $groupid, 20)
      (: 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.  :)
admin:group-set-list-cache-partitions(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the list cache partitions setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the partions.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-list-cache-partitions($config, $groupid, 2)
      (: 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.  :)
admin:group-set-list-cache-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the list cache size setting of the group with the specified ID to the specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new list cache value (in megabytes).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-list-cache-size($config, $groupid, 256)
      (: 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.  :)
admin:group-set-name(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the name of the group with the specified ID to the specified name.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new name for the group.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-name($config, $groupid, "myNewGroupName")
      (: 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.  :)
admin:group-set-retry-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the the number of seconds a request will retry before timing out.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new timeout setting (in seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-retry-timout($config, $groupid, 180)
      (: 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.  :)
admin:group-set-rotate-audit-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the rotate audit files setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new audit level (must be one of `never`, `daily`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`, `monthly`).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-rotate-audit-files($config, $groupid, "wednesday")
      (: 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.  :)
admin:group-set-rotate-log-files(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the rotate log files setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new log level (must be one of `never`, `daily`, `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`, `monthly`).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-rotate-log-files($config, $groupid, "wednesday")
      (: 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.  :)
admin:group-set-smtp-relay(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the SMTP relay setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the SMTP relay host.
Example:
      xquery version "1.0-ml";

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

      let $config := admin:get-configuration()
      let $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-smtp-relay($config, $groupid, "mail")
      (: 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.  :)
admin:group-set-smtp-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the SMTP timeout setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new SMTP response timeout (in seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-smtp-timeout($config, $groupid, 30)
      (: 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.  :)
admin:group-set-system-log-level(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the host system log level setting for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new log level (must be one of `finest`, `finer`, `fine`, `debug`, `config`, `info`, `notice`, `warning`, `error`, `critical`, `alert`, `emergency`).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-system-log-level($config, $groupid, "debug")
      (: 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.  :)
admin:group-set-trace-events-activated(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function changes the value for trace events in the group configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new trace event value (true for enabled, false for disabled).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-trace-events-activated($config, $groupid, fn:true())
      (: 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.  :)
admin:group-set-xdqp-ssl-allow-sslv3(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function enables or disables the SSL v3 protocol for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : Specify `true` to enable the SSL v3 protocol for the group or `false` to disable the SSL v3 protocol.
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 $group := admin:group-get-id($config,"Default")

      return
            admin:group-set-xdqp-ssl-allow-sslv3($config, $group, fn:false())

      (: Disables the SSL v3 protocol on the Default group. :)
admin:group-set-xdqp-ssl-allow-tls(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function enables or disables the TLS protocol for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : Specify `true` to enable the TLS protocol for the group or `false` to disable the TLS protocol.
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 $group := admin:group-get-id($config,"Default")

      return
            admin:group-set-xdqp-ssl-allow-tls($config, $group, fn:true())

      (: Enables the TLS protocol on the Default group. :)
admin:group-set-xdqp-ssl-ciphers(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function sets SSL ciphers for the specified group. This is the standard cipher specification string for OpenSSL.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : The SSL ciphers to set.
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 $group := admin:group-get-id($config,"Default")

      return
            admin:group-set-xdqp-ssl-ciphers($config, $group, "All")

      (: Sets the ciphers for the Default group to "All".  :)
admin:group-set-xdqp-ssl-enabled(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function enables or disables SSL for the group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The name of the group.
$value : Specify `true` to enable SSL for the group or `false` to disable SSL.
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 $group := admin:group-get-id($config,"Default")

      return
            admin:group-set-xdqp-ssl-enabled($config, $group, fn:false())

      (: Disables SSL on the Default group. :)
admin:group-set-xdqp-timeout(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the XDQP timeout setting (the timeout for communication between data nodes and evaluator nodes) for the group in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group. Typically, this is the result of an `admin:group-get-id` call.
$value : The new timeout setting (in seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:group-set-xdqp-timout($config, $groupid, 20)
      (: 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.  :)
admin:group-trace-event(
| $event-id as xs:string
) as element(gr:event)
Summary: This function constructs an event element for the specified event name.
Parameters:
$event-id : The exact name of the trace event.
Example:
      xquery version "1.0-ml";

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

      admin:group-trace-event("CPF on-state-enter")
      (: returns the event element for the CPF on state enter trace event :)
admin:group-weekly-scheduled-task(
| $task-path as xs:string,
| $task-root as xs:string,
| $task-period as xs:positiveInteger,
| $task-days as xs:string+,
| $task-start-time as xs:time,
| $task-database as xs:unsignedLong,
| $task-modules as xs:unsignedLong,
| $task-user as xs:unsignedLong,
| $task-host as xs:unsignedLong?
) as element(gr:scheduled-task)
Summary: This function constructs a task to be invoked at weekly intervals.
Parameters:
$task-path : The name of the module to be invoked. The task path must begin with a forward slash (/) and cannot contain a question mark '?', colon ':' or pound '#' character.
$task-root : The root directory (files system) or URI root (database) that contains the module. For example, if the module is located in the filesystem under MarkLogic/Docs, specify Docs.
$task-period : The number of weeks to elapse between each invocation of the module.
$task-days : One or more days on the specified week to invoke the module
$task-start-time : The time of day (in 24:00 notation) to invoke the module.
$task-database : The id of the database on which the module is to be invoked.
$task-modules : The id of the modules database. For example, xdmp:database("Modules"). To specify the filesystem, use 0.
$task-user : The id of the user with permission to invoke the module. For example, xdmp:user("Jim").
$task-host : The id of the host on which to invoke the module. Leave empty, (), to specify all hosts.
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:group-weekly-scheduled-task(
            "/Scheduler_test.xqy",
            "/Docs",
            2,
            ("Monday", "Wednesday"),
            xs:time("14:42:52"),
            xdmp:database("Documents"),
            xdmp:database("Documents"),
            xdmp:user("Jim"),
            admin:host-get-id($config, xdmp:host-name()))

         (: returns a weekly scheduled task. :)
admin:host-exists(
| $config as element(configuration),
| $host-name as xs:string
) as xs:boolean
Summary: This function determines whether or not the specified Host exists. Returns `true` if the Host exists, otherwise `false` is returned.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-name : The name of the host to check.
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:host-exists($config, "hp6910-624v64b.marklogic.com")

      (: Returns true, if the specified host exists. :)
admin:host-get-group(
| $config as element(configuration),
| $host-id as xs:unsignedLong
) as xs:unsignedLong
Summary: This function returns the group ID for the host with the specified ID.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-id : The host ID. Typically, the result of an `admin:host-get-id` call.
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:host-get-group($config, admin:host-get-id($config, xdmp:host-name()))
      (: returns the group ID :)
admin:host-get-id(
| $config as element(configuration),
| $host-name as xs:string
) as xs:unsignedLong
Summary: This function return the ID for the specified host from the configuration. The difference between this function and `xdmp:host()` is that the ID from this function can come from a host that has not yet been saved (that is, from a host that has been created in the same query with the Admin library but has not yet been saved to the cluster configuration files). This ID enables you to completely configure a newly created host without the need to first save the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-name : The name of the host. If the host is the current host, `xdmp:host-name()` returns the name.
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:host-get-id($config, xdmp:host-name())
      (: returns the host ID :)
admin:host-get-name(
| $config as element(configuration),
| $host-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name for the host with the specified ID.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-id : The host ID. Typically, the result of an `admin:host-get-id` call.
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:host-get-name($config, admin:host-get-id($config, xdmp:host-name()))
      (: returns the host name :)
admin:host-get-port(
| $config as element(configuration),
| $host-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the bind port for the host with the specified ID.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-id : The host ID. Typically, the result of an `admin:host-get-id` call.
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:host-get-port($config, admin:host-get-id($config, xdmp:host-name()))
      (: returns the bind port for the host :)
admin:host-set-group(
| $config as element(configuration),
| $host-id as xs:unsignedLong,
| $value as xs:unsignedLong
) as element(configuration)
Summary: This function changes the group to which an existing host belongs to the newly specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-id : The host ID. Typically, the result of an `admin:host-get-id` call.
$value : The new group ID value (typically from a `admin:group-get-id` call.
Usage Notes: Any group whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the group, do so in a separate transaction before using them in in this function.
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 $hostid := admin:host-get-id($config, xdmp:host-name())
      return
      admin:host-set-group($config, $hostid,
          admin:group-get-id($config, "Default"))
      (: 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.  :)
admin:host-set-name(
| $config as element(configuration),
| $host-id as xs:unsignedLong,
| $value as xs:string
) as element(configuration)
Summary: This function changes the name of an existing host to the newly specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-id : The host ID. Typically, the result of an `admin:host-get-id` call.
$value : The new name of the host.
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 $hostid := admin:host-get-id($config, "myOldHostname")
      return
      admin:host-set-name($config, $hostid, "myNewHostName")
      (: 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.  :)
admin:host-set-port(
| $config as element(configuration),
| $host-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function changes the bind port value for the host to the newly specified value.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$host-id : The host ID. Typically, the result of an `admin:host-get-id` call.
$value : The new bind port value.
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 $hostid := admin:host-get-id($config, xdmp:host-name())
      return
      admin:host-set-port($config, $hostid, 7999)
      (: 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.  :)
admin:http-server-create(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $appserver-name as xs:string,
| $root as xs:string,
| $port as xs:unsignedLong,
| $modules-id as item(),
| $database-id as xs:unsignedLong
) as element(configuration)
Summary: This function creates a new HTTP App Server with the specified name, root, and port in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$appserver-name : The name of the App Server. The name must be unique among the App Server names for the group.
$root : The root of the App Server.
$port : The port on which the App Server listens. The port must be available on the host.
$modules-id : The id of the modules database (for example, `xdmp:database("Modules")`). To specify the filesystem, use 0 or "file-system"
$database-id : The id of the database (for example, `xdmp:database("myDatabase")`).
Usage Notes: Any group or database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the group and/or database, do so in a separate transaction before using them in in this function.
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 $groupid := admin:group-get-id($config, "myGroup")
      return
      admin:http-server-create($config, $groupid, "myNewAppServer",
            "/space/mycode", 8005, 0, xdmp:database("myDatabase") )
      (: 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.  :)
admin:mimetype(
| $name as xs:string,
| $extensions as xs:string,
| $format as xs:string
) as element(mt:mimetype)
Summary: This function constructs a mimetype specification.
Parameters:
$name : The name of the mimetype.
$extensions : The extension(s) for the mimetype.
$format : A valid format for the mimetype. Must be on of: `binary`,`xml`, or `text`.
Example:
      xquery version "1.0-ml";

      import module namespace admin = "http://marklogic.com/xdmp/admin"
          at "/MarkLogic/admin.xqy";
      return
      admin:mimetype("application/foo","foo bar","binary")
      (: returns the mimetype specification :)
admin:mimetypes-add(
| $config as element(configuration),
| $mimetypes as element(mt:mimetype)*
) as element(configuration)
Summary: This function adds mimetypes to the configuration. This function always requires a server restart to take effect.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$mimetypes : A mimetype specification, typically the result of an `admin:mimetype` call.
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 $mimetype := admin:mimetype("application/foo","foo bar","binary")
      return
      admin:mimetypes-add($config, $mimetype)
      (: 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.  :)
admin:mimetypes-delete(
| $config as element(configuration),
| $mimetypes as element(mt:mimetype)*
) as element(configuration)
Summary: This function deletes mimetypes from the configuration. This function always requires a server restart to take effect.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$mimetypes : A mimetype specification, typically the result of an `admin:mimetype` call.
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 $mimetype := admin:mimetype("application/foo","foo bar","binary")
      return
      admin:mimetypes-delete($config, $mimetype)
      (: 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.  :)
admin:mimetypes-get(
| $config as element(configuration)
) as element(mt:mimetype)*
Summary: This function returns all the mimetypes from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
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:mimetypes-get($config)
      (: returns the mimetypes specifications for the cluster :)
admin:restart-hosts(
| $hosts as xs:unsignedLong*
) as empty-sequence()
Summary: This function restarts MarkLogic Server for the specified hosts.
Parameters:
$hosts : The host ID(s) for the host(s) you want to restart. For example, `xdmp:host()` returns the ID for the current host.
Example:
    (:
      This query restarts all hosts in the cluster.  Note that
      it will restart the host in which the query is run, too.
    :)
    xquery version "1.0-ml";

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

    let $hostids :=
       for $id in xdmp:host-status(xdmp:host())
                                   /host:hosts//host:host/host:host-id
       return fn:data($id)
    return
    admin:restart-hosts($hostids)
admin:save-configuration(
| $config as element(configuration)
) as empty-sequence()
Summary: This function saves a configuration specification to the cluster configuration files. It restarts MarkLogic Server for "cold" administrative tasks only (for example, for App Server port assignment changes). If you do not want those "cold" administrative tasks to automatically restart MarkLogic Server, use `admin:save-configuration-without-restart` instead.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
Required Privilege: `http://marklogic.com/xdmp/privileges/admin-module-write`
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 $spec := admin:forest-set-enabled($config,
        xdmp:forest("myForest"), fn:true() )
      return
      admin:save-configuration($spec)
admin:save-configuration-without-restart(
| $config as element(configuration)
) as xs:unsignedLong*
Summary: This function saves a configuration specification to the cluster configuration files, without restarting MarkLogic Server. If you use this function to save any changes that require a server restart ("cold" changes such as App Server port assignment changes), then the changes will not take effect until the next time MarkLogic Server restarts (although they will be saved in the configuration). If you want MarkLogic Server to automatically restart when needed, use `admin:save-configuration` instead.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
Required Privilege: `http://marklogic.com/xdmp/privileges/admin-module-write`
Usage Notes: The return value is a list of the host IDs that need to be restarted in order for the changes to take effect.
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 $spec := admin:forest-set-enabled($config,
        xdmp:forest("myForest"), fn:true() )
      return
      admin:save-configuration-without-restart($spec)
admin:taskserver-get-debug-allow(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value for the debug-allow setting configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-debug-allow($config, $group-id)
      (: returns the debug-allow setting configured on the task server :)
admin:taskserver-get-debug-threads(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the number of debug threads configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-debug-threads($config, $group-id)
      (: returns the number of debug threads configured on the task server :)
admin:taskserver-get-default-time-limit(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the default time limit configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-default-time-limit($config, $group-id)
      (: returns the default time limit configured on the task server :)
admin:taskserver-get-log-errors(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value for the log-errors setting configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-log-errors($config, $group-id)
      (: returns the log-errors setting configured on the task server :)
admin:taskserver-get-max-time-limit(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the maximum time limit configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-max-time-limit($config, $group-id)
      (: returns the maximum time limit configured on the task server :)
admin:taskserver-get-name(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:string
Summary: This function returns the name of the task server for the specified group from the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-name($config, $group-id)
      (: returns the name of the task server :)
admin:taskserver-get-post-commit-trigger-depth(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the maximum post-commit trigger depth configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-post-commit-trigger-depth($config, $group-id)
      (: returns the post-commit trigger depth configured on the task server :)
admin:taskserver-get-pre-commit-trigger-depth(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the maximum pre-commit trigger depth configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-pre-commit-trigger-depth($config, $group-id)
      (: returns the pre-commit trigger depth configured on the task server :)
admin:taskserver-get-pre-commit-trigger-limit(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the pre-commit trigger limit configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-pre-commit-trigger-limit($config, $group-id)
      (: returns the pre-commit trigger limit configured on the task server :)
admin:taskserver-get-profile-allow(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:boolean
Summary: This function returns the value for the profile-allow setting configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-profile-allow($config, $group-id)
      (: returns the profile-allow setting configured on the task server :)
admin:taskserver-get-queue-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the number queue size configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-queue-size($config, $group-id)
      (: returns the queue size configured on the task server :)
admin:taskserver-get-threads(
| $config as element(configuration),
| $group-id as xs:unsignedLong
) as xs:unsignedInt
Summary: This function returns the number of threads configured on the task server for the specified group.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
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 $group-id := admin:group-get-id($config, "Default")
      return
      admin:taskserver-get-threads($config, $group-id)
      (: returns the number of threads configured on the task server :)
admin:taskserver-set-debug-allow(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the value for the debug allow setting for the task server in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new boolean value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-debug-allow($config, $groupid, fn:true())
      (: 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.  :)
admin:taskserver-set-debug-threads(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value in the configuration of the maximum number of debug threads for the specified task server. This is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new threads value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-debug-threads($config, $groupid, 10)
      (: 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.  :)
admin:taskserver-set-default-time-limit(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the task server default time limit in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the time limit (specified the number of seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-default-time-limit($config, $groupid, 10000)
      (: 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.  :)
admin:taskserver-set-log-errors(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the value for the log errors setting for the task server in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new boolean value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-log-errors($config, $groupid, 1000)
      (: 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.  :)
admin:taskserver-set-max-time-limit(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the task server max time limit in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the max time limit (specified the number of seconds).
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-max-time-limit($config, $groupid, 10000)
      (: 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.  :)
admin:taskserver-set-post-commit-trigger-depth(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value for the task server post-commit trigger depth in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new post-commit trigger depth.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-post-commit-trigger-depth($config, $groupid, 1000)
      (: 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.  :)
admin:taskserver-set-pre-commit-trigger-depth(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value for the task server pre-commit trigger depth in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-pre-commit-trigger-depth($config, $groupid, 1000)
      (: 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.  :)
admin:taskserver-set-pre-commit-trigger-limit(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value for the task server pre-commit trigger depth in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-pre-commit-trigger-depth($config, $groupid, 1000)
      (: 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.  :)
admin:taskserver-set-profile-allow(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:boolean
) as element(configuration)
Summary: This function sets the value for the profile allow setting for the task server in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new boolean value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-profile-allow($config, $groupid, fn:true())
      (: 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.  :)
admin:taskserver-set-queue-size(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value in the configuration of the maximum queue size for the specified task server. This is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new value for the queue size.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-queue-size($config, $groupid, 100000)
      (: 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.  :)
admin:taskserver-set-threads(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $value as xs:unsignedInt
) as element(configuration)
Summary: This function sets the value in the configuration of the maximum number of threads for the specified task server. This is a "cold" operation; when you use `admin:save-configuration` to save the configuration, it will automatically restart MarkLogic Server.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$value : The new threads value.
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 $groupid := admin:group-get-id($config, "Default")
      return
      admin:taskserver-set-threads($config, $groupid, 10)
      (: 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.  :)
admin:webdav-server-create(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $appserver-name as xs:string,
| $root as xs:string,
| $port as xs:unsignedLong,
| $database-id as xs:unsignedLong
) as element(configuration)
Summary: This function creates a new WebDAV App Server with the specified name, library, and port in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$appserver-name : The name of the App Server. The name must be unique among the App Server names for the group.
$root : The root of the App Server.
$port : The port on which the App Server listens. The port must be available on the host.
$database-id : The id of the database (for example, `xdmp:database("myDatabase")`).
Usage Notes: Any group or database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the group and/or database, do so in a separate transaction before using them in in this function.
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 $groupid := admin:group-get-id($config, "myGroup")
      return
      admin:webdav-server-create($config, $groupid, "myNewAppServer",
            "/space/mycode", 8005, xdmp:database("myDatabase") )
      (: 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.  :)
admin:xdbc-server-create(
| $config as element(configuration),
| $group-id as xs:unsignedLong,
| $appserver-name as xs:string,
| $root as xs:string,
| $port as xs:unsignedLong,
| $modules-id as item(),
| $database-id as xs:unsignedLong
) as element(configuration)
Summary: This function creates a new XDBC App Server with the specified name, root, and port in the configuration.
Parameters:
$config : A configuration specification, typically as returned from one of the Admin module functions.
$group-id : The ID of the group to which the App Server belongs. Typically, this is the result of an `admin:group-get-id` call.
$appserver-name : The name of the App Server. The name must be unique among the App Server names for the group.
$root : The path to the module directory root of this XDBC server.
$port : The port on which the App Server listens. The port must be available on the host.
$modules-id : The id of the modules database (for example, `xdmp:database("Modules")`). To specify the filesystem, use 0 or "file-system"
$database-id : The id of the database (for example, `xdmp:database("myDatabase")`).
Usage Notes: Any group or database whose ID you pass into this function must exist when the transaction begins, otherwise an exception is thrown. If you need to create the group and/or database, do so in a separate transaction before using them in in this function.
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 $groupid := admin:group-get-id($config, "myGroup")
      return
      admin:xdbc-server-create($config, $groupid, "myNewAppServer",
            "/space/mycode", 8005, 0, xdmp:database("myDatabase") )
      (: 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.  :)

© Copyright 2002-2012 MarkLogic Corporation. All rights reserved.