MarkLogic Server 11.0 Product Documentationadmin functions (appserver)
For the complete list of functions and categories in this namespace, refer to the main admin functions page.
179 functions
| Function name | Description |
|---|---|
| admin.appserverAddModuleLocation | Add one or more module namespace to location mappings to an App Server configuration. |
| admin.appserverAddNamespace | 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.appserverAddRequestBlackout | This function adds a request blackout specification for a appserver to a configuration. |
| admin.appserverAddSchema | This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified App Server. |
| admin.appserverAddUsingNamespace | 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.appserverAppserverGetEnableHstsHeader | This function returns true if the specified App Server is configured to include HSTS header in HTTPS response. |
| admin.appserverAppserverGetHstsHeaderMaxAge | This function returns the App Server's configured max-age directive for HSTS header. |
| admin.appserverCopy | This function creates a new App Server specification with the same settings as the App Server with the specified ID. |
| admin.appserverDelete | This function deletes one or more App Servers in the configuration. |
| admin.appserverDeleteModuleLocation | Delete one or more module location bindings from an App Server configuration. |
| admin.appserverDeleteNamespace | This function deletes a namespace configuration from the configuration for the specified App Server. |
| admin.appserverDeleteRequestBlackout | This function deletes a request blackout specification for a appserver from a configuration. |
| admin.appserverDeleteSchema | This function deletes a schema definition in the configuration for the specified App Server. |
| admin.appserverDeleteUsingNamespace | Delete one or more "using" namespaces from an App Server configuration. |
| admin.appserverExists | This function determines whether or not the specified App Server (HTTP, XDBC, or ODBC) exists. |
| admin.appserverGetAddress | This function returns the IP address of the App Server configuration. |
| admin.appserverGetAuthentication | This function returns the authentication scheme (basic, digest, digestbasic, or application-level) configured for the specified App Server. |
| admin.appserverGetBacklog | This function returns the socket listen backlog setting for the specified App Server. |
| admin.appserverGetCollation | This function returns the collation URI set in the configuration for the specified App Server. |
| admin.appserverGetComputeContentLength | This function returns the value of whether the WebDAV server computes content length. |
| admin.appserverGetConcurrentRequestLimit | This function returns the concurrent request limit for any user for the specified App Server. |
| admin.appserverGetConnectionTimeout | This function returns the connection timeout value configured for the specified App Server; the value applies only to an ODBC server. |
| admin.appserverGetCoordinateSystem | Get the default coordinate system for an App Server. |
| admin.appserverGetDatabase | This function returns the ID of the database to which the App Server is set to execute queries against for the specified database. |
| admin.appserverGetDebugAllow | 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.appserverGetDefaultErrorFormat | This function returns the default format for protocol errors for an App Server. |
| admin.appserverGetDefaultInferenceSize | This function returns the default amount of memory (in megabytes) that can be used by sem:store for inference. |
| admin.appserverGetDefaultQueryTimeLimit | 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.appserverGetDefaultTimeLimit | This function returns the default time limit value configured for the specified App Server. |
| admin.appserverGetDefaultUser | This function returns the default user value configured for the specified App Server. |
| admin.appserverGetDefaultXqueryVersion | This function returns the value of the default xquery version configured for the specified App Server. |
| admin.appserverGetDisplayLastLogin | This function returns the value of the whether or not the appserver should display users' last login information. |
| admin.appserverGetDistributeTimestamps | This function returns the value of the distribute timestamps control option configured for the specified App Server. |
| admin.appserverGetEnabled | This function returns the enabled state for the specified App Server. |
| admin.appserverGetErrorHandler | This function returns the path to the error handler configured for this App Server. |
| admin.appserverGetExternalSecurity | This function returns the external security setting for the specified App Server. |
| admin.appserverGetFileLogLevel | This function returns the value for the file log level configured for a specified App Server. |
| admin.appserverGetGroupId | This function returns the ID of the specified App Server's group. |
| admin.appserverGetHostIds | This function returns the ID(s) of the hosts the specified App Server's is currently running on. |
| admin.appserverGetId | This function returns the ID of the specified App Server (HTTP, XDBC, or ODBC). |
| admin.appserverGetInternalSecurity | This function returns the internal security setting for the specified App Server. |
| admin.appserverGetKeepAliveTimeout | This function returns the keep alive timeout value configured for the specified App Server. |
| admin.appserverGetLastLogin | This function returns the ID of the database to which the App Server stores users' last login information. |
| admin.appserverGetLogErrors | 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.appserverGetMaxInferenceSize | This function returns the maximum amount of memory in megabytes that can be used by sem:store for inference. |
| admin.appserverGetMaxQueryTimeLimit | 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.appserverGetMaxTimeLimit | This function returns the max time limit value configured for the specified App Server. |
| admin.appserverGetModuleLocations | This function returns the value of any module locations predefined for the specified App Server. |
| admin.appserverGetModulesDatabase | This function returns the ID of the database set as the modules database for the specified database. |
| admin.appserverGetMultiVersionConcurrencyControl | This function returns the value of the multi version concurrency control option configured for the specified App Server. |
| admin.appserverGetName | This function returns the name of the appserver with the specified ID. |
| admin.appserverGetNamespaces | This function returns the value of any namespace definitions predefined for the specified App Server. |
| admin.appserverGetOutputByteOrderMark | This function returns the value for the output byte order mark setting for the specified App Server. |
| admin.appserverGetOutputCdataSectionLocalname | This function returns the value for the output CDATA section localname setting for the specified App Server. |
| admin.appserverGetOutputCdataSectionNamespaceUri | This function returns the value for the output CDATA section namespace URI setting for the specified App Server. |
| admin.appserverGetOutputDoctypePublic | This function returns the value for the public doctype output setting for the specified App Server. |
| admin.appserverGetOutputDoctypeSystem | This function returns the value for the system doctype output setting for the specified App Server. |
| admin.appserverGetOutputEncoding | This function returns the value for the output encoding setting for the specified App Server. |
| admin.appserverGetOutputEscapeUriAttributes | This function returns the value for the output escape URI attributes setting for the specified App Server. |
| admin.appserverGetOutputIncludeContentType | This function returns the value for the output include content type setting for the specified App Server. |
| admin.appserverGetOutputIncludeDefaultAttributes | This function returns the value for the output include default attributes setting for the specified App Server. |
| admin.appserverGetOutputIndent | This function returns the value for the output indent setting for the specified App Server. |
| admin.appserverGetOutputIndentTabs | This function returns the value for the output indent tab settings for the specified App Server. |
| admin.appserverGetOutputIndentUntyped | This function returns the value for the output indent untyped setting for the specified App Server. |
| admin.appserverGetOutputMediaType | This function returns the value for the output media type setting for the specified App Server. |
| admin.appserverGetOutputMethod | This function returns the value for the default output serialization method setting for the specified App Server. |
| admin.appserverGetOutputNormalizationForm | This function returns the value for the output normalization form setting for the specified App Server. |
| admin.appserverGetOutputOmitXmlDeclaration | This function returns the value for the output omit XML declaration setting for the specified App Server. |
| admin.appserverGetOutputSgmlCharacterEntities | This function returns the value for the output sgml character entities setting for the specified App Server. |
| admin.appserverGetOutputStandalone | This function returns the value for the output standalone setting for the specified App Server. |
| admin.appserverGetOutputUndeclarePrefixes | This function returns the value for the output undeclare prefixes setting for the specified App Server. |
| admin.appserverGetOutputVersion | This function returns the value for the output version setting for the specified App Server. |
| admin.appserverGetPort | This function returns the port for the specified App Server. |
| admin.appserverGetPreCommitTriggerDepth | This function returns the pre commit trigger depth value configured for the specified App Server. |
| admin.appserverGetPreCommitTriggerLimit | This function returns the pre commit trigger limit value configured for the specified App Server. |
| admin.appserverGetPrivilege | This function returns the privilege ID for the specified App Server. |
| admin.appserverGetProfileAllow | 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.appserverGetRequestBlackouts | This function returns the request blackouts specification for the specified appserver from the configuration. |
| admin.appserverGetRequestTimeout | This function returns the request timeout value configured for the specified App Server. |
| admin.appserverGetRewriteResolvesGlobally | 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.appserverGetRoot | This function returns the root for the specified App Server. |
| admin.appserverGetSchemas | This function returns the value of any schemas definitions predefined for the specified App Server. |
| admin.appserverGetSessionTimeout | This function returns the session timeout value configured for the specified App Server. |
| admin.appserverGetSslAllowSslv3 | This function is deprecated and will be removed in a future release. |
| admin.appserverGetSslAllowTls | This function returns true if the TLS protocol is enabled for the specified App Server, or false if TLS is disabled. |
| admin.appserverGetSslCertificateTemplate | This function returns the id of the SSL certificate template used by the specified App Server. |
| admin.appserverGetSslCiphers | This function returns the SSL ciphers set for the App Server. |
| admin.appserverGetSslClientCertificateAuthorities | This function returns the id(s) of the client certificate authority for the specified App Server. |
| admin.appserverGetSslClientIssuerAuthorityVerification | This function returns true if the App Server only accepts client certificates signed directly by a selected CA in the Admin Interface. |
| admin.appserverGetSslDisabledProtocols | This function returns the disabled protocols for the specified App Server. |
| admin.appserverGetSslHostname | This function returns the SSL hostname for the specified App Server. |
| admin.appserverGetSslRequireClientCertificate | This function returns true if a client certificate is required for the specified App Server. |
| admin.appserverGetStaticExpires | 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.appserverGetThreads | This function returns the maximum number of threads configured for the specified App Server on each host in the group. |
| admin.appserverGetType | This function returns the type of appserver with the specified ID. |
| admin.appserverGetUrlRewriter | This function returns the path to the URL rewriter configured for this App Server. |
| admin.appserverGetUsingNamespaces | This function returns the value of any "using" namespaces predefined for the specified App Server. |
| admin.appserverOneTimeRequestBlackout | This function constructs a one-time request-blackout specification. |
| admin.appserverRecurringRequestBlackout | This function constructs a request-blackout specification. |
| admin.appserverSetAddress | This function changes the IP Address in the configuration for the specified App Server to the specified address. |
| admin.appserverSetAuthentication | This function sets the authentication scheme in the configuration for the specified App Server. |
| admin.appserverSetBacklog | 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.appserverSetCollation | This function sets the default collation in the configuration for the specified App Server. |
| admin.appserverSetComputeContentLength | This function changes the value whether a WebDAV server computes content length. |
| admin.appserverSetConcurrentRequestLimit | This function sets the limit on concurrent requests that any user may have on a particular appserver. |
| admin.appserverSetConnectionTimeout | 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.appserverSetCoordinateSystem | Set the default geospatial coordinate system for an App Server. |
| admin.appserverSetDatabase | This function sets the value in the configuration of the database for the specified App Server. |
| admin.appserverSetDebugAllow | This function sets the debug allow setting in the configuration for the specified App Server. |
| admin.appserverSetDefaultErrorFormat | This function sets the default format protocol errors for an App Server. |
| admin.appserverSetDefaultInferenceSize | This function specifies the default value for any request's inference size. |
| admin.appserverSetDefaultQueryTimeLimit | 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.appserverSetDefaultTimeLimit | 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.appserverSetDefaultUser | This function sets the default user (for use with application-level authentication) in the configuration for the specified App Server. |
| admin.appserverSetDefaultXqueryVersion | This function sets the default XQuery version setting in the configuration for this App Server. |
| admin.appserverSetDisplayLastLogin | This function sets the display last login setting in the configuration for the specified App Server. |
| admin.appserverSetDistributeTimestamps | This function sets the distribute timestamps control value in the configuration for this App Server. |
| admin.appserverSetEnabled | This function sets the enabled state in the configuration for the specified App Server. |
| admin.appserverSetEnableHstsHeader | This function sets if HSTS header will be included in HTTPS response. |
| admin.appserverSetErrorHandler | This function sets the value of the path to the error handler in the configuration for the specified App Server. |
| admin.appserverSetExternalSecurity | This function sets the external security setting in the configuration for the specified App Server. |
| admin.appserverSetFileLogLevel | This function changes the host file log level setting for the specified App Server. |
| admin.appserverSetHstsHeaderMaxAge | This function sets the value of max-age directive in HSTS header for the specified App Server |
| admin.appserverSetInternalSecurity | This function sets the internal security setting in the configuration for the specified App Server. |
| admin.appserverSetKeepAliveTimeout | 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.appserverSetLastLogin | This function sets the value in the configuration of the last login database for the specified App Server. |
| admin.appserverSetLogErrors | This function sets the log errors setting in the configuration for the specified App Server. |
| admin.appserverSetMaxInferenceSize | This function specifies the upper bound for any request's inference size. |
| admin.appserverSetMaxQueryTimeLimit | 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.appserverSetMaxTimeLimit | 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.appserverSetModulesDatabase | This function sets the value in the configuration of modules database for the specified App Server to the specified database ID. |
| admin.appserverSetMultiVersionConcurrencyControl | This function sets the multi version concurrency control value in the configuration for this App Server. |
| admin.appserverSetName | This function changes the name of an existing App Server to the newly specified value. |
| admin.appserverSetOutputByteOrderMark | 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.appserverSetOutputCdataSectionLocalname | This function sets the default element localname or list of element localnames to be output as CDATA sections for the specified App Server. |
| admin.appserverSetOutputCdataSectionNamespaceUri | This function sets the namespace URI for any CDATA section localnames configured for the specified App Server. |
| admin.appserverSetOutputDoctypePublic | This function configures a default public identifier to use on the emitted DOCTYPE for the specified App Server. |
| admin.appserverSetOutputDoctypeSystem | This function configures a default system identifier to use on the emitted DOCTYPE for the specified App Server. |
| admin.appserverSetOutputEncoding | This function sets the value for the default output encoding in the configuration for the specified App Server. |
| admin.appserverSetOutputEscapeUriAttributes | 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.appserverSetOutputIncludeContentType | This function configures whether or not to include the content-type declaration when serializing nodes for the specified App Server. |
| admin.appserverSetOutputIncludeDefaultAttributes | This function configures whether for the specified App Server, attributes defaulted with a schema should be included in the serialization. |
| admin.appserverSetOutputIndent | 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.appserverSetOutputIndentTabs | 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.appserverSetOutputIndentUntyped | 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.appserverSetOutputMediaType | This function sets the default serialization media type for the specified App Server. |
| admin.appserverSetOutputMethod | This function configures the default output serialization method for the specified App Server. |
| admin.appserverSetOutputNormalizationForm | This function sets a Unicode normalization form to be applied by default to serialized output for the specified App Server. |
| admin.appserverSetOutputOmitXmlDeclaration | This function configures whether serialized output for the specified App Server should omit the inclusion of an XML declaration by default. |
| admin.appserverSetOutputSgmlCharacterEntities | This function sets the SGML character entity output setting in the configuration for the specified App Server. |
| admin.appserverSetOutputStandalone | This function configures whether for the specified App Server an XML declaration in serialized output should include a standalone attribute by default. |
| admin.appserverSetOutputUndeclarePrefixes | 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.appserverSetOutputVersion | This function stipulates a version of the default serialization method associated with the specified App Server. |
| admin.appserverSetPort | This function changes the port in the configuration for the specified App Server to the specified number. |
| admin.appserverSetPreCommitTriggerDepth | 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 specified App Server. |
| admin.appserverSetPreCommitTriggerLimit | 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.appserverSetPrivilege | This function sets an execute privilege in the configuration for the specified App Server. |
| admin.appserverSetProfileAllow | This function sets the profile allow setting in the configuration for the specified App Server. |
| admin.appserverSetRequestTimeout | 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.appserverSetRewriteResolvesGlobally | 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.appserverSetRoot | This function changes the root for a specified App Server to the newly specified value. |
| admin.appserverSetSessionTimeout | This function sets the session timeout value (in seconds) in the configuration for the specified App Server. |
| admin.appserverSetSslAllowSslv3 | This function is deprecated and will be removed in a future release. |
| admin.appserverSetSslAllowTls | This function enables or disables the TLS protocol for the specified App Server. |
| admin.appserverSetSslCertificateTemplate | This function sets an SSL certificate template for the specified App Server. |
| admin.appserverSetSslCiphers | This function sets SSL ciphers for the specified App Server. |
| admin.appserverSetSslClientCertificateAuthorities | This function sets one or more client certificate authorities that sign client certificates for the specified App Server. |
| admin.appserverSetSslClientIssuerAuthorityVerification | 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.appserverSetSslDisabledProtocols | This function sets the disabled protocols for the specified App Server. |
| admin.appserverSetSslHostname | This function sets an SSL hostname for the specified App Server. |
| admin.appserverSetSslRequireClientCertificate | This function determines whether or not a client certificate is required for the specified App Server. |
| admin.appserverSetStaticExpires | This function changes the value of the "expires" HTTP header for a specified App Server to the newly specified value. |
| admin.appserverSetThreads | This function sets the value in the configuration of the maximum number of threads per host for the specified App Server. |
| admin.appserverSetUrlRewriter | This function sets the value of the path to the URL rewriter in the configuration for the specified App Server. |
| admin.getAppserverIds | This function returns all the appserver IDs from the configuration. |
| admin.httpServerCreate | This function creates a new HTTP App Server with the specified name, root, and port in the configuration. |
| admin.odbcServerCreate | This function creates a new ODBC App Server with the specified name, root, and port in the configuration. |
| admin.webdavServerCreate | This function creates a new WebDAV App Server with the specified name, library, and port in the configuration. |
| admin.xdbcServerCreate | This function creates a new XDBC App Server with the specified name, root, and port in the configuration. |