Loading TOC...

admin functions

The table below lists all the admin built-in functions (in this namespace: http://marklogic.com/xdmp/admin).

You can also view these functions broken down by category:

The Admin module is an XQuery library module that enables 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 a user with the 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.

960 functions
Function name Description
admin:appserver-add-module-location Add one or more module namespace to location mappings to an App Server configuration.
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-add-using-namespace Add one or more "using" namespaces to an App Server configuration, which add the namespaces to the namespace path for all requests evaluated against that 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-module-location Delete one or more module location bindings from an App Server 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-delete-using-namespace Delete one or more "using" namespaces from an App Server configuration.
admin:appserver-exists This function determines whether or not the specified App Server (HTTP, XDBC, or ODBC) 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-connection-timeout This function returns the connection timeout value configured for the specified App Server; the value applies only to an ODBC server.
admin:appserver-get-coordinate-system Get the default coordinate system for an 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-error-format This function returns the default format for protocol errors for an App Server.
admin:appserver-get-default-inference-size This function returns the default amount of memory (in megabytes) that can be used by sem:store for inference.
admin:appserver-get-default-query-time-limit This function returns the default SQL query time limit value configured for the specified App Server; the value applies only to an ODBC server.
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-distribute-timestamps This function returns the value of the distribute timestamps control option configured for the specified App Server.
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-external-security This function returns the external security setting for the specified App Server.
admin:appserver-get-file-log-level This function returns the value for the file log level configured for a specified 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 (HTTP, XDBC, or ODBC).
admin:appserver-get-internal-security This function returns the internal security setting for 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-inference-size This function returns the maximum amount of memory in megabytes that can be used by sem:store for inference.
admin:appserver-get-max-query-time-limit This function returns the max SQL query time limit value configured for the specified App Server; the value applies only to an ODBC server.
admin:appserver-get-max-time-limit This function returns the max time limit value configured for the specified App Server.
admin:appserver-get-module-locations This function returns the value of any module locations predefined 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-multi-version-concurrency-control This function returns the value of the multi version concurrency control option configured for the specified App Server.
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-opsdirector-applog-level This function returns the value for the Ops Director application log level configured for a specified App Server.
admin:appserver-get-output-byte-order-mark This function returns the value for the output byte order mark setting for the specified App Server.
admin:appserver-get-output-cdata-section-localname This function returns the value for the output CDATA section localname setting for the specified App Server.
admin:appserver-get-output-cdata-section-namespace-uri This function returns the value for the output CDATA section namespace URI setting for the specified App Server.
admin:appserver-get-output-doctype-public This function returns the value for the public doctype output setting for the specified App Server.
admin:appserver-get-output-doctype-system This function returns the value for the system doctype output setting 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-escape-uri-attributes This function returns the value for the output escape URI attributes setting for the specified App Server.
admin:appserver-get-output-include-content-type This function returns the value for the output include content type setting for the specified App Server.
admin:appserver-get-output-include-default-attributes This function returns the value for the output include default attributes setting for the specified App Server.
admin:appserver-get-output-indent This function returns the value for the output indent setting for the specified App Server.
admin:appserver-get-output-indent-tabs This function returns the value for the output indent tab settings for the specified App Server.
admin:appserver-get-output-indent-untyped This function returns the value for the output indent untyped setting for the specified App Server.
admin:appserver-get-output-media-type This function returns the value for the output media type setting for the specified App Server.
admin:appserver-get-output-method This function returns the value for the default output serialization method setting for the specified App Server.
admin:appserver-get-output-normalization-form This function returns the value for the output normalization form setting for the specified App Server.
admin:appserver-get-output-omit-xml-declaration This function returns the value for the output omit XML declaration 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-output-standalone This function returns the value for the output standalone setting for the specified App Server.
admin:appserver-get-output-undeclare-prefixes This function returns the value for the output undeclare prefixes setting for the specified App Server.
admin:appserver-get-output-version This function returns the value for the output version 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-rewrite-resolves-globally This function gets the value for the rewrite-resolves-globally property, which allows rewritten URLs to be resolved from the marklogic-dir/Modules directory as well as from the App Server root.
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-client-issuer-authority-verification This function returns true if the App Server only accepts client certificates signed directly by a selected CA in the Admin Interface.
admin:appserver-get-ssl-disabled-protocols This function returns the disabled protocols 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 on each host in the group.
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-get-using-namespaces This function returns the value of any "using" namespaces predefined for the specified 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-connection-timeout This function sets the connection timeout value (in seconds) in the configuration for the specified App Server; the value applies only to an ODBC server.
admin:appserver-set-coordinate-system Set the default geospatial coordinate system for an App Server.
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-error-format This function sets the default format protocol errors for an App Server.
admin:appserver-set-default-inference-size This function specifies the default value for any request's inference size.
admin:appserver-set-default-query-time-limit This function sets the default SQL query time limit (the maximum total amount of time to service a SQL query before the App Server throws a timeout exception) in the configuration for the specified App Server; the value applies only to an ODBC 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-distribute-timestamps This function sets the distribute timestamps control value in the configuration for this 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-external-security This function sets the external security setting in the configuration for the specified App Server.
admin:appserver-set-file-log-level This function changes the host file log level setting for the specified App Server.
admin:appserver-set-internal-security This function sets the internal security setting 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-inference-size This function specifies the upper bound for any request's inference size.
admin:appserver-set-max-query-time-limit This function sets the max SQL query time limit (the maximum total amount of time to service a SQL query before the App Server throws a timeout exception) in the configuration for the specified App Server; the value applies only to an ODBC 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-multi-version-concurrency-control This function sets the multi version concurrency control value in the configuration for this App Server.
admin:appserver-set-name This function changes the name of an existing App Server to the newly specified value.
admin:appserver-set-opsdirector-applog-level This function changes the Ops Director application log level setting for the specified App Server.
admin:appserver-set-output-byte-order-mark This function configures whether for the specified App Server the output sequence of octets is or is not to be preceded by a byte order mark by default.
admin:appserver-set-output-cdata-section-localname This function sets the default element localname or list of element localnames to be output as CDATA sections for the specified App Server.
admin:appserver-set-output-cdata-section-namespace-uri This function sets the namespace URI for any CDATA section localnames configured for the specified App Server.
admin:appserver-set-output-doctype-public This function configures a default public identifier to use on the emitted DOCTYPE for the specified App Server.
admin:appserver-set-output-doctype-system This function configures a default system identifier to use on the emitted DOCTYPE for the specified App Server.
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-escape-uri-attributes This function configures whether or not to apply Unicode normalization, percent-encoding, and HTML escaping when serializing URI attributes by default for the specified App Server.
admin:appserver-set-output-include-content-type This function configures whether or not to include the content-type declaration when serializing nodes for the specified App Server.
admin:appserver-set-output-include-default-attributes This function configures whether for the specified App Server, attributes defaulted with a schema should be included in the serialization.
admin:appserver-set-output-indent This function configures whether or not to pretty-print (indent) typed XML (that is, XML for which there is an in-scope schema) output for the specified App Server.
admin:appserver-set-output-indent-tabs This function configures whether or not to set tabs (indent) in typed XML output(that is, XML for which there is an in-scope schema) for the specified App Server.
admin:appserver-set-output-indent-untyped This function configures whether or not to pretty-print (indent) untyped XML (that is, XML for which there is no in-scope schema) output for the specified App Server.
admin:appserver-set-output-media-type This function sets the default serialization media type for the specified App Server.
admin:appserver-set-output-method This function configures the default output serialization method for the specified App Server.
admin:appserver-set-output-normalization-form This function sets a Unicode normalization form to be applied by default to serialized output for the specified App Server.
admin:appserver-set-output-omit-xml-declaration This function configures whether serialized output for the specified App Server should omit the inclusion of an XML declaration by default.
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-output-standalone This function configures whether for the specified App Server an XML delcaration in serialized output should include a standalone attribute by default.
admin:appserver-set-output-undeclare-prefixes This function configures whether by default, serialization for the specified App Server should undeclare the namespace prefix of any child element that does not bind the prefix of its parent element.
admin:appserver-set-output-version This function stipulates a version of the default serialization method associated with 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-rewrite-resolves-globally This function sets the value for the rewrite-resolves-globally property, which allows rewritten URLs to be resolved from the marklogic-dir/Modules directory as well as from the App Server root.
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-client-issuer-authority-verification This function determines whether the App Server only accepts client certificates signed directly by a selected CA in the Admin Interface or client certificates that have a parent CA that is indirectly signed by one or more ancestor CAs selected in the Admin Interface (same as prior to MarkLogic 9.0-8).
admin:appserver-set-ssl-disabled-protocols This function sets the disabled protocols 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 per host 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:bucket-assignment-policy This function returns an element that represents the bucket assignment policy.
admin:can-commit-upgrade This function returns true if the cluster is ready to commit the upgrade, returns false otherwise.
admin:cluster-get-config-encryption This function returns the encryption setting at cluster level for configuration files.
admin:cluster-get-config-encryption-key-id This function returns the active encryption key ID used for encryption of configuration files.
admin:cluster-get-data-encryption This function returns the encryption setting at cluster level for user data.
admin:cluster-get-data-encryption-key-id This function returns the active encryption key ID used for encryption of data.
admin:cluster-get-effective-version This function returns the effective software version of this cluster.
admin:cluster-get-external-config-encryption-key-id This function returns the encryption key ID in the external KMS to use for encryption of configuration files.
admin:cluster-get-external-data-encryption-key-id This function returns the encryption key ID in the external KMS to use for encryption of data.
admin:cluster-get-external-logs-encryption-key-id This function returns the encryption key ID in the external KMS to use for encryption of log files.
admin:cluster-get-foreign-cluster-id This function returns the id of the specified foreign cluster.
admin:cluster-get-foreign-cluster-ids This function returns the ids of the foreign clusters.
admin:cluster-get-foreign-master-database This function is executed on a replica cluster to return the replication configuration for the specified local database from the specified foreign master cluster.
admin:cluster-get-foreign-replica-databases This function is executed on the master cluster to return the replication configuration for the specified local database to the specified foreign replica cluster.
admin:cluster-get-id This function returns the id of this cluster.
admin:cluster-get-internal-config-encryption-key-id This function returns the encryption key ID in the internal KMS to use for encryption of configuration files.
admin:cluster-get-internal-data-encryption-key-id This function returns the encryption key ID in the internal KMS to use for encryption of data.
admin:cluster-get-internal-logs-encryption-key-id This function returns the encryption key ID in the internal KMS to use for encryption of log files.
admin:cluster-get-keystore-backup-option This function is used to get the backup option for the embedded PKCS#11 wallet.
admin:cluster-get-keystore-host-name This function returns the first host name for the Keystore Management System.
admin:cluster-get-keystore-host-names This function returns all configured KMS host names.
admin:cluster-get-keystore-kmip-CA-path This function returns the path to the PEM encoded KMIP Certificate Authority (CA) used for authentication with the KMS
admin:cluster-get-keystore-kmip-certificate-path This function returns the path to PEM encoded KMIP certificate.
admin:cluster-get-keystore-kmip-key-path This function returns the path to the PEM encoded private key
admin:cluster-get-keystore-kms-type This function returns the encryption setting at cluster level for log files
admin:cluster-get-keystore-port This function returns the first port number to connect to the Keystore Management System.
admin:cluster-get-keystore-ports This function returns all the configured KMS ports.
admin:cluster-get-keystore-wallet-location This function returns the PKCS#11 wallet location if it has been set by cluster-set-keystore-wallet-location.
admin:cluster-get-language-baseline This function returns the language baseline of this cluster, either "legacy" or "ml9".
admin:cluster-get-logs-encryption This function returns the encryption setting at cluster level for log files.
admin:cluster-get-logs-encryption-key-id This function returns the active encryption key ID used for encryption of log files.
admin:cluster-get-name This function returns the name of this cluster.
admin:cluster-get-opsdirector-config This function returns the current frequency with which the managed cluster sends configuration changes to Ops Director.
admin:cluster-get-opsdirector-log-level This function returns the current Ops Director log level of the managed cluster.
admin:cluster-get-opsdirector-metering This function returns the current type of metering data the managed cluster sends to Ops Director.
admin:cluster-get-opsdirector-session-endpoint This function returns the session endpoint URI that the managed cluster uses to communicate with Ops Director.
admin:cluster-get-ssl-fips-enabled This function returns true when OpenSSL FIPS 140-2 mode is enabled in the cluster configuration.
admin:cluster-get-xdqp-bootstrap-hosts This function returns the ids of the bootstrap hosts configured for this cluster.
admin:cluster-get-xdqp-ssl-certificate This function returns the SSL certificate used to establish secure communication between this cluster and foreign clusters.
admin:cluster-get-xdqp-ssl-private-key This function returns the private key for secure communication between this cluster and foreign clusters.
admin:cluster-rotate-config-encryption-key-id This function rotates the encryption key ID to use for encryption of configuration files when MarkLogic is configured with internal KMS
admin:cluster-rotate-data-encryption-key-id This function rotates the encryption key ID to use for encryption of data when MarkLogic is configured with internal KMS
admin:cluster-rotate-logs-encryption-key-id This function rotates the encryption key ID to use for encryption of log files when MarkLogic is configured with internal KMS
admin:cluster-set-config-encryption This function sets the encryption setting at cluster level for configuration files.
admin:cluster-set-config-encryption-key-id This function sets the encryption key ID to use for encryption of configuration files
admin:cluster-set-data-encryption This function sets the encryption setting at cluster level for user data.
admin:cluster-set-data-encryption-key-id This function sets the encryption key ID to use for encryption of data.
admin:cluster-set-external-config-encryption-key-id This function sets the encryption key ID to use for encryption of configuration files when the kms-type is external.
admin:cluster-set-external-data-encryption-key-id This function sets the encryption key ID to use for encryption of data when the kms-type is external.
admin:cluster-set-external-logs-encryption-key-id This function sets the encryption key ID to use for encryption of log files when kms-type is external.
admin:cluster-set-keystore-backup-option This function is used to set the backup option for the embedded PKCS#11 wallet.
admin:cluster-set-keystore-host-name This function sets the host name for the Keystore Management System.
admin:cluster-set-keystore-host-names This function sets the host name(s) for the Keystore Management System.
admin:cluster-set-keystore-kmip-CA-path This function updates the path to the PEM encoded Certificate Authority (CA) used for authentication with the KMS.
admin:cluster-set-keystore-kmip-certificate-path This function updates the path for the PEM encoded KMIP certificate for this host
admin:cluster-set-keystore-kmip-key-path This function updates the path to the PEM encoded private key.
admin:cluster-set-keystore-kms-type This function sets the type of Keystore Management System (KMS) to be used.
admin:cluster-set-keystore-logs-encryption-passphrase MarkLogic supports encrypting the logs with a secondary encryption passphrase, this function can be used to set the passphrase.
admin:cluster-set-keystore-passphrase This function resets the MarkLogic PKCS#11 wallet protection passphrase
admin:cluster-set-keystore-port This function sets the port number to connect to the Keystore Management System.
admin:cluster-set-keystore-ports This function sets the port number(s) to connect to the Keystore Management System.
admin:cluster-set-keystore-wallet-location This function is used to set the PKCS#11 wallet location.
admin:cluster-set-language-baseline This function sets the language baseline for this cluster.
admin:cluster-set-logs-encryption This function sets the encryption setting at cluster level for log files.
admin:cluster-set-logs-encryption-key-id This function sets the encryption key ID to use for encryption of log files.
admin:cluster-set-name This function sets the name for this cluster.
admin:cluster-set-opsdirector-log-level This function sets Ops Director log level of the managed cluster.
admin:cluster-set-opsdirector-metering This function sets the type of metering data the managed cluster sends to Ops Director.
admin:cluster-set-opsdirector-session-endpoint This function sets the session endpoint URI that the managed cluster uses to communicate with Ops Director.
admin:cluster-set-ssl-fips-enabled This function enables or disables OpenSSL FIPS 140-2 mode for the cluster.
admin:cluster-set-xdqp-bootstrap-hosts This function sets the bootstrap hosts for the domestic cluster.
admin:cluster-set-xdqp-ssl-certificate This function sets the SSL certificate used to establish secure communication between this cluster and foreign clusters.
admin:cluster-set-xdqp-ssl-private-key This function sets the SSL private key for secure communication between this cluster and foreign clusters.
admin:database-add-backup This function adds scheduled backup specifications for a database to a configuration.
admin:database-add-default-ruleset This function adds a ruleset (db:ruleset) to be used for inference on a database.
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-paths This function adds given paths to the field specified by field-name.
admin:database-add-field-tokenizer-override This function adds tokenizer overrides for the specified field of the specified database.
admin:database-add-field-word-lexicon This function adds a word lexicon to the specified database in the configuration.
admin:database-add-foreign-replicas This function adds one or more replica databases to the database replication 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-geospatial-path-index This function adds a range path index to the specified database in the configuration.
admin:database-add-geospatial-region-path-index This function adds a geospatial region path 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-path-namespace Add one or more namespaces to a database configuration, which will predefine the namespace(s) for all XPath expressions used in range index definitions.
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-range-field-index This function adds a range field index to the specified database in the configuration.
admin:database-add-range-path-index This function adds a range path 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-attach-sub-database This function adds a sub-database to a super-database.
admin:database-backup-get-enabled This function returns true or false to indicate whether a specific backup is enabled for a database.
admin:database-backup-set-enabled This function enables database backup for 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 specification.
admin:database-daily-incremental-backup This function constructs a daily scheduled incremental database backup specification.
admin:database-delete This function deletes the configuration from the specified database(s).
admin:database-delete-all-range-field-indexes This function deletes all the range field indexes on given fields for the specified database in the configuration.
admin:database-delete-backup This function deletes scheduled backup specifications for a database from a configuration.
admin:database-delete-backup-by-id This function deletes a specific database backup, identified by the backup ID.
admin:database-delete-default-ruleset This function deletes the default ruleset used for inference on a database.
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-paths This function deletes paths from a specified field.
admin:database-delete-field-tokenizer-override This function deletes the field's tokenizer override 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-foreign-master This function removes the specified master database from the database replication configuration on the replica host.
admin:database-delete-foreign-replicas This function deletes the foreign replica database configurations for the specified master database.
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-geospatial-path-index This function deletes a geospatial path index for the specified database in the configuration.
admin:database-delete-geospatial-region-path-index This function deletes a geospatial region path index to the specified database in the configuration.
admin:database-delete-merge-blackout This function deletes a merge blackout specification for a database from a configuration.
admin:database-delete-path-namespace This function deletes the specified namespaces from the configuration for the specified database.
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-range-field-index This function deletes a range field index for the specified database in the configuration.
admin:database-delete-range-path-index This function deletes a range path 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-detach-sub-database This function removes a sub-database from a super-database.
admin:database-element-attribute-reference This function greated a db:element-attribute-reference specification.
admin:database-element-attribute-word-lexicon This function constructs an element attribute word lexicon specification.
admin:database-element-reference This function greated a db:element-reference 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-employ-forest This function "employs" the specified forest in the configuration.
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-field-path This function is a constructor for field-path element.
admin:database-field-reference This function creates a db:field-reference specification.
admin:database-foreign-master This function returns a master database configuration.
admin:database-foreign-master-get-cluster-id This function returns the id of the cluster from the specified foreign master configuration.
admin:database-foreign-master-get-connect-forests-by-name This function returns the connect-forests-by-name setting from the master database configuration.
admin:database-foreign-master-get-database-id This function returns the id of the foreign master database.
admin:database-foreign-replica This function returns a replica database configuration.
admin:database-foreign-replica-get-cluster-id This function returns the id of the replica cluster from the replica database configuration.
admin:database-foreign-replica-get-connect-forests-by-name This function returns the connect-forests-by-name setting from the replica database configuration.
admin:database-foreign-replica-get-database-id This function returns the id of the replica database from the replica database configuration.
admin:database-foreign-replica-get-lag-limit This function returns the lag limit value from the replica database configuration.
admin:database-foreign-replica-get-queue-size This function returns the queue size for the number of fragments or frames in-flight during database replication.
admin:database-foreign-replica-get-replication-enabled This function returns the enabled flag from the replica database configuration.
admin:database-foreign-replica-set-lag-limit This function sets the lag limit value on a replica database configuration.
admin:database-foreign-replica-set-queue-size This function sets the queue size for the number of fragments or frames in-flight during database replication.
admin:database-foreign-replica-set-replication-enabled This function sets the enabled flag on a replica database configuration.
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-geospatial-path-index This function constructs a geospatial path index specification.
admin:database-geospatial-region-path-index This function constructs a geospatial region path index specification.
admin:database-get-assignment-policy This function returns the assignment policy for the specified database from the configuration.
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-config-for-foreign-master-on-foreign-cluster This function returns the master configuration on a foreign cluster.
admin:database-get-config-for-foreign-replicas-on-foreign-cluster This function returns the replica configuration on a foreign cluster.
admin:database-get-data-encryption This function returns the encryption setting for the database ID by database-id.
admin:database-get-default-rulesets This function returns the default rulesets for a database.
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-encryption-key-id This function returns the encryption key ID used for encryption of data for the database identified by the database-id.
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-paths This function returns all the paths on a given field.
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-tokenizer-overrides This function fetches any custom tokenizer override specifications for the specified field and database.
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-value-positions This function gets the field value positions setting for the specified database in the configuration.
admin:database-get-field-value-searches This function returns the field value search setting for the specified field.
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-foreign-master This function returns the configuration for the foreign master database.
admin:database-get-foreign-replicas This function returns the configuration elements of the replica databases associated with the master database specified by database-id.
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-geospatial-path-indexes This function returns the geospatial path indexes specification(s) for the specified database from the configuration.
admin:database-get-geospatial-region-path-indexes This function returns the geospatial region path index specification(s) for the specified database in the configuration.
admin:database-get-id This function returns the ID for the specified database from the configuration.
admin:database-get-in-memory-geospatial-region-index-size This function returns the in memory geospatial region index size setting 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-in-memory-triple-index-size This function returns the in memory triple index size setting (in megabytes) 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-large-size-threshold This function returns the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs).
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-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-path-namespaces This function returns the value of any namespace definitions predefined for the specified database.
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-preload-replica-mapped-data This function returns the preload replica 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-field-indexes This function returns the range field 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-range-path-indexes This function returns the range path indexes specification(s) for the specified database from the configuration.
admin:database-get-range-policy-partition-key This function returns the range policy partition key set for the database.
admin:database-get-rebalancer-enable This function returns the rebalancer enable setting for the specified database from the configuration.
admin:database-get-rebalancer-throttle This function returns the rebalancer throttle 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-retain-until-backup This function returns the "retain until backup" setting from the configuration for the specified database.
admin:database-get-retired-forests This function returns the list of all retired forests 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-triple-index This function returns true if the triple index is enabled for the specified database, false if it is not enabled.
admin:database-get-triple-positions This function returns triple positions setting of a database.
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 an hourly scheduled database backup specification.
admin:database-hourly-incremental-backup This function constructs an hourly scheduled incremental database backup specification.
admin:database-in-use-path-namespace-prefixes This function returns the prefixes of all the namespaces that are in use by some path or geospatial path index.
admin:database-included-element This function constructs an included element specification.
admin:database-is-forest-employed This function returns fn:true() if the specificed forest is employed and fn:false() the specificed forest is not employed.
admin:database-is-forest-retired This function returns fn:true() if the specificed forest is retired and fn:false() the specificed forest is not retired.
admin:database-metadata-field This function constructs a metadata field specification.
admin:database-minutely-backup This function constructs a scheduled database backup specification on a number-of-minutes basis.
admin:database-minutely-incremental-backup This function constructs a scheduled incremental database backup specification based on a number of minutes.
admin:database-monthly-backup This function constructs a monthly scheduled backup specification.
admin:database-monthly-incremental-backup This function constructs a scheduled monthly incremental backup specification.
admin:database-one-time-backup This function constructs a one-time backup specification.
admin:database-one-time-incremental-backup This function constructs a one-time incremental backup specification.
admin:database-one-time-merge-blackout This function constructs a one-time merge-blackout specification.
admin:database-path-field This function constructs a field specification that has field paths.
admin:database-path-namespace This function constructs a namespace element with the specified prefix and URI.
admin:database-path-reference This function creates a db:path-reference 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-range-field-index This function constructs a range field index specification.
admin:database-range-path-index This function constructs a path range index specification.
admin:database-recurring-merge-blackout This function constructs a merge-blackout specification.
admin:database-reorder-forests This function reorders the forests in the specified database.
admin:database-retire-forest This function "retires" the specified forest in the configuration.
admin:database-ruleset The ruleset element (db:default-ruleset) created to be used for inference on a database.
admin:database-set-assignment-policy This function sets the assignment policy for the specified database in the configuration.
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-data-encryption This function sets the encryption setting for the database identified by database-id.
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-encryption-key-id This function sets the encryption key ID to use for encryption of data for the database identified by database-id.
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-value-positions This function sets the field value positions setting for the specified database in the configuration.
admin:database-set-field-value-searches This function sets the field value searches setting for the specified database 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-foreign-master This function configures the specified replica database to receive replicated data from the specified foreign master.
admin:database-set-foreign-replicas This function sets the foreign replica database configuration.
admin:database-set-format-compatibility This function sets the format compatibility setting for the specified database in the configuration.
admin:database-set-in-memory-geospatial-region-index-size This function sets the in-memory geospatial region index size 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-in-memory-triple-index-size This function sets the size, in megabytes, of the in-memory triple index.
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-large-size-threshold This function sets the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs).
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-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-preload-replica-mapped-data This function sets the preload-replica-mapped-data setting for the specified database.
admin:database-set-range-index-optimize This function sets the range index optimize setting for the specified database in the configuration.
admin:database-set-rebalancer-enable This function sets the reblanacer enable setting for the specified database in the configuration.
admin:database-set-rebalancer-throttle This function sets the rebalancer throttle 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-retain-until-backup This function sets "the retain until backup" setting in the configuration for the specified database.
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-triple-index This function sets the triple index on or off for a database.
admin:database-set-triple-positions This function sets the triple positions of a database to true or false.
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-sub-databases This function returns a database-reference element representing the sub-databases of the specified super-database.
admin:database-super-databases This function returns a database-reference element representing where the specified database serves as a sub-database.
admin:database-tokenizer-override This function constructs a custom tokenizer override.
admin:database-validate-field-path This function validates the specified field path.
admin:database-validate-field-paths This function checks if the paths conform to the permissible XPath syntax.
admin:database-validate-path-fields For a given sequence of fields, this function validates all the paths on each field using admin:database-validate-field-paths call.
admin:database-weekly-backup This function constructs a weekly scheduled backup specification.
admin:database-weekly-incremental-backup This function constructs a weekly scheduled incremental backup specification.
admin:database-word-lexicon This function constructs a word lexicon specification.
admin:foreign-cluster-create This function creates a complete configuration for a foreign cluster.
admin:foreign-cluster-delete This function deletes the configuration for the specified foreign cluster.
admin:foreign-cluster-get-bootstrap-hosts This function returns one or more configuration elements that identify the bootstrap hosts on the specified foreign cluster.
admin:foreign-cluster-get-host-timeout This function returns the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster.
admin:foreign-cluster-get-name This function returns the name of the foreign cluster.
admin:foreign-cluster-get-ssl-certificate This function returns the SSL certificate used to communicate with hosts in the foreign cluster.
admin:foreign-cluster-get-xdqp-ssl-allow-sslv3 This function returns true if the SSL v3 protocol is enabled for the foreign cluster.
admin:foreign-cluster-get-xdqp-ssl-allow-tls This function returns true if the TLS protocol is enabled for the foreign cluster.
admin:foreign-cluster-get-xdqp-ssl-ciphers This function returns the SSL ciphers set for the specified foreign cluster.
admin:foreign-cluster-get-xdqp-ssl-enabled This function returns true if SSL is enabled for the foreign cluster.
admin:foreign-cluster-get-xdqp-timeout This function returns the timeout setting (in seconds) for XDQP communication between data nodes and evaluator nodes in the domestic cluster and their counterparts in the foreign cluster.
admin:foreign-cluster-replace This function replaces a configuration for a foreign cluster with a new configuration.
admin:foreign-cluster-set-bootstrap-hosts This function identifies the foreign host to be used to bootstrap communication with the foreign cluster.
admin:foreign-cluster-set-host-timeout This function sets the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster.
admin:foreign-cluster-set-name This function sets the name of a foreign cluster.
admin:foreign-cluster-set-ssl-certificate This function sets the specified SSL certificate for secure communication with hosts in a foreign cluster.
admin:foreign-cluster-set-xdqp-ssl-allow-sslv3 This function enables or disables the SSL v3 protocol for the specified foreign cluster.
admin:foreign-cluster-set-xdqp-ssl-allow-tls This function enables or disables the TLS protocol for the specified foreign cluster.
admin:foreign-cluster-set-xdqp-ssl-ciphers This function sets SSL ciphers for the specified foreign cluster.
admin:foreign-cluster-set-xdqp-ssl-enabled This function enables or disables SSL for the foreign cluster.
admin:foreign-cluster-set-xdqp-timeout This function sets the timeout (in seconds) for XDQP communication between data nodes and evaluator nodes in the domestic cluster and their counterparts in the foreign cluster.
admin:foreign-host This function configures a foreign host to be set by the admin:foreign-cluster-set-bootstrap-hosts function as the bootstrap host for the foreign cluster.
admin:foreign-host-get-connect-port This function returns the number of the port configured for the foreign bootstrap host.
admin:foreign-host-get-id This function returns the id of the foreign bootstrap host.
admin:foreign-host-get-name This function returns the name of the foreign bootstrap host.
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-foreign-replicas This function adds the replica forest that is associated with the specified master forest to the database replication configuration.
admin:forest-add-replica This function adds a forest replica to a master forest.
admin:forest-backup-get-enabled This function returns true or false to indicate whether backup is enabled for the specified forest.
admin:forest-backup-set-enabled This function enables forest backup for the specified 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-backup-by-id This function deletes the forest backup specified by the forest ID.
admin:forest-delete-failover-host This function deletes the specified failover host(s) from the failover-host list in the specified configuration.
admin:forest-delete-foreign-master This function deletes the master forest associated with the specified replica forest from the database replication configuration.
admin:forest-delete-foreign-replicas This function deletes the foreign replica of the specified forest on the master host.
admin:forest-exists This function determines whether or not the specified forest exists.
admin:forest-foreign-master This function creates a replicaton configuration element for the specified master forest.
admin:forest-foreign-master-get-cluster-id This function returns the ID for the cluster from the foreign master forest configuration element.
admin:forest-foreign-master-get-database-id This function returns the id for the database from the foreign master forest configuration element.
admin:forest-foreign-master-get-forest-id This function returns the id for the forest from the foreign master forest configuration element.
admin:forest-foreign-replica This function returns a replica forest configuration.
admin:forest-foreign-replica-get-cluster-id This function returns the id of the replica cluster from the specified replica forest configuration element.
admin:forest-foreign-replica-get-database-id This function returns the id of the replica database from the specified replica forest configuration element.
admin:forest-foreign-replica-get-forest-id This function returns the id of the replica forest from the specified replica forest configuration element.
admin:forest-get-availability This function gets the availability state of the forest, for use in Tiered Storage.
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-fast-data-directory This function returns the directory path set in the fast data directory field for the specified forest.
admin:forest-get-fast-data-max-size This function returns maximum allowable size (in megabytes) of the data to be kept by the specified forest in its fast-data-directory, or 0 for no limit.
admin:forest-get-foreign-master This function returns the replication configuration for the master forest associated with the specified replica forest.
admin:forest-get-foreign-replicas This function returns the foreign replicas configuration element.
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-large-data-directory This function returns the name of the large data directory of the specified forest.
admin:forest-get-name This function returns the name of the specified forest, given the forest ID.
admin:forest-get-partition-number This function returns the partition number for the specified forest.
admin:forest-get-range-policy-lower-bound This function returns the lower bound of the range configured on the forest.
admin:forest-get-range-policy-upper-bound This function returns the upper bound of the range configured on the forest.
admin:forest-get-rebalancer-enable This function returns the rebalancer enable setting for the specified forest from the configuration.
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 specification.
admin:forest-is-range-policy-range-set This function returns fn:false() if the specificed forest has neither the lower boundary nor the upper boundary set.
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-rename This function renames a forest.
admin:forest-set-availability This function sets the availability state for a forest, for use in Tiered Storage.
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-fast-data-max-size This function sets the allowable size (in megabytes) for data to be kept by a forest in its fast data directory, or 0 for no limit.
admin:forest-set-foreign-master This function writes the specified foreign master forest configuration into the database replication configuration.
admin:forest-set-foreign-replicas This function writes the specified replica forest configuration into the database replication configuration.
admin:forest-set-host This function sets a forest configuration to a new host.
admin:forest-set-partition-number This function sets the partition number for the specified forest.
admin:forest-set-range-policy-range This function sets the boundaries of the range on a forest.
admin:forest-set-rebalancer-enable This function sets the reblanacer enable setting for the specified forest in the configuration.
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-module-location Add one or more module namespace to location mappings to a Group 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-add-using-namespace Add one or more "using" namespaces to a Group configuration, which add the namespaces to the namespace path for all requests evaluated against any App Server in the Group.
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-module-location Delete one or more module location bindings from a Group 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-scheduled-task-by-id This function deletes the scheduled tasks for a group using the group ID.
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-delete-using-namespace Delete one or more "using" namespaces from a Group 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-azure-storage-proxy This function returns the URL of the proxy server used by the group to access Azure blob storage.
admin:group-get-background-io-limit This function gets the value for the I/O background limit that controls the I/O resoources that I/O tasks (for example, merges) will consume.
admin:group-get-cache-sizing This function returns the cache sizing method set for the specified group.
admin:group-get-cntk-default-device This function returns the default computation device used by CNTK.
admin:group-get-cntk-gpu-id This function returns the CUDA ID of the GPU used by CNTK as the default computation device.
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-metering-enabled This function returns the value of the metering-enabled group setting.
admin:group-get-meters-database This function returns the ID of the meters-database configured for the specified group.
admin:group-get-module-cache-timeout This function returns the number of seconds a module can be unused before being flushed from caches.
admin:group-get-module-locations This function returns the value of any module locations predefined for 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-odbcserver-ids This function returns the ids of all of the ODBC App Servers in the specified group.
admin:group-get-performance-metering-enabled This function returns the value of the performance-metering-enabled group setting.
admin:group-get-performance-metering-period This function returns the value of the performance-metering-period group setting.
admin:group-get-performance-metering-retain-daily This function returns the value of the performance-metering-retain-daily group setting.
admin:group-get-performance-metering-retain-hourly This function returns the value of the performance-metering-retain-hourly group setting.
admin:group-get-performance-metering-retain-raw This function returns the value of the performance-metering-retain-raw group setting.
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-s3-domain This function gets the simple storage service internet domain name for hosts in the group.
admin:group-get-s3-protocol This function gets the simple storage service protocol for hosts in the group.
admin:group-get-s3-proxy This function returns the URL of the proxy server used by the group to access AWS S3 storage.
admin:group-get-s3-server-side-encryption This function gets the method of server side encryption for data at rest on the simple storage service.
admin:group-get-s3-server-side-encryption-kms-key This function gets the KMS key that is used by server side encryption for data at rest on the simple storage service.
admin:group-get-scheduled-task This function returns information about a scheduled task for a group based on the task ID and the group ID.
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-security-database This function returns the ID of the security database for the specified group from the configuration.
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-telemetry-config This function returns the currently set frequency for sending configuration file changes to telemetry.
admin:group-get-telemetry-log-level This function returns the current configured telemetry log level.
admin:group-get-telemetry-metering This function returns the configured detail level for collecting metering data sent to telemetry.
admin:group-get-telemetry-proxy This function returns the proxy server URL used by telemetry
admin:group-get-telemetry-session-endpoint This function returns the initial default telemetry endpoint.
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-triple-cache-partitions This function returns the number of triple cache partitions configured for the group.
admin:group-get-triple-cache-size This function returns the value of the triple cache size for the group.
admin:group-get-triple-cache-timeout This function gets the timeout value for the triple cache.
admin:group-get-triple-value-cache-partitions This function returns the number of triple value cache partitions configured for the group.
admin:group-get-triple-value-cache-size This function returns the size of triple value cache configured for the group.
admin:group-get-triple-value-cache-timeout This function gets the timeout value for the triple value cache.
admin:group-get-using-namespaces This function returns the value of any "using" namespaces predefined for 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-disabled-protocols This function returns the disabled protocols 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-module-location This function constructs a module namespace element with the specified namespace URI and location.
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-scheduled-task-get-enabled This function returns true or false to indicate whether a scheduled task for a group is enabled.
admin:group-scheduled-task-set-enabled This function enables one or more scheduled tasks for a group based on the group ID and task ID.
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-azure-storage-proxy This function sets the URL of the proxy server used by the group to access Azure blob storage.
admin:group-set-background-io-limit This function sets a limit on the amount of I/O that background tasks (for example, merges) will consume.
admin:group-set-cache-sizing This function sets the cache sizing method.
admin:group-set-cntk-default-device This function sets the default computation device used by CNTK.
admin:group-set-cntk-gpu-id This function sets the GPU to be used as the default computation device by CNTK, when group:cntk-default-device is set to gpu.
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-metering-enabled This function enables or disables usage metering for all hosts in the specified group.
admin:group-set-meters-database This function specifies the database to be used to store metering data.
admin:group-set-module-cache-timeout This function sets the number of seconds a module can be unused before being flushed from caches.
admin:group-set-name This function changes the name of the group with the specified ID to the specified name.
admin:group-set-performance-metering-enabled This function enables or disables performance metering for all hosts in the specified group.
admin:group-set-performance-metering-period This function sets the period (in number of seconds) between when performance data is gathered.
admin:group-set-performance-metering-retain-daily This function sets the number of days of performance metering data to retain.
admin:group-set-performance-metering-retain-hourly This function sets the number of days to retain hourly performance data.
admin:group-set-performance-metering-retain-raw This function sets the number of days of raw performance data to retain.
admin:group-set-retry-timeout This function changes 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-s3-domain This function sets the simple storage service internet domain name for hosts in the group.
admin:group-set-s3-protocol This function sets the simple storage service protocol for hosts in the group.
admin:group-set-s3-proxy This function sets the URL of the proxy server used by the group to access AWS S3 storage.
admin:group-set-s3-server-side-encryption This function gets the method of server side encryption for data at rest on the simple storage service.
admin:group-set-s3-server-side-encryption-kms-key This function sets the KMS key that is used by server side encryption for data at rest on the simple storage service.
admin:group-set-security-database This function sets the security database for a group to the specified database 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-telemetry-config This function sets the update frequency for configuation changes sent to telemetry, would also be the maximum frequency at which updates will be sent.
admin:group-set-telemetry-log-level This function sets the initial log level for telemetry, which is also the maximum (finest) log level that will be sent.
admin:group-set-telemetry-metering This function sets the level of metering data sent to telemetry.
admin:group-set-telemetry-proxy This function sets the proxy server URL used by telemetry
admin:group-set-telemetry-session-endpoint This function sets the initial session endpoint for telemetry.
admin:group-set-trace-events-activated This function changes the value for trace events in the group configuration.
admin:group-set-triple-cache-partitions This function sets the number of partitions to allocate for the triple index cache.
admin:group-set-triple-cache-size This function sets the number of triple cache partitions to allocate.
admin:group-set-triple-cache-timeout This function sets the timeout value for the triple cache.
admin:group-set-triple-value-cache-partitions This function sets the number of partitons to allocate for the triple value index cache.
admin:group-set-triple-value-cache-size This function sets the size of the value cache for the triple index.
admin:group-set-triple-value-cache-timeout This function sets the timeout value for the triple value cache.
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-disabled-protocols This function sets the disabled protocols 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-using-namespace This function constructs a using namespace element with the specified URI.
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-foreign-port This function returns the port used by the specified host to listen for communications from foreign hosts.
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-mode This function return the mode for the host with the specified ID
admin:host-get-mode-description This function return the mode description for the host with the specified ID
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-get-zone This function returns the zone for the host with the specified ID.
admin:host-set-foreign-port This function configures the specified domestic host to listen for communications from foreign hosts over the specified port.
admin:host-set-group This function changes the group to which an existing host belongs to the newly specified value.
admin:host-set-mode This function sets the mode and description for the host with the specified ID
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:host-set-zone This function changes the zone 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:legacy-assignment-policy This function returns an element that represents the legacy assignment policy.
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:odbc-server-create This function creates a new ODBC App Server with the specified name, root, and port in the configuration.
admin:query-assignment-policy This function returns an element that represents the query assignment policy.
admin:range-assignment-policy This function returns an element that represents the range assignment policy.
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:segment-assignment-policy This function returns an element that represents the segment assignment policy.
admin:statistical-assignment-policy This function returns an element that represents the statistical assignment policy.
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-inference-size This function returns the default amount of memory (in megabytes) that can be used by sem:store for inference.
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-file-log-level This function returns the value for the file log level 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-inference-size This function returns the maximum amount of memory in megabytes that can be used by sem:store for inference.
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-opsdirector-applog-level This function returns the value for the Ops Director application log level configured on the task server for the specified group.
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 for each host in the group.
admin:taskserver-set-default-inference-size This function specifies the default value for any request's inference size.
admin:taskserver-set-default-time-limit This function sets the task server default time limit in the configuration.
admin:taskserver-set-file-log-level This function changes the host file log level setting for the task server 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-inference-size This function specifies the upper bound for any request's inference size.
admin:taskserver-set-max-time-limit This function sets the task server max time limit in the configuration.
admin:taskserver-set-opsdirector-applog-level This function changes the Ops Director application log level setting for the task server 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 on each host in the group.
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.