MarkLogic 10 Product DocumentationJavaScript Functions By Category (3346)
The following table lists all Server-Side JavaScript functions
in the MarkLogic API reference,
including all built-in functions available to JavaScript.
3331 functions
| Function name | Description |
|---|---|
| AccessPlan.prototype.bind | This function adds new columns or modifies existing columns based on expressions while preserving existing unmodified columns in the row set. |
| AccessPlan.prototype.bindAs | This function is deprecated in favor of the bind() function and will not be supported in MarkLogic 11. |
| AccessPlan.prototype.col | This method identifies a column, where the column name is unique. |
| AccessPlan.prototype.except | This method restricts the left row set to rows where a row with the same columns and values doesn't exist in the right row set. |
| AccessPlan.prototype.existsJoin | This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. |
| AccessPlan.prototype.explain | This method returns a representation of the builtin execution plan. |
| AccessPlan.prototype.export | This method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload. |
| AccessPlan.prototype.facetBy | This method counts values for multiple grouping key columns. |
| AccessPlan.prototype.generateView | This method generates a view that encapsulates a query. |
| AccessPlan.prototype.groupBy | This method collapses a group of rows into a single row. |
| AccessPlan.prototype.groupByUnion | This method performs the union of multiple group-by operations on a row set. |
| AccessPlan.prototype.groupToArrays | This method performs multiple group-by operations on a row set and produces a single row with a column for each group having an array value whose items are the rows for the group. |
| AccessPlan.prototype.intersect | This method restricts the left row set to rows where a row with the same columns and values exists in the right row set. |
| AccessPlan.prototype.joinCrossProduct | This method yields one output row set that concatenates every left row with every right row. |
| AccessPlan.prototype.joinDoc | This function specifies a document column to add to the rows by reading the documents for an existing source column having a value of a document uri (which can be used to read other documents) or a fragment id (which can be used to read the source documents for rows). |
| AccessPlan.prototype.joinDocUri | This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row. |
| AccessPlan.prototype.joinFullOuter | This method yields one output row set with the rows from an inner join as well as the other rows from both the left and right row sets. |
| AccessPlan.prototype.joinInner | This method returns all rows from multiple tables where the join condition is met. |
| AccessPlan.prototype.joinLeftOuter | This method yields one output row set with the rows from an inner join as well as the other rows from the left row set. |
| AccessPlan.prototype.limit | This method specifies the maximum number of rows to be returned by this Plan. |
| AccessPlan.prototype.map | This method applies the specified function to each row returned by the plan to produce a different result row. |
| AccessPlan.prototype.notExistsJoin | This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. |
| AccessPlan.prototype.offset | This method returns a subset of the rows in the result set. |
| AccessPlan.prototype.offsetLimit | This method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the length limit. |
| AccessPlan.prototype.orderBy | This method sorts the row set by the specified order definition. |
| AccessPlan.prototype.prepare | This method prepares the specified plan for execution as an optional final step before execution. |
| AccessPlan.prototype.reduce | This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array. |
| AccessPlan.prototype.result | This method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan. |
| AccessPlan.prototype.sampleBy | This function samples rows from a view or from a pattern match on the triple index. |
| AccessPlan.prototype.select | This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set. |
| AccessPlan.prototype.union | This method yields all of the rows from the input row sets. |
| AccessPlan.prototype.where | This method restricts the row set to rows matched by the boolean expression. |
| AccessPlan.prototype.whereDistinct | This method removes duplicate rows from the row set. |
| 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.appserverGetOpsdirectorApplogLevel | This function returns the value for the Ops Director application log level configured for a 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 returns true if the SSL v3 protocol is enabled for the specified App Server, or false if SSL v3 is disabled. |
| 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.appserverSetOpsdirectorApplogLevel | This function changes the Ops Director application log level setting for the specified App Server. |
| 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 enables or disables the SSL v3 protocol for the specified App Server. |
| 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.bucketAssignmentPolicy | This function returns an element that represents the bucket assignment policy. |
| admin.canCommitUpgrade | This function returns true if the cluster is ready to commit the upgrade, returns false otherwise. |
| admin.clusterGetConfigEncryption | This function returns the encryption setting at cluster level for configuration files. |
| admin.clusterGetConfigEncryptionKeyId | This function returns the active encryption key ID used for encryption of configuration files. |
| admin.clusterGetDataEncryption | This function returns the encryption setting at cluster level for user data. |
| admin.clusterGetDataEncryptionKeyId | This function returns the active encryption key ID used for encryption of data. |
| admin.clusterGetEffectiveVersion | This function returns the effective software version of this cluster. |
| admin.clusterGetExternalConfigEncryptionKeyId | This function returns the encryption key ID in the external KMS to use for encryption of configuration files. |
| admin.clusterGetExternalDataEncryptionKeyId | This function returns the encryption key ID in the external KMS to use for encryption of data. |
| admin.clusterGetExternalLogsEncryptionKeyId | This function returns the encryption key ID in the external KMS to use for encryption of log files. |
| admin.clusterGetForeignClusterId | This function returns the id of the specified foreign cluster. |
| admin.clusterGetForeignClusterIds | This function returns the ids of the foreign clusters. |
| admin.clusterGetForeignMasterDatabase | 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.clusterGetForeignReplicaDatabases | 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.clusterGetId | This function returns the id of this cluster. |
| admin.clusterGetInternalConfigEncryptionKeyId | This function returns the encryption key ID in the internal KMS to use for encryption of configuration files. |
| admin.clusterGetInternalDataEncryptionKeyId | This function returns the encryption key ID in the internal KMS to use for encryption of data. |
| admin.clusterGetInternalLogsEncryptionKeyId | This function returns the encryption key ID in the internal KMS to use for encryption of log files. |
| admin.clusterGetKeystoreBackupOption | This function is used to get the backup option for the embedded PKCS#11 wallet. |
| admin.clusterGetKeystoreHostName | This function returns the first host name for the Keystore Management System. |
| admin.clusterGetKeystoreHostNames | This function returns all configured KMS host names. |
| admin.clusterGetKeystoreKmipCAPath | This function returns the path to the PEM encoded KMIP Certificate Authority (CA) used for authentication with the KMS |
| admin.clusterGetKeystoreKmipCertificatePath | This function returns the path to PEM encoded KMIP certificate. |
| admin.clusterGetKeystoreKmipKeyPath | This function returns the path to the PEM encoded private key |
| admin.clusterGetKeystoreKmsType | This function returns the encryption setting at cluster level for log files |
| admin.clusterGetKeystorePort | This function returns the first port number to connect to the Keystore Management System. |
| admin.clusterGetKeystorePorts | This function returns all the configured KMS ports. |
| admin.clusterGetKeystoreWalletLocation | This function returns the PKCS#11 wallet location if it has been set by cluster-set-keystore-wallet-location. |
| admin.clusterGetLanguageBaseline | This function returns the language baseline of this cluster, either "legacy" or "ml9". |
| admin.clusterGetLogsEncryption | This function returns the encryption setting at cluster level for log files. |
| admin.clusterGetLogsEncryptionKeyId | This function returns the active encryption key ID used for encryption of log files. |
| admin.clusterGetName | This function returns the name of this cluster. |
| admin.clusterGetOpsdirectorConfig | This function returns the current frequency with which the managed cluster sends configuration changes to Ops Director. |
| admin.clusterGetOpsdirectorLogLevel | This function returns the current Ops Director log level of the managed cluster. |
| admin.clusterGetOpsdirectorMetering | This function returns the current type of metering data the managed cluster sends to Ops Director. |
| admin.clusterGetOpsdirectorSessionEndpoint | This function returns the session endpoint URI that the managed cluster uses to communicate with Ops Director. |
| admin.clusterGetSslFipsEnabled | This function returns true when OpenSSL FIPS 140-2 mode is enabled in the cluster configuration. |
| admin.clusterGetXdqpBootstrapHosts | This function returns the ids of the bootstrap hosts configured for this cluster. |
| admin.clusterGetXdqpSslCertificate | This function returns the SSL certificate used to establish secure communication between this cluster and foreign clusters. |
| admin.clusterGetXdqpSslPrivateKey | This function returns the private key for secure communication between this cluster and foreign clusters. |
| admin.clusterRotateConfigEncryptionKeyId | This function rotates the encryption key ID to use for encryption of configuration files when MarkLogic is configured with internal KMS |
| admin.clusterRotateDataEncryptionKeyId | This function rotates the encryption key ID to use for encryption of data when MarkLogic is configured with internal KMS |
| admin.clusterRotateLogsEncryptionKeyId | This function rotates the encryption key ID to use for encryption of log files when MarkLogic is configured with internal KMS |
| admin.clusterSetConfigEncryption | This function sets the encryption setting at cluster level for configuration files. |
| admin.clusterSetConfigEncryptionKeyId | This function sets the encryption key ID to use for encryption of configuration files |
| admin.clusterSetDataEncryption | This function sets the encryption setting at cluster level for user data. |
| admin.clusterSetDataEncryptionKeyId | This function sets the encryption key ID to use for encryption of data. |
| admin.clusterSetExternalConfigEncryptionKeyId | This function sets the encryption key ID to use for encryption of configuration files when the kms-type is external. |
| admin.clusterSetExternalDataEncryptionKeyId | This function sets the encryption key ID to use for encryption of data when the kms-type is external. |
| admin.clusterSetExternalLogsEncryptionKeyId | This function sets the encryption key ID to use for encryption of log files when kms-type is external. |
| admin.clusterSetKeystoreBackupOption | This function is used to set the backup option for the embedded PKCS#11 wallet. |
| admin.clusterSetKeystoreHostName | This function sets the host name for the Keystore Management System. |
| admin.clusterSetKeystoreHostNames | This function sets the host name(s) for the Keystore Management System. |
| admin.clusterSetKeystoreKmipCAPath | This function updates the path to the PEM encoded Certificate Authority (CA) used for authentication with the KMS. |
| admin.clusterSetKeystoreKmipCertificatePath | This function updates the path for the PEM encoded KMIP certificate for this host |
| admin.clusterSetKeystoreKmipKeyPath | This function updates the path to the PEM encoded private key. |
| admin.clusterSetKeystoreKmsType | This function sets the type of Keystore Management System (KMS) to be used. |
| admin.clusterSetKeystoreLogsEncryptionPassphrase | MarkLogic supports encrypting the logs with a secondary encryption passphrase, this function can be used to set the passphrase. |
| admin.clusterSetKeystorePassphrase | This function resets the MarkLogic PKCS#11 wallet protection passphrase |
| admin.clusterSetKeystorePort | This function sets the port number to connect to the Keystore Management System. |
| admin.clusterSetKeystorePorts | This function sets the port number(s) to connect to the Keystore Management System. |
| admin.clusterSetKeystoreWalletLocation | This function is used to set the PKCS#11 wallet location. |
| admin.clusterSetLanguageBaseline | This function sets the language baseline for this cluster. |
| admin.clusterSetLogsEncryption | This function sets the encryption setting at cluster level for log files. |
| admin.clusterSetLogsEncryptionKeyId | This function sets the encryption key ID to use for encryption of log files. |
| admin.clusterSetName | This function sets the name for this cluster. |
| admin.clusterSetOpsdirectorLogLevel | This function sets Ops Director log level of the managed cluster. |
| admin.clusterSetOpsdirectorMetering | This function sets the type of metering data the managed cluster sends to Ops Director. |
| admin.clusterSetOpsdirectorSessionEndpoint | This function sets the session endpoint URI that the managed cluster uses to communicate with Ops Director. |
| admin.clusterSetSslFipsEnabled | This function enables or disables OpenSSL FIPS 140-2 mode for the cluster. |
| admin.clusterSetXdqpBootstrapHosts | This function sets the bootstrap hosts for the domestic cluster. |
| admin.clusterSetXdqpSslCertificate | This function sets the SSL certificate used to establish secure communication between this cluster and foreign clusters. |
| admin.clusterSetXdqpSslPrivateKey | This function sets the SSL private key for secure communication between this cluster and foreign clusters. |
| admin.databaseAddBackup | This function adds scheduled backup specifications for a database to a configuration. |
| admin.databaseAddDefaultRuleset | This function adds a ruleset (db:ruleset) to be used for inference on a database. |
| admin.databaseAddElementAttributeWordLexicon | This function adds an element attribute word lexicon to the specified database in the configuration. |
| admin.databaseAddElementWordLexicon | This function adds an element word lexicon to the specified database in the configuration. |
| admin.databaseAddElementWordQueryThrough | This function adds an element word query through to the specified database in the configuration. |
| admin.databaseAddField | This function adds the field specification to the specified database in the configuration. |
| admin.databaseAddFieldExcludedElement | This function adds the field excluded element specification in the specified database in the configuration. |
| admin.databaseAddFieldIncludedElement | This function adds the field included element specification tn the specified database in the configuration. |
| admin.databaseAddFieldPaths | This function adds given paths to the field specified by field-name. |
| admin.databaseAddFieldTokenizerOverride | This function adds tokenizer overrides for the specified field of the specified database. |
| admin.databaseAddFieldWordLexicon | This function adds a word lexicon to the specified database in the configuration. |
| admin.databaseAddForeignReplicas | This function adds one or more replica databases to the database replication configuration. |
| admin.databaseAddFragmentParent | This function adds the specified fragment parent to the specified database in the configuration. |
| admin.databaseAddFragmentRoot | This function adds the specified fragment root to the specified database in the configuration. |
| admin.databaseAddGeospatialElementAttributePairIndex | This function adds a geospatial element attribute pair index to the specified database in the configuration. |
| admin.databaseAddGeospatialElementChildIndex | This function adds a geospatial element child index to the specified database in the configuration. |
| admin.databaseAddGeospatialElementIndex | This function adds a range element index to the specified database in the configuration. |
| admin.databaseAddGeospatialElementPairIndex | This function adds a geospatial element pair index to the specified database in the configuration. |
| admin.databaseAddGeospatialPathIndex | This function adds a range path index to the specified database in the configuration. |
| admin.databaseAddGeospatialRegionPathIndex | This function adds a geospatial region path index to the specified database in the configuration. |
| admin.databaseAddMergeBlackout | This function adds a merge blackout specification for a database to a configuration. |
| admin.databaseAddPathNamespace | 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.databaseAddPhraseAround | This function adds a phrase around to the specified database in the configuration. |
| admin.databaseAddPhraseThrough | This function adds a phrase through to the specified database in the configuration. |
| admin.databaseAddRangeElementAttributeIndex | This function adds a range element attribute index to the specified database in the configuration. |
| admin.databaseAddRangeElementIndex | This function adds a range element index to the specified database in the configuration. |
| admin.databaseAddRangeFieldIndex | This function adds a range field index to the specified database in the configuration. |
| admin.databaseAddRangePathIndex | This function adds a range path index to the specified database in the configuration. |
| admin.databaseAddWordLexicon | This function adds a word lexicon to the specified database in the configuration. |
| admin.databaseAddWordQueryExcludedElement | This function adds the word query excluded element specification for the specified database to the configuration. |
| admin.databaseAddWordQueryIncludedElement | This function adds the word query included element specification to the specified database in the configuration. |
| admin.databaseAttachForest | This function attaches the specified forest to the specified database. |
| admin.databaseAttachSubDatabase | This function adds a sub-database to a super-database. |
| admin.databaseBackupGetEnabled | This function returns true or false to indicate whether a specific backup is enabled for a database. |
| admin.databaseBackupSetEnabled | This function enables database backup for the specified database. |
| admin.databaseCopy | This function creates a new database specification with the same settings as the database with the specified ID. |
| admin.databaseCreate | This function creates a new database specification. |
| admin.databaseDailyBackup | This function constructs a daily scheduled database backup specification. |
| admin.databaseDailyIncrementalBackup | This function constructs a daily scheduled incremental database backup specification. |
| admin.databaseDelete | This function deletes the configuration from the specified database(s). |
| admin.databaseDeleteAllRangeFieldIndexes | This function deletes all the range field indexes on given fields for the specified database in the configuration. |
| admin.databaseDeleteBackup | This function deletes scheduled backup specifications for a database from a configuration. |
| admin.databaseDeleteBackupById | This function deletes a specific database backup, identified by the backup ID. |
| admin.databaseDeleteDefaultRuleset | This function deletes the default ruleset used for inference on a database. |
| admin.databaseDeleteElementAttributeWordLexicon | This function deletes an element attribute word lexicon for the specified database from the configuration. |
| admin.databaseDeleteElementWordLexicon | This function deletes an element word lexicon for the specified database from the configuration. |
| admin.databaseDeleteElementWordQueryThrough | This function deletes an element word query through for the specified database from the configuration. |
| admin.databaseDeleteField | This function deletes the field specification in the specified database from the configuration. |
| admin.databaseDeleteFieldExcludedElement | This function deletes the field excluded element specification in the specified database from the configuration. |
| admin.databaseDeleteFieldIncludedElement | This function deletes the field included element specification in the specified database from the configuration. |
| admin.databaseDeleteFieldPaths | This function deletes paths from a specified field. |
| admin.databaseDeleteFieldTokenizerOverride | This function deletes the field's tokenizer override in the specified database from the configuration. |
| admin.databaseDeleteFieldWordLexicon | This function deletes a word lexicon for the specified database from the configuration. |
| admin.databaseDeleteForeignMaster | This function removes the specified master database from the database replication configuration on the replica host. |
| admin.databaseDeleteForeignReplicas | This function deletes the foreign replica database configurations for the specified master database. |
| admin.databaseDeleteFragmentParent | This function deletes the specified fragment parent in the specified database from the configuration. |
| admin.databaseDeleteFragmentRoot | This function deletes the specified fragment root in the specified database from the configuration. |
| admin.databaseDeleteGeospatialElementAttributePairIndex | This function deletes a geospatial element attribute pair index in the specified database from the configuration. |
| admin.databaseDeleteGeospatialElementChildIndex | This function deletes a geospatial element child index for the specified database in the configuration. |
| admin.databaseDeleteGeospatialElementIndex | This function deletes a geospatial element index for the specified database in the configuration. |
| admin.databaseDeleteGeospatialElementPairIndex | This function deletes a geospatial element pair index for the specified database from the configuration. |
| admin.databaseDeleteGeospatialPathIndex | This function deletes a geospatial path index for the specified database in the configuration. |
| admin.databaseDeleteGeospatialRegionPathIndex | This function deletes a geospatial region path index to the specified database in the configuration. |
| admin.databaseDeleteMergeBlackout | This function deletes a merge blackout specification for a database from a configuration. |
| admin.databaseDeletePathNamespace | This function deletes the specified namespaces from the configuration for the specified database. |
| admin.databaseDeletePhraseAround | This function deletes a phrase around for the specified database from the configuration. |
| admin.databaseDeletePhraseThrough | This function deletes a phrase through for the specified database from the configuration. |
| admin.databaseDeleteRangeElementAttributeIndex | This function deletes a range element attribute index for the specified database in the configuration. |
| admin.databaseDeleteRangeElementIndex | This function deletes a range element index for the specified database in the configuration. |
| admin.databaseDeleteRangeFieldIndex | This function deletes a range field index for the specified database in the configuration. |
| admin.databaseDeleteRangePathIndex | This function deletes a range path index for the specified database in the configuration. |
| admin.databaseDeleteWordLexicon | This function deletes a word lexicon for the specified database from the configuration. |
| admin.databaseDeleteWordQueryExcludedElement | This function deletes the word query excluded element specification in the specified database from the configuration. |
| admin.databaseDeleteWordQueryIncludedElement | This function deletes the word query included element specification in the specified database from the configuration. |
| admin.databaseDetachForest | This function detaches the specified forest from the specified database. |
| admin.databaseDetachSubDatabase | This function removes a sub-database from a super-database. |
| admin.databaseElementAttributeReference | This function greated a db:element-attribute-reference specification. |
| admin.databaseElementAttributeWordLexicon | This function constructs an element attribute word lexicon specification. |
| admin.databaseElementReference | This function greated a db:element-reference specification. |
| admin.databaseElementWordLexicon | This function constructs an element word lexicon specification. |
| admin.databaseElementWordQueryThrough | This function constructs an element word query through specification. |
| admin.databaseEmployForest | This function "employs" the specified forest in the configuration. |
| admin.databaseExcludedElement | This function constructs an excluded element specification. |
| admin.databaseExists | This function determines whether or not the specified database exists. |
| admin.databaseField | This function constructs a field specification. |
| admin.databaseFieldPath | This function is a constructor for field-path element. |
| admin.databaseFieldReference | This function creates a db:field-reference specification. |
| admin.databaseForeignMaster | This function returns a master database configuration. |
| admin.databaseForeignMasterGetClusterId | This function returns the id of the cluster from the specified foreign master configuration. |
| admin.databaseForeignMasterGetConnectForestsByName | This function returns the connect-forests-by-name setting from the master database configuration. |
| admin.databaseForeignMasterGetDatabaseId | This function returns the id of the foreign master database. |
| admin.databaseForeignReplica | This function returns a replica database configuration. |
| admin.databaseForeignReplicaGetClusterId | This function returns the id of the replica cluster from the replica database configuration. |
| admin.databaseForeignReplicaGetConnectForestsByName | This function returns the connect-forests-by-name setting from the replica database configuration. |
| admin.databaseForeignReplicaGetDatabaseId | This function returns the id of the replica database from the replica database configuration. |
| admin.databaseForeignReplicaGetLagLimit | This function returns the lag limit value from the replica database configuration. |
| admin.databaseForeignReplicaGetQueueSize | This function returns the queue size for the number of fragments or frames in-flight during database replication. |
| admin.databaseForeignReplicaGetReplicationEnabled | This function returns the enabled flag from the replica database configuration. |
| admin.databaseForeignReplicaSetLagLimit | This function sets the lag limit value on a replica database configuration. |
| admin.databaseForeignReplicaSetQueueSize | This function sets the queue size for the number of fragments or frames in-flight during database replication. |
| admin.databaseForeignReplicaSetReplicationEnabled | This function sets the enabled flag on a replica database configuration. |
| admin.databaseFragmentParent | This function constructs a fragment parent specification. |
| admin.databaseFragmentRoot | This function constructs a fragment root specification. |
| admin.databaseGeospatialElementAttributePairIndex | This function constructs a geospatial element attribute pair index specification. |
| admin.databaseGeospatialElementChildIndex | This function constructs a geospatial element child index specification. |
| admin.databaseGeospatialElementIndex | This function constructs a geospatial element index specification. |
| admin.databaseGeospatialElementPairIndex | This function constructs a geospatial element pair index specification. |
| admin.databaseGeospatialPathIndex | This function constructs a geospatial path index specification. |
| admin.databaseGeospatialRegionPathIndex | This function constructs a geospatial region path index specification. |
| admin.databaseGetAssignmentPolicy | This function returns the assignment policy for the specified database from the configuration. |
| admin.databaseGetAttachedForests | This function returns the attached forest IDs for the specified database from the configuration. |
| admin.databaseGetAttributeValuePositions | This function returns the attribute value positions setting for the specified database from the configuration. |
| admin.databaseGetBackupEncryption | This function returns the backup encryption key used for encryption of backup for the database identified by the database-id. |
| admin.databaseGetBackups | This function returns the scheduled backups for the specified database from the configuration. |
| admin.databaseGetCollectionLexicon | This function returns the collection lexicon setting for the specified database from the configuration. |
| admin.databaseGetConfigForForeignMasterOnForeignCluster | This function returns the master configuration on a foreign cluster. |
| admin.databaseGetConfigForForeignReplicasOnForeignCluster | This function returns the replica configuration on a foreign cluster. |
| admin.databaseGetDataEncryption | This function returns the encryption setting for the database ID by database-id. |
| admin.databaseGetDefaultRulesets | This function returns the default rulesets for a database. |
| admin.databaseGetDirectoryCreation | This function returns the directory creation setting for the specified database from the configuration. |
| admin.databaseGetElementAttributeWordLexicons | This function returns the element attribute word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetElementValuePositions | This function returns the element value positions setting for the specified database from the configuration. |
| admin.databaseGetElementWordLexicons | This function returns the element word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetElementWordPositions | This function returns the element word positions setting for the specified database from the configuration. |
| admin.databaseGetElementWordQueryThroughs | This function returns the element word query throughs specification(s) for the specified database from the configuration. |
| admin.databaseGetEnabled | This function returns the enabled value for the specified database from the configuration. |
| admin.databaseGetEncryptionKeyId | This function returns the encryption key ID used for encryption of data for the database identified by the database-id. |
| admin.databaseGetExpungeLocks | This function returns the expunge locks setting for the specified database from the configuration. |
| admin.databaseGetFastCaseSensitiveSearches | This function returns the fast case sensitive searches setting for the specified database from the configuration. |
| admin.databaseGetFastDiacriticSensitiveSearches | This function returns the fast diacritic sensitive searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementCharacterSearches | This function returns the fast element character searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementPhraseSearches | This function returns the fast element phrase searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementTrailingWildcardSearches | This function returns the trailing wildcard searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementWordSearches | This function returns the fast element word searches setting for the specified database from the configuration. |
| admin.databaseGetFastPhraseSearches | This function returns the fast phrase searches setting for the specified database from the configuration. |
| admin.databaseGetFastReverseSearches | This function returns the fast reverse searches setting for the specified database from the configuration. |
| admin.databaseGetField | This function returns the field specification for the specified database from the configuration. |
| admin.databaseGetFieldExcludedElements | This function returns the field excluded elements specification for the specified database from the configuration. |
| admin.databaseGetFieldFastCaseSensitiveSearches | This function returns true if the fast case sensitive searches setting for the specified field is enabled. |
| admin.databaseGetFieldFastDiacriticSensitiveSearches | This function returns true if the fast diacritic sensitive searches setting for the specified field is enabled. |
| admin.databaseGetFieldFastPhraseSearches | This function returns true if the fast phrase searches setting for the specified field is enabled. |
| admin.databaseGetFieldIncludedElements | This function returns the fields included elements specification for the specified database from the configuration. |
| admin.databaseGetFieldIncludeDocumentRoot | This function returns the field include document root setting for the specified field from the configuration. |
| admin.databaseGetFieldOneCharacterSearches | This function returns true if the one character searches setting for the specified field is enabled. |
| admin.databaseGetFieldPaths | This function returns all the paths on a given field. |
| admin.databaseGetFields | This function returns the fields specification(s) for the specified database from the configuration. |
| admin.databaseGetFieldStemmedSearches | This function returns stemmed searches setting for the specified field if configured. |
| admin.databaseGetFieldThreeCharacterSearches | This function returns true if the three character searches setting for the specified field is enabled. |
| admin.databaseGetFieldThreeCharacterWordPositions | This function returns true if the three character word positions setting for the specified field is enabled. |
| admin.databaseGetFieldTokenizerOverrides | This function fetches any custom tokenizer override specifications for the specified field and database. |
| admin.databaseGetFieldTrailingWildcardSearches | This function returns true if the trailing wildcard searches setting for the specified field is enabled. |
| admin.databaseGetFieldTrailingWildcardWordPositions | This function returns true if the trailing wildcard word positions setting for the specified field is enabled. |
| admin.databaseGetFieldTwoCharacterSearches | This function returns true if the two character searches setting for the specified field is enabled. |
| admin.databaseGetFieldValuePositions | This function gets the field value positions setting for the specified database in the configuration. |
| admin.databaseGetFieldValueSearches | This function returns the field value search setting for the specified field. |
| admin.databaseGetFieldWordLexicons | This function returns the word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetFieldWordSearches | This function returns true if the word searches setting for the specified field is enabled. |
| admin.databaseGetForeignMaster | This function returns the configuration for the foreign master database. |
| admin.databaseGetForeignReplicas | This function returns the configuration elements of the replica databases associated with the master database specified by database-id. |
| admin.databaseGetFormatCompatibility | This function returns the format compatibility setting for the specified database from the configuration. |
| admin.databaseGetFragmentParents | This function returns the fragment parents specification for the specified database from the configuration. |
| admin.databaseGetFragmentRoots | This function returns the fragment roots specification for the specified database from the configuration. |
| admin.databaseGetGeospatialElementAttributePairIndexes | This function returns the geospatial element attribute pair indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialElementChildIndexes | This function returns the geospatial element child indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialElementIndexes | This function returns the geospatial element indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialElementPairIndexes | This function returns the geospatial element pair indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialPathIndexes | This function returns the geospatial path indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialRegionPathIndexes | This function returns the geospatial region path index specification(s) for the specified database in the configuration. |
| admin.databaseGetId | This function returns the ID for the specified database from the configuration. |
| admin.databaseGetIndexDetection | This function returns the index detection setting for the specified database from the configuration. |
| admin.databaseGetInheritCollections | This function returns the inherit collections setting for the specified database from the configuration. |
| admin.databaseGetInheritPermissions | This function returns the inherit positions setting for the specified database from the configuration. |
| admin.databaseGetInheritQuality | This function returns the inherit quality setting for the specified database from the configuration. |
| admin.databaseGetInMemoryGeospatialRegionIndexSize | This function returns the in memory geospatial region index size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryLimit | This function returns the in memory limit setting for the specified database from the configuration. |
| admin.databaseGetInMemoryListSize | This function returns the in memory list size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryRangeIndexSize | This function returns the in memory range index size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryReverseIndexSize | This function returns the in memory reverse index size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryTreeSize | This function returns the in memory tree size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryTripleIndexSize | This function returns the in memory triple index size setting (in megabytes) for the specified database from the configuration. |
| admin.databaseGetJournaling | This function returns the journaling setting for the specified database in the configuration. |
| admin.databaseGetJournalSize | This function returns the journal size setting for the specified database from the configuration. |
| admin.databaseGetLanguage | This function returns the language for the specified database from the configuration. |
| admin.databaseGetLargeSizeThreshold | This function returns the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs). |
| admin.databaseGetLocking | This function returns the locking setting for the specified database in the configuration. |
| admin.databaseGetMaintainDirectoryLastModified | This function returns the maintain directory last modified setting for the specified database from the configuration. |
| admin.databaseGetMaintainLastModified | This function returns the maintain last modified setting for the specified database from the configuration. |
| admin.databaseGetMergeBlackouts | This function returns the merge blackouts specification for the specified database from the configuration. |
| admin.databaseGetMergeMaxSize | This function returns the merge max size setting for the specified database from the configuration. |
| admin.databaseGetMergeMinRatio | This function returns the merge min ratio setting for the specified database from the configuration. |
| admin.databaseGetMergeMinSize | This function returns the merge min size setting for the specified database from the configuration. |
| admin.databaseGetMergePriority | This function returns the CPU scheduler priority for merges for the specified database from the configuration. |
| admin.databaseGetMergeTimestamp | This function returns the merge timestamp setting for the specified database from the configuration. |
| admin.databaseGetName | This function returns the name for the specified database from the configuration. |
| admin.databaseGetOneCharacterSearches | This function returns the one character searches setting for the specified database from the configuration. |
| admin.databaseGetPathNamespaces | This function returns the value of any namespace definitions predefined for the specified database. |
| admin.databaseGetPhraseArounds | This function returns the phrase arounds specification(s) for the specified database from the configuration. |
| admin.databaseGetPhraseThroughs | This function returns the phrase throughs specification(s) for the specified database from the configuration. |
| admin.databaseGetPositionsListMaxSize | This function returns the positions list max size setting for the specified database from the configuration. |
| admin.databaseGetPreallocateJournals | This function returns the preallocate journals setting for the specified database from the configuration. |
| admin.databaseGetPreloadMappedData | This function returns the preload mapped data setting for the specified database from the configuration. |
| admin.databaseGetPreloadReplicaMappedData | This function returns the preload replica mapped data setting for the specified database from the configuration. |
| admin.databaseGetRangeElementAttributeIndexes | This function returns the range element attribute indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangeElementIndexes | This function returns the range element indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangeFieldIndexes | This function returns the range field indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangeIndexOptimize | This function returns the range index optimize setting for the specified database from the configuration. |
| admin.databaseGetRangePathIndexes | This function returns the range path indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangePolicyPartitionKey | This function returns the range policy partition key set for the database. |
| admin.databaseGetRebalancerEnable | This function returns the rebalancer enable setting for the specified database from the configuration. |
| admin.databaseGetRebalancerThrottle | This function returns the rebalancer throttle setting for the specified database from the configuration. |
| admin.databaseGetReindexerEnable | This function returns the reindexer enable setting for the specified database from the configuration. |
| admin.databaseGetReindexerThrottle | This function returns the reindexer throttle setting for the specified database from the configuration. |
| admin.databaseGetReindexerTimestamp | This function returns the reindexer timestamp setting for the specified database from the configuration. |
| admin.databaseGetRetainUntilBackup | This function returns the "retain until backup" setting from the configuration for the specified database. |
| admin.databaseGetRetiredForests | This function returns the list of all retired forests for the specified database from the configuration. |
| admin.databaseGetSchemaDatabase | This function returns the ID of the schema database for the specified database from the configuration. |
| admin.databaseGetSecurityDatabase | This function returns the ID of the security database for the specified database from the configuration. |
| admin.databaseGetStemmedSearches | This function returns the stemmed searches setting for the specified database from the configuration. |
| admin.databaseGetTfNormalization | This function returns the current term-frequency normalization setting for the database. |
| admin.databaseGetThreeCharacterSearches | This function returns the three character searches setting for the specified database from the configuration. |
| admin.databaseGetThreeCharacterWordPositions | This function returns the three character word positions setting for the specified database from the configuration. |
| admin.databaseGetTrailingWildcardSearches | This function returns the trailing wildcard searches setting for the specified database from the configuration. |
| admin.databaseGetTrailingWildcardWordPositions | This function returns the trailing wildcard word positions setting for the specified database from the configuration. |
| admin.databaseGetTriggersDatabase | This function returns the ID of the triggers database for the specified database from the configuration. |
| admin.databaseGetTripleIndex | This function returns true if the triple index is enabled for the specified database, false if it is not enabled. |
| admin.databaseGetTriplePositions | This function returns triple positions setting of a database. |
| admin.databaseGetTwoCharacterSearches | This function returns the two character searches setting for the specified database from the configuration. |
| admin.databaseGetUriLexicon | This function returns the URI lexicon setting for the specified database from the configuration. |
| admin.databaseGetWordLexicons | This function returns the word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetWordPositions | This function returns the word positions setting for the specified database from the configuration. |
| admin.databaseGetWordQueryExcludedElements | This function returns the word query excluded elements setting for the specified database from the configuration. |
| admin.databaseGetWordQueryFastCaseSensitiveSearches | This function returns true if the word query fast case sensitive searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryFastDiacriticSensitiveSearches | This function returns true if the word query fast diacritic sensitive searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryFastPhraseSearches | This function returns true if the word query fast phrase searches setting for the specified database is set in the configuration. |
| admin.databaseGetWordQueryIncludedElements | This function returns the word query included elements setting for the specified database from the configuration. |
| admin.databaseGetWordQueryIncludeDocumentRoot | This function returns the word query include document root setting for the specified database from the configuration. |
| admin.databaseGetWordQueryOneCharacterSearches | This function returns true if the word query one character searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryStemmedSearches | This function returns the reindexer word query stemmed searches setting for the specified database from the configuration. |
| admin.databaseGetWordQueryThreeCharacterSearches | This function returns true if the word query three character searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryThreeCharacterWordPositions | This function returns true if the word query three character word positions setting is enabled for the specified database from the configuration. |
| admin.databaseGetWordQueryTrailingWildcardSearches | This function returns true if the word query trailing wildcard searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryTrailingWildcardWordPositions | This function returns true if the word query trailing wildcard word positions setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryTwoCharacterSearches | This function returns true if the word query two character searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryWordSearches | This function returns true if the word query searches setting for the specified database is enabled in the configuration. |
| admin.databaseGetWordSearches | This function returns the word searches setting for the specified database from the configuration. |
| admin.databaseHourlyBackup | This function constructs an hourly scheduled database backup specification. |
| admin.databaseHourlyIncrementalBackup | This function constructs an hourly scheduled incremental database backup specification. |
| admin.databaseIncludedElement | This function constructs an included element specification. |
| admin.databaseInUsePathNamespacePrefixes | This function returns the prefixes of all the namespaces that are in use by some path or geospatial path index. |
| admin.databaseIsForestEmployed | This function returns true if the specified forest is employed and false the specified forest is not employed. |
| admin.databaseIsForestRetired | This function returns true if the specified forest is retired and false the specified forest is not retired. |
| admin.databaseMetadataField | This function constructs a metadata field specification. |
| admin.databaseMinutelyBackup | This function constructs a scheduled database backup specification on a number-of-minutes basis. |
| admin.databaseMinutelyIncrementalBackup | This function constructs a scheduled incremental database backup specification based on a number of minutes. |
| admin.databaseMonthlyBackup | This function constructs a monthly scheduled backup specification. |
| admin.databaseMonthlyIncrementalBackup | This function constructs a scheduled monthly incremental backup specification. |
| admin.databaseOneTimeBackup | This function constructs a one-time backup specification. |
| admin.databaseOneTimeIncrementalBackup | This function constructs a one-time incremental backup specification. |
| admin.databaseOneTimeMergeBlackout | This function constructs a one-time merge-blackout specification. |
| admin.databasePathField | This function constructs a field specification that has field paths. |
| admin.databasePathNamespace | This function constructs a namespace element with the specified prefix and URI. |
| admin.databasePathReference | This function creates a db:path-reference specification. |
| admin.databasePhraseAround | This function constructs a phrase through specification. |
| admin.databasePhraseThrough | This function constructs a phrase through specification. |
| admin.databaseRangeElementAttributeIndex | This function constructs a range element attribute index specification. |
| admin.databaseRangeElementIndex | This function constructs a range element index specification. |
| admin.databaseRangeFieldIndex | This function constructs a range field index specification. |
| admin.databaseRangePathIndex | This function constructs a path range index specification. |
| admin.databaseRecurringMergeBlackout | This function constructs a merge-blackout specification. |
| admin.databaseReorderForests | This function reorders the forests in the specified database. |
| admin.databaseRetireForest | This function "retires" the specified forest in the configuration. |
| admin.databaseRuleset | The ruleset element (db:default-ruleset) created to be used for inference on a database. |
| admin.databaseSetAssignmentPolicy | This function sets the assignment policy for the specified database in the configuration. |
| admin.databaseSetAttributeValuePositions | This function sets the attribute value positions setting for the specified database in the configuration. |
| admin.databaseSetBackupEncryptionKey | This function sets which key encryption key to use for encryption of backup for the database identified by database-id. |
| admin.databaseSetCollectionLexicon | This function sets the collection lexicon setting for the specified database in the configuration. |
| admin.databaseSetDataEncryption | This function sets the encryption setting for the database identified by database-id. |
| admin.databaseSetDirectoryCreation | This function sets the directory creation setting for the specified database in the configuration. |
| admin.databaseSetElementValuePositions | This function sets the element value positions setting for the specified database in the configuration. |
| admin.databaseSetElementWordPositions | This function sets the element word positions setting for the specified database in the configuration. |
| admin.databaseSetEnabled | This function sets the enabled value for the specified database in the configuration. |
| admin.databaseSetEncryptionKeyId | This function sets the encryption key ID to use for encryption of data for the database identified by database-id. |
| admin.databaseSetExpungeLocks | This function sets the expunge locks setting for the specified database in the configuration. |
| admin.databaseSetFastCaseSensitiveSearches | This function sets the fast case sensitive searches setting for the specified database in the configuration. |
| admin.databaseSetFastDiacriticSensitiveSearches | This function sets the fast diacritic-sensitive searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementCharacterSearches | This function sets the fast element character searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementPhraseSearches | This function sets the fast element phrase searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementTrailingWildcardSearches | This function sets the fast element trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementWordSearches | This function sets the element word searches setting for the specified database in the configuration. |
| admin.databaseSetFastPhraseSearches | This function sets the fast phrase searches setting for the specified database in the configuration. |
| admin.databaseSetFastReverseSearches | This function sets the fast reverse searches setting for the specified database in the configuration. |
| admin.databaseSetFieldFastCaseSensitiveSearches | This function sets the field fast case sensitive searches setting for the specified field in the configuration. |
| admin.databaseSetFieldFastDiacriticSensitiveSearches | This function sets the field fast diacritic sensitive searches setting for the specified field in the configuration. |
| admin.databaseSetFieldFastPhraseSearches | This function sets the field fast phrase searches setting for the specified field in the configuration. |
| admin.databaseSetFieldIncludeDocumentRoot | This function sets the field include document root setting for the specified field in the configuration. |
| admin.databaseSetFieldName | This function sets the field name setting for the specified field in the configuration. |
| admin.databaseSetFieldOneCharacterSearches | This function sets the field one character searches setting for the specified field in the configuration. |
| admin.databaseSetFieldStemmedSearches | This function sets the field stemmed searches setting for the specified field in the configuration. |
| admin.databaseSetFieldThreeCharacterSearches | This function sets the field three character searches setting for the specified field in the configuration. |
| admin.databaseSetFieldThreeCharacterWordPositions | This function sets the field three character word positions setting for the specified field in the configuration. |
| admin.databaseSetFieldTrailingWildcardSearches | This function sets the field trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetFieldTrailingWildcardWordPositions | This function sets the field trailing wildcard word positions setting for the specified field in the configuration. |
| admin.databaseSetFieldTwoCharacterSearches | This function sets the field two character searches setting for the specified field in the configuration. |
| admin.databaseSetFieldValuePositions | This function sets the field value positions setting for the specified database in the configuration. |
| admin.databaseSetFieldValueSearches | This function sets the field value searches setting for the specified database in the configuration. |
| admin.databaseSetFieldWordSearches | This function sets the field word searches setting for the specified field in the configuration. |
| admin.databaseSetForeignMaster | This function configures the specified replica database to receive replicated data from the specified foreign master. |
| admin.databaseSetForeignReplicas | This function sets the foreign replica database configuration. |
| admin.databaseSetFormatCompatibility | This function sets the format compatibility setting for the specified database in the configuration. |
| admin.databaseSetIndexDetection | This function sets the index detection setting for the specified database in the configuration. |
| admin.databaseSetInheritCollections | This function sets the inherit collections setting for the specified database in the configuration. |
| admin.databaseSetInheritPermissions | This function sets the inherit permissions setting for the specified database in the configuration. |
| admin.databaseSetInheritQuality | This function sets the inherit quality setting for the specified database in the configuration. |
| admin.databaseSetInMemoryGeospatialRegionIndexSize | This function sets the in-memory geospatial region index size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryLimit | This function sets the in-memory limit setting for the specified database in the configuration. |
| admin.databaseSetInMemoryListSize | This function sets the in-memory list size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryRangeIndexSize | This function sets the in-memory range index size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryReverseIndexSize | This function sets the in-memory range reverse index size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryTreeSize | This function sets the in-memory tree size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryTripleIndexSize | This function sets the size, in megabytes, of the in-memory triple index. |
| admin.databaseSetJournaling | This function sets the journaling setting for the specified database in the configuration. |
| admin.databaseSetJournalSize | This function sets the journal size setting for the specified database in the configuration. |
| admin.databaseSetLanguage | This function sets the language for the specified database in the configuration. |
| admin.databaseSetLargeSizeThreshold | This function sets the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs). |
| admin.databaseSetLocking | This function sets the locking setting for the specified database in the configuration. |
| admin.databaseSetMaintainDirectoryLastModified | This function sets the maintain directory last modified setting for the specified database in the configuration. |
| admin.databaseSetMaintainLastModified | This function sets the maintain last modified setting for the specified database in the configuration. |
| admin.databaseSetMergeMaxSize | This function sets the merge max size setting for the specified database in the configuration. |
| admin.databaseSetMergeMinRatio | This function sets the merge min ratio setting for the specified database in the configuration. |
| admin.databaseSetMergeMinSize | This function sets the merge minimum size setting for the specified database in the configuration. |
| admin.databaseSetMergePriority | This function sets the CPU scheduler priority for merges. |
| admin.databaseSetMergeTimestamp | This function sets the merge timestamp setting for the specified database in the configuration. |
| admin.databaseSetName | This function changes the name of the database with the specified ID to the specified name. |
| admin.databaseSetOneCharacterSearches | This function sets the one character searches setting for the specified database in the configuration. |
| admin.databaseSetPositionsListMaxSize | This function sets the positions list max size setting for the specified database in the configuration. |
| admin.databaseSetPreallocateJournals | This function sets the preallocate journals setting for the specified database in the configuration. |
| admin.databaseSetPreloadMappedData | This function sets the preload mapped data setting for the specified database in the configuration. |
| admin.databaseSetPreloadReplicaMappedData | This function sets the preload-replica-mapped-data setting for the specified database. |
| admin.databaseSetRangeIndexOptimize | This function sets the range index optimize setting for the specified database in the configuration. |
| admin.databaseSetRebalancerEnable | This function sets the rebalancer enable setting for the specified database in the configuration. |
| admin.databaseSetRebalancerThrottle | This function sets the rebalancer throttle setting for the specified database in the configuration. |
| admin.databaseSetReindexerEnable | This function sets the reindexer enable setting for the specified database in the configuration. |
| admin.databaseSetReindexerThrottle | This function sets the reindexer throttle setting for the specified database in the configuration. |
| admin.databaseSetReindexerTimestamp | This function sets the reindexer timestamp setting for the specified database in the configuration. |
| admin.databaseSetRetainUntilBackup | This function sets "the retain until backup" setting in the configuration for the specified database. |
| admin.databaseSetSchemaDatabase | This function sets the schema database for a database to the specified database in the configuration. |
| admin.databaseSetSecurityDatabase | This function sets the security database for a database to the specified database in the configuration. |
| admin.databaseSetStemmedSearches | This function sets the stemmed searches setting for the specified database in the configuration. |
| admin.databaseSetTfNormalization | 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.databaseSetThreeCharacterSearches | This function sets the three character searches setting for the specified database in the configuration. |
| admin.databaseSetThreeCharacterWordPositions | This function sets the three character word positions setting for the specified database in the configuration. |
| admin.databaseSetTrailingWildcardSearches | This function sets the trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetTrailingWildcardWordPositions | This function sets the trailing wildcard word positions setting for the specified database in the configuration. |
| admin.databaseSetTriggersDatabase | This function sets the triggers database to the specified database ID for the specified database in the configuration. |
| admin.databaseSetTripleIndex | This function sets the triple index on or off for a database. |
| admin.databaseSetTriplePositions | This function sets the triple positions of a database to true or false. |
| admin.databaseSetTwoCharacterSearches | This function sets the two character searches setting for the specified database in the configuration. |
| admin.databaseSetUriLexicon | This function sets the URI lexicon setting for the specified database in the configuration. |
| admin.databaseSetWordPositions | This function sets the word positions setting for the specified database in the configuration. |
| admin.databaseSetWordQueryFastCaseSensitiveSearches | This function returns the word query fast case sensitive searches setting for the specified database from the configuration. |
| admin.databaseSetWordQueryFastDiacriticSensitiveSearches | This function sets the word query fast diacritic sensitive searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryFastPhraseSearches | This function sets the word query fast phrase searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryIncludeDocumentRoot | This function sets the word query include document root setting for the specified field in the configuration. |
| admin.databaseSetWordQueryOneCharacterSearches | This function sets the word query one character searches setting for the specified field in the configuration. |
| admin.databaseSetWordQueryStemmedSearches | This function sets the word query stemmed searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryThreeCharacterSearches | This function sets the word query three character searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryThreeCharacterWordPositions | This function sets the word query three character word positions setting for the specified database in the configuration. |
| admin.databaseSetWordQueryTrailingWildcardSearches | This function sets the word query trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryTrailingWildcardWordPositions | This function sets the word query trailing wildcard word positions setting for the specified database in the configuration. |
| admin.databaseSetWordQueryTwoCharacterSearches | This function sets the word query two character searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryWordSearches | This function sets the word query word searches setting for the specified database in the configuration. |
| admin.databaseSetWordSearches | This function sets the word searches setting for the specified database in the configuration. |
| admin.databaseSubDatabases | This function returns a database-reference element representing the sub-databases of the specified super-database. |
| admin.databaseSuperDatabases | This function returns a database-reference element representing where the specified database serves as a sub-database. |
| admin.databaseTokenizerOverride | This function constructs a custom tokenizer override. |
| admin.databaseValidateFieldPath | This function validates the specified field path. |
| admin.databaseValidateFieldPaths | This function checks if the paths conform to the permissible XPath syntax. |
| admin.databaseValidatePathFields | For a given sequence of fields, this function validates all the paths on each field using admin:database-validate-field-paths call. |
| admin.databaseWeeklyBackup | This function constructs a weekly scheduled backup specification. |
| admin.databaseWeeklyIncrementalBackup | This function constructs a weekly scheduled incremental backup specification. |
| admin.databaseWordLexicon | This function constructs a word lexicon specification. |
| admin.foreignClusterCreate | This function creates a complete configuration for a foreign cluster. |
| admin.foreignClusterDelete | This function deletes the configuration for the specified foreign cluster. |
| admin.foreignClusterGetBootstrapHosts | This function returns one or more configuration elements that identify the bootstrap hosts on the specified foreign cluster. |
| admin.foreignClusterGetHostTimeout | This function returns the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster. |
| admin.foreignClusterGetName | This function returns the name of the foreign cluster. |
| admin.foreignClusterGetSslCertificate | This function returns the SSL certificate used to communicate with hosts in the foreign cluster. |
| admin.foreignClusterGetXdqpSslAllowSslv3 | This function returns true if the SSL v3 protocol is enabled for the foreign cluster. |
| admin.foreignClusterGetXdqpSslAllowTls | This function returns true if the TLS protocol is enabled for the foreign cluster. |
| admin.foreignClusterGetXdqpSslCiphers | This function returns the SSL ciphers set for the specified foreign cluster. |
| admin.foreignClusterGetXdqpSslEnabled | This function returns true if SSL is enabled for the foreign cluster. |
| admin.foreignClusterGetXdqpTimeout | 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.foreignClusterReplace | This function replaces a configuration for a foreign cluster with a new configuration. |
| admin.foreignClusterSetBootstrapHosts | This function identifies the foreign host to be used to bootstrap communication with the foreign cluster. |
| admin.foreignClusterSetHostTimeout | This function sets the timeout period (in seconds) for communication between domestic hosts and hosts in the specified foreign cluster. |
| admin.foreignClusterSetName | This function sets the name of a foreign cluster. |
| admin.foreignClusterSetSslCertificate | This function sets the specified SSL certificate for secure communication with hosts in a foreign cluster. |
| admin.foreignClusterSetXdqpSslAllowSslv3 | This function enables or disables the SSL v3 protocol for the specified foreign cluster. |
| admin.foreignClusterSetXdqpSslAllowTls | This function enables or disables the TLS protocol for the specified foreign cluster. |
| admin.foreignClusterSetXdqpSslCiphers | This function sets SSL ciphers for the specified foreign cluster. |
| admin.foreignClusterSetXdqpSslEnabled | This function enables or disables SSL for the foreign cluster. |
| admin.foreignClusterSetXdqpTimeout | 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.foreignHost | This function configures a foreign host to be set by the admin.foreignClusterSetBootstrapHosts function as the bootstrap host for the foreign cluster. |
| admin.foreignHostGetConnectPort | This function returns the number of the port configured for the foreign bootstrap host. |
| admin.foreignHostGetId | This function returns the id of the foreign bootstrap host. |
| admin.foreignHostGetName | This function returns the name of the foreign bootstrap host. |
| admin.forestAddBackup | This function adds scheduled backup specifications for a forest to a configuration. |
| admin.forestAddFailoverHost | This function adds a failover host to the list of failover hosts for the specified forest in the specified configuration. |
| admin.forestAddForeignReplicas | This function adds the replica forest that is associated with the specified master forest to the database replication configuration. |
| admin.forestAddReplica | This function adds a forest replica to a master forest. |
| admin.forestBackupGetEnabled | This function returns true or false to indicate whether backup is enabled for the specified forest. |
| admin.forestBackupSetEnabled | This function enables forest backup for the specified forest. |
| admin.forestCopy | This function creates a new forest specification with the same settings as the forest with the specified ID. |
| admin.forestCreate | This function creates a new forest configuration. |
| admin.forestDailyBackup | This function constructs a daily scheduled forest backup. |
| admin.forestDelete | This function deletes the configuration for the specified forest from the configuration. |
| admin.forestDeleteBackup | This function deletes scheduled backup specifications for a forest from a configuration. |
| admin.forestDeleteBackupById | This function deletes the forest backup specified by the forest ID. |
| admin.forestDeleteFailoverHost | This function deletes the specified failover host(s) from the failover-host list in the specified configuration. |
| admin.forestDeleteForeignMaster | This function deletes the master forest associated with the specified replica forest from the database replication configuration. |
| admin.forestDeleteForeignReplicas | This function deletes the foreign replica of the specified forest on the master host. |
| admin.forestExists | This function determines whether or not the specified forest exists. |
| admin.forestForeignMaster | This function creates a replication configuration element for the specified master forest. |
| admin.forestForeignMasterGetClusterId | This function returns the ID for the cluster from the foreign master forest configuration element. |
| admin.forestForeignMasterGetDatabaseId | This function returns the id for the database from the foreign master forest configuration element. |
| admin.forestForeignMasterGetForestId | This function returns the id for the forest from the foreign master forest configuration element. |
| admin.forestForeignReplica | This function returns a replica forest configuration. |
| admin.forestForeignReplicaGetClusterId | This function returns the id of the replica cluster from the specified replica forest configuration element. |
| admin.forestForeignReplicaGetDatabaseId | This function returns the id of the replica database from the specified replica forest configuration element. |
| admin.forestForeignReplicaGetForestId | This function returns the id of the replica forest from the specified replica forest configuration element. |
| admin.forestGetAvailability | This function gets the availability state of the forest, for use in Tiered Storage. |
| admin.forestGetBackups | This function returns the scheduled backups for the specified forest from the configuration. |
| admin.forestGetDatabase | This function returns the ID of the database that uses the specified forest. |
| admin.forestGetDataDirectory | This function returns the name of the data directory of the specified forest. |
| admin.forestGetEnabled | This function returns the enabled state of the specified forest. |
| admin.forestGetFailoverEnable | This function returns the state of whether failover is enabled for the specified forest. |
| admin.forestGetFailoverHosts | This function returns the IDs of the hosts defined as failover hosts for this forest. |
| admin.forestGetFastDataDirectory | This function returns the directory path set in the fast data directory field for the specified forest. |
| admin.forestGetFastDataMaxSize | 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.forestGetForeignMaster | This function returns the replication configuration for the master forest associated with the specified replica forest. |
| admin.forestGetForeignReplicas | This function returns the foreign replicas configuration element. |
| admin.forestGetHost | This function returns the ID of the host in which the specified forest resides. |
| admin.forestGetId | This function returns the ID of the forest with the specified name, from the specified configuration. |
| admin.forestGetLargeDataDirectory | This function returns the name of the large data directory of the specified forest. |
| admin.forestGetName | This function returns the name of the specified forest, given the forest ID. |
| admin.forestGetPartitionNumber | This function returns the partition number for the specified forest. |
| admin.forestGetRangePolicyLowerBound | This function returns the lower bound of the range configured on the forest. |
| admin.forestGetRangePolicyUpperBound | This function returns the upper bound of the range configured on the forest. |
| admin.forestGetRebalancerEnable | This function returns the rebalancer enable setting for the specified forest from the configuration. |
| admin.forestGetReplicas | This function returns the IDs of the forest replicas for the specified forest. |
| admin.forestGetUpdatesAllowed | This function returns the state of what kinds of updates are allowed for the specified forest. |
| admin.forestHourlyBackup | This function constructs a hourly scheduled forest backup specification. |
| admin.forestIsRangePolicyRangeSet | This function returns false if the specified forest has neither the lower boundary nor the upper boundary set. |
| admin.forestMinutelyBackup | This function constructs a scheduled forest backup on a number-of-minutes basis. |
| admin.forestMonthlyBackup | This function constructs a monthly scheduled backup. |
| admin.forestOneTimeBackup | This function constructs a one-time backup. |
| admin.forestRemoveReplica | This function removes a forest replica from a master forest. |
| admin.forestRename | This function renames a forest. |
| admin.forestSetAvailability | This function sets the availability state for a forest, for use in Tiered Storage. |
| admin.forestSetEnabled | This function sets the enabled state for a forest configuration. |
| admin.forestSetFailoverEnable | This function sets the forest failover enabled state for a forest configuration. |
| admin.forestSetFastDataMaxSize | 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.forestSetForeignMaster | This function writes the specified foreign master forest configuration into the database replication configuration. |
| admin.forestSetForeignReplicas | This function writes the specified replica forest configuration into the database replication configuration. |
| admin.forestSetHost | This function sets a forest configuration to a new host. |
| admin.forestSetPartitionNumber | This function sets the partition number for the specified forest. |
| admin.forestSetRangePolicyRange | This function sets the boundaries of the range on a forest. |
| admin.forestSetRebalancerEnable | This function sets the rebalancer enable setting for the specified forest in the configuration. |
| admin.forestSetUpdatesAllowed | This function sets the updates-allowed state for a forest configuration. |
| admin.forestWeeklyBackup | This function constructs a weekly scheduled backup. |
| admin.getAppserverIds | This function returns all the appserver IDs from the configuration. |
| admin.getConfiguration | Loads the admin configuration into memory for use by other functions in the Admin module. |
| admin.getDatabaseIds | This function returns all the database IDs from the configuration. |
| admin.getForestIds | This function returns all the forest IDs from the configuration. |
| admin.getGroupIds | This function returns all the group IDs from the configuration. |
| admin.getHostIds | This function returns all the host IDs from the configuration. |
| admin.groupAddModuleLocation | Add one or more module namespace to location mappings to a Group configuration. |
| admin.groupAddNamespace | 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.groupAddScheduledTask | This function adds one or more scheduled tasks to the specified group. |
| admin.groupAddSchema | This function adds a schema binding definition to the existing schema binding definitions in the configuration for the specified Group. |
| admin.groupAddTraceEvent | This function adds trace events to the configuration. |
| admin.groupAddUsingNamespace | 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.groupCopy | This function creates a new group specification with the same settings as the group with the specified ID. |
| admin.groupCreate | This function creates a new group with the specified name in the configuration. |
| admin.groupDailyScheduledTask | This function constructs a task to be invoked at daily intervals. |
| admin.groupDelete | This function deletes one or more groups in the configuration. |
| admin.groupDeleteModuleLocation | Delete one or more module location bindings from a Group configuration. |
| admin.groupDeleteNamespace | This function deletes the specified namespaces from the configuration for the specified group. |
| admin.groupDeleteScheduledTask | This function deletes one or more scheduled tasks from the specified group. |
| admin.groupDeleteScheduledTaskById | This function deletes the scheduled tasks for a group using the group ID. |
| admin.groupDeleteSchema | This function deletes a schema binding definition to the existing schema binding definitions in the configuration for the specified Group. |
| admin.groupDeleteTraceEvent | This function deletes the specified trace events from the configuration. |
| admin.groupDeleteUsingNamespace | Delete one or more "using" namespaces from a Group configuration. |
| admin.groupDisableAuditEventType | This function changes the audit event type(s) enabled setting for the audit configuration. |
| admin.groupEnableAuditEventType | This function changes the audit event type(s) enabled setting for the audit configuration. |
| admin.groupExists | This function determines whether or not the specified Group exists. |
| admin.groupGetAppserverIds | This function returns the IDs of all appservers belonging to the group. |
| admin.groupGetAuditEnabled | This function returns the value for the audit enabled setting from the specified group. |
| admin.groupGetAuditEventTypeEnabled | This function returns the audit event type's enabled setting for the audit configuration. |
| admin.groupGetAuditExcludedRoles | This function returns the roles excluded from auditing. |
| admin.groupGetAuditExcludedUris | This function returns the uris excluded from auditing. |
| admin.groupGetAuditExcludedUsers | This function returns the users excluded from auditing. |
| admin.groupGetAuditIncludedRoles | This function returns the roles included from auditing. |
| admin.groupGetAuditIncludedUris | This function returns the uris included from auditing. |
| admin.groupGetAuditIncludedUsers | This function returns the users included from auditing. |
| admin.groupGetAuditOutcomeRestriction | This function returns whether auditing events are restricted by a success or failure outcome. |
| admin.groupGetAzureStorageProxy | This function returns the URL of the proxy server used by the group to access Azure blob storage. |
| admin.groupGetBackgroundIoLimit | This function gets the value for the I/O background limit that controls the I/O resources that I/O tasks (for example, merges) will consume. |
| admin.groupGetCompressedTreeCachePartitions | This function returns the value for the compressed tree cache partitions setting from the specified group. |
| admin.groupGetCompressedTreeCacheSize | This function returns the value for the compressed tree cache size setting from the specified group. |
| admin.groupGetCompressedTreeReadSize | This function returns the value for the compressed tree read size (in kilobytes) setting from the specified group. |
| admin.groupGetExpandedTreeCachePartitions | This function returns the value for the expanded tree cache partitions setting from the specified group. |
| admin.groupGetExpandedTreeCacheSize | This function returns the value for the expanded tree cache size setting from the specified group. |
| admin.groupGetFailoverEnable | This function returns the value for the failover enable setting from the specified group. |
| admin.groupGetFileLogLevel | This function returns the value for the file log level setting from the specified group. |
| admin.groupGetHostIds | This function returns the IDs of all hosts belonging to the group. |
| admin.groupGetHostInitialTimeout | This function returns the value for the host initial timeout setting from the specified group. |
| admin.groupGetHostTimeout | This function returns the value for the host timeout setting from the specified group. |
| admin.groupGetHttpserverIds | This function returns the IDs of all httpservers belonging to the group. |
| admin.groupGetHttpTimeout | This function returns the value for the http timeout setting from the specified group. |
| admin.groupGetHttpUserAgent | This function returns the value for the http user agent setting from the specified group. |
| admin.groupGetId | This function returns the ID of the group. |
| admin.groupGetKeepAuditFiles | This function returns the value for the keep audit files setting from the specified group. |
| admin.groupGetKeepLogFiles | This function returns the value for the keep log files setting from the specified group. |
| admin.groupGetListCachePartitions | This function returns the value for the list cache partitions setting from the specified group. |
| admin.groupGetListCacheSize | This function returns the value for the list cache size setting from the specified group. |
| admin.groupGetMeteringEnabled | This function returns the value of the metering-enabled group setting. |
| admin.groupGetMetersDatabase | This function returns the ID of the meters-database configured for the specified group. |
| admin.groupGetModuleCacheTimeout | This function returns the number of seconds a module can be unused before being flushed from caches. |
| admin.groupGetModuleLocations | This function returns the value of any module locations predefined for the specified Group. |
| admin.groupGetName | This function returns the name of the specified group. |
| admin.groupGetNamespaces | This function returns the value of any namespace definitions predefined for the specified group. |
| admin.groupGetOdbcserverIds | This function returns the ids of all of the ODBC App Servers in the specified group. |
| admin.groupGetPerformanceMeteringEnabled | This function returns the value of the performance-metering-enabled group setting. |
| admin.groupGetPerformanceMeteringPeriod | This function returns the value of the performance-metering-period group setting. |
| admin.groupGetPerformanceMeteringRetainDaily | This function returns the value of the performance-metering-retain-daily group setting. |
| admin.groupGetPerformanceMeteringRetainHourly | This function returns the value of the performance-metering-retain-hourly group setting. |
| admin.groupGetPerformanceMeteringRetainRaw | This function returns the value of the performance-metering-retain-raw group setting. |
| admin.groupGetRetryTimeout | This function returns the value for the number of seconds a request will retry before timing out. |
| admin.groupGetRotateAuditFiles | This function returns the value for the rotate audit files setting from the specified group. |
| admin.groupGetRotateLogFiles | This function returns the value for the rotate log files setting from the specified group. |
| admin.groupGetS3Domain | This function gets the simple storage service internet domain name for hosts in the group. |
| admin.groupGetS3Protocol | This function gets the simple storage service protocol for hosts in the group. |
| admin.groupGetS3Proxy | This function returns the URL of the proxy server used by the group to access AWS S3 storage. |
| admin.groupGetS3ServerSideEncryption | This function gets the method of server side encryption for data at rest on the simple storage service. |
| admin.groupGetS3ServerSideEncryptionKmsKey | This function gets the KMS key that is used by server side encryption for data at rest on the simple storage service. |
| admin.groupGetScheduledTask | This function returns information about a scheduled task for a group based on the task ID and the group ID. |
| admin.groupGetScheduledTasks | This function returns all of the tasks scheduled for the specified group. |
| admin.groupGetSchemas | This function returns the value of any schemas definitions predefined for the specified group. |
| admin.groupGetSecurityDatabase | This function returns the ID of the security database for the specified group from the configuration. |
| admin.groupGetSmtpRelay | This function returns the value for the smtp relay setting from the specified group. |
| admin.groupGetSmtpTimeout | This function returns the value for the smtp timeout setting from the specified group. |
| admin.groupGetSystemLogLevel | This function returns the value for the system log level setting from the specified group. |
| admin.groupGetTaskserverId | This function returns the ID of of the taskserver belonging to the group. |
| admin.groupGetTelemetryConfig | This function returns the currently set frequency for sending configuration file changes to telemetry. |
| admin.groupGetTelemetryLogLevel | This function returns the current configured telemetry log level. |
| admin.groupGetTelemetryMetering | This function returns the configured detail level for collecting metering data sent to telemetry. |
| admin.groupGetTelemetryProxy | This function returns the proxy server URL used by telemetry |
| admin.groupGetTelemetrySessionEndpoint | This function returns the initial default telemetry endpoint. |
| admin.groupGetTelemetryUsage | This function returns the Telemetry Usage enable setting for the specific group. |
| admin.groupGetTraceEvents | This function returns the value of any trace events activated for the specified group. |
| admin.groupGetTraceEventsActivated | This function returns the value for the trace events activated setting from the specified group. |
| admin.groupGetTripleCachePartitions | This function returns the number of triple cache partitions configured for the group. |
| admin.groupGetTripleCacheSize | This function returns the value of the triple cache size for the group. |
| admin.groupGetTripleCacheTimeout | This function gets the timeout value for the triple cache. |
| admin.groupGetTripleValueCachePartitions | This function returns the number of triple value cache partitions configured for the group. |
| admin.groupGetTripleValueCacheSize | This function returns the size of triple value cache configured for the group. |
| admin.groupGetTripleValueCacheTimeout | This function gets the timeout value for the triple value cache. |
| admin.groupGetUsingNamespaces | This function returns the value of any "using" namespaces predefined for the specified Group. |
| admin.groupGetWebdavserverIds | This function returns the IDs of all webdavservers belonging to the group. |
| admin.groupGetXdbcserverIds | This function returns the IDs of all xdbcservers belonging to the group. |
| admin.groupGetXdqpSslAllowSslv3 | This function returns true if the SSL v3 protocol is enabled for the group. |
| admin.groupGetXdqpSslAllowTls | This function returns true if the TLS protocol is enabled for the group. |
| admin.groupGetXdqpSslCiphers | This function returns the SSL ciphers set for the group. |
| admin.groupGetXdqpSslDisabledProtocols | This function returns the disabled protocols for the group. |
| admin.groupGetXdqpSslEnabled | This function returns true if SSL is enabled for the group. |
| admin.groupGetXdqpTimeout | This function returns the value for the xdqp timeout setting from the specified group. |
| admin.groupHourlyScheduledTask | This function constructs a task to be invoked at hourly intervals. |
| admin.groupMinutelyScheduledTask | This function constructs a task to be invoked at intervals defined in terms of minutes. |
| admin.groupModuleLocation | This function constructs a module namespace element with the specified namespace URI and location. |
| admin.groupMonthlyScheduledTask | This function constructs a task to be invoked at monthly intervals. |
| admin.groupNamespace | This function constructs a namespace element with the specified prefix and URI. |
| admin.groupOneTimeScheduledTask | This function constructs a task to be invoked once, at a specific calendar day and time. |
| admin.groupScheduledTaskGetEnabled | This function returns true or false to indicate whether a scheduled task for a group is enabled. |
| admin.groupScheduledTaskSetEnabled | This function enables one or more scheduled tasks for a group based on the group ID and task ID. |
| admin.groupSchema | This function constructs a schema element with the specified prefix and URI. |
| admin.groupSetAuditEnabled | This function changes the audit enabled setting for the group in the configuration. |
| admin.groupSetAuditOutcomeRestriction | This function restricts the audit configuration by auditing events only if they are "success" or "failure" events. |
| admin.groupSetAuditRoleRestriction | This function restricts the audit configuration by excluding or including by role. |
| admin.groupSetAuditUriRestriction | This function restricts the audit configuration by excluding or including by document uri(s). |
| admin.groupSetAuditUserRestriction | This function restricts the audit configuration by excluding or including by user. |
| admin.groupSetAzureStorageProxy | This function sets the URL of the proxy server used by the group to access Azure blob storage. |
| admin.groupSetBackgroundIoLimit | This function sets a limit on the amount of I/O that background tasks (for example, merges) will consume. |
| admin.groupSetCompressedTreeCachePartitions | This function changes the compressed tree cache partitions setting of the group with the specified ID to the specified value. |
| admin.groupSetCompressedTreeCacheSize | This function changes the compressed tree cache size setting of the group with the specified ID to the specified value. |
| admin.groupSetCompressedTreeReadSize | This function changes the compressed tree read size setting of the group with the specified ID to the specified value. |
| admin.groupSetExpandedTreeCachePartitions | This function changes the expanded tree cache partitions setting of the group with the specified ID to the specified value. |
| admin.groupSetExpandedTreeCacheSize | This function changes the expanded tree cache size setting of the group with the specified ID to the specified value. |
| admin.groupSetFailoverEnable | This function changes the failover enable setting for the group in the configuration. |
| admin.groupSetFileLogLevel | This function changes the host file log level setting for the group in the configuration. |
| admin.groupSetHostInitialTimeout | 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.groupSetHostTimeout | This function changes the host timeout setting (the timeout for communication between hosts) for the group in the configuration. |
| admin.groupSetHttpTimeout | This function changes the HTTP timeout setting for the group in the configuration. |
| admin.groupSetHttpUserAgent | This function changes the HTTP User-Agent setting for the group in the configuration. |
| admin.groupSetKeepAuditFiles | This function changes the keep audit files setting for the group in the configuration. |
| admin.groupSetKeepLogFiles | This function changes the keep log files setting for the group in the configuration. |
| admin.groupSetListCachePartitions | This function changes the list cache partitions setting of the group with the specified ID to the specified value. |
| admin.groupSetListCacheSize | This function changes the list cache size setting of the group with the specified ID to the specified value. |
| admin.groupSetMeteringEnabled | This function enables or disables usage metering for all hosts in the specified group. |
| admin.groupSetMetersDatabase | This function specifies the database to be used to store metering data. |
| admin.groupSetModuleCacheTimeout | This function sets the number of seconds a module can be unused before being flushed from caches. |
| admin.groupSetName | This function changes the name of the group with the specified ID to the specified name. |
| admin.groupSetPerformanceMeteringEnabled | This function enables or disables performance metering for all hosts in the specified group. |
| admin.groupSetPerformanceMeteringPeriod | This function sets the period (in number of seconds) between when performance data is gathered. |
| admin.groupSetPerformanceMeteringRetainDaily | This function sets the number of days of performance metering data to retain. |
| admin.groupSetPerformanceMeteringRetainHourly | This function sets the number of days to retain hourly performance data. |
| admin.groupSetPerformanceMeteringRetainRaw | This function sets the number of days of raw performance data to retain. |
| admin.groupSetRetryTimeout | This function changes the number of seconds a request will retry before timing out. |
| admin.groupSetRotateAuditFiles | This function changes the rotate audit files setting for the group in the configuration. |
| admin.groupSetRotateLogFiles | This function changes the rotate log files setting for the group in the configuration. |
| admin.groupSetS3Domain | This function sets the simple storage service internet domain name for hosts in the group. |
| admin.groupSetS3Protocol | This function sets the simple storage service protocol for hosts in the group. |
| admin.groupSetS3Proxy | This function sets the URL of the proxy server used by the group to access AWS S3 storage. |
| admin.groupSetS3ServerSideEncryption | This function gets the method of server side encryption for data at rest on the simple storage service. |
| admin.groupSetS3ServerSideEncryptionKmsKey | This function sets the KMS key that is used by server side encryption for data at rest on the simple storage service. |
| admin.groupSetSecurityDatabase | This function sets the security database for a group to the specified database in the configuration. |
| admin.groupSetSmtpRelay | This function changes the SMTP relay setting for the group in the configuration. |
| admin.groupSetSmtpTimeout | This function changes the SMTP timeout setting for the group in the configuration. |
| admin.groupSetSystemLogLevel | This function changes the host system log level setting for the group in the configuration. |
| admin.groupSetTelemetryConfig | This function sets the update frequency for configuration changes sent to telemetry, would also be the maximum frequency at which updates will be sent. |
| admin.groupSetTelemetryLogLevel | This function sets the initial log level for telemetry, which is also the maximum (finest) log level that will be sent. |
| admin.groupSetTelemetryMetering | This function sets the level of metering data sent to telemetry. |
| admin.groupSetTelemetryProxy | This function sets the proxy server URL used by telemetry |
| admin.groupSetTelemetrySessionEndpoint | This function sets the initial session endpoint for telemetry. |
| admin.groupSetTelemetryUsage | This function enables or disables usage data sent to telemetry. |
| admin.groupSetTraceEventsActivated | This function changes the value for trace events in the group configuration. |
| admin.groupSetTripleCachePartitions | This function sets the number of partitions to allocate for the triple index cache. |
| admin.groupSetTripleCacheSize | This function sets the number of triple cache partitions to allocate. |
| admin.groupSetTripleCacheTimeout | This function sets the timeout value for the triple cache. |
| admin.groupSetTripleValueCachePartitions | This function sets the number of partitions to allocate for the triple value index cache. |
| admin.groupSetTripleValueCacheSize | This function sets the size of the value cache for the triple index. |
| admin.groupSetTripleValueCacheTimeout | This function sets the timeout value for the triple value cache. |
| admin.groupSetXdqpSslAllowSslv3 | This function enables or disables the SSL v3 protocol for the specified group. |
| admin.groupSetXdqpSslAllowTls | This function enables or disables the TLS protocol for the specified group. |
| admin.groupSetXdqpSslCiphers | This function sets SSL ciphers for the specified group. |
| admin.groupSetXdqpSslDisabledProtocols | This function sets the disabled protocols for the specified group. |
| admin.groupSetXdqpSslEnabled | This function enables or disables SSL for the group. |
| admin.groupSetXdqpTimeout | This function changes the XDQP timeout setting (the timeout for communication between data nodes and evaluator nodes) for the group in the configuration. |
| admin.groupTraceEvent | This function constructs an event element for the specified event name. |
| admin.groupUsingNamespace | This function constructs a using namespace element with the specified URI. |
| admin.groupWeeklyScheduledTask | This function constructs a task to be invoked at weekly intervals. |
| admin.hostActivateNewXdqpCertificate | This function activates the new xdqp host certificate generated by host-renew-xdqp-certificate. |
| admin.hostExists | This function determines whether or not the specified Host exists. |
| admin.hostGetForeignPort | This function returns the port used by the specified host to listen for communications from foreign hosts. |
| admin.hostGetGroup | This function returns the group ID for the host with the specified ID. |
| admin.hostGetId | This function return the ID for the specified host from the configuration. |
| admin.hostGetMode | This function return the mode for the host with the specified ID |
| admin.hostGetModeDescription | This function return the mode description for the host with the specified ID |
| admin.hostGetName | This function returns the name for the host with the specified ID. |
| admin.hostGetPort | This function returns the bind port for the host with the specified ID. |
| admin.hostGetZone | This function returns the zone for the host with the specified ID. |
| admin.hostNeedRenewXdqpCertificate | This function returns a list of hostid where the xdqp host certificate will expire within the specified duration |
| admin.hostRenewXdqpCertificate | This function generates a new xdqp host certificate for a host if the current certificate will expire within the duration. |
| admin.hostSetForeignPort | This function configures the specified domestic host to listen for communications from foreign hosts over the specified port. |
| admin.hostSetGroup | This function changes the group to which an existing host belongs to the newly specified value. |
| admin.hostSetMode | This function sets the mode and description for the host with the specified ID |
| admin.hostSetName | This function changes the name of an existing host to the newly specified value. |
| admin.hostSetPort | This function changes the bind port value for the host to the newly specified value. |
| admin.hostSetZone | This function changes the zone value for the host to the newly specified value. |
| admin.httpServerCreate | This function creates a new HTTP App Server with the specified name, root, and port in the configuration. |
| admin.legacyAssignmentPolicy | This function returns an element that represents the legacy assignment policy. |
| admin.mimetype | This function constructs a mimetype specification. |
| admin.mimetypesAdd | This function adds mimetypes to the configuration. |
| admin.mimetypesDelete | This function deletes mimetypes from the configuration. |
| admin.mimetypesGet | This function returns all the mimetypes from the configuration. |
| admin.odbcServerCreate | This function creates a new ODBC App Server with the specified name, root, and port in the configuration. |
| admin.queryAssignmentPolicy | This function returns an element that represents the query assignment policy. |
| admin.rangeAssignmentPolicy | This function returns an element that represents the range assignment policy. |
| admin.restartHosts | This function restarts MarkLogic Server for the specified hosts. |
| admin.saveConfiguration | This function saves a configuration specification to the cluster configuration files. |
| admin.saveConfigurationWithoutRestart | This function saves a configuration specification to the cluster configuration files, without restarting MarkLogic Server. |
| admin.segmentAssignmentPolicy | This function returns an element that represents the segment assignment policy. |
| admin.statisticalAssignmentPolicy | This function returns an element that represents the statistical assignment policy. |
| admin.taskserverGetDebugAllow | This function returns the value for the debug-allow setting configured on the task server for the specified group. |
| admin.taskserverGetDebugThreads | This function returns the number of debug threads configured on the task server for the specified group. |
| admin.taskserverGetDefaultInferenceSize | This function returns the default amount of memory (in megabytes) that can be used by sem:store for inference. |
| admin.taskserverGetDefaultTimeLimit | This function returns the default time limit configured on the task server for the specified group. |
| admin.taskserverGetFileLogLevel | This function returns the value for the file log level configured on the task server for the specified group. |
| admin.taskserverGetLogErrors | This function returns the value for the log-errors setting configured on the task server for the specified group. |
| admin.taskserverGetMaxInferenceSize | This function returns the maximum amount of memory in megabytes that can be used by sem:store for inference. |
| admin.taskserverGetMaxTimeLimit | This function returns the maximum time limit configured on the task server for the specified group. |
| admin.taskserverGetName | This function returns the name of the task server for the specified group from the configuration. |
| admin.taskserverGetOpsdirectorApplogLevel | This function returns the value for the Ops Director application log level configured on the task server for the specified group. |
| admin.taskserverGetPostCommitTriggerDepth | This function returns the maximum post-commit trigger depth configured on the task server for the specified group. |
| admin.taskserverGetPreCommitTriggerDepth | This function returns the maximum pre-commit trigger depth configured on the task server for the specified group. |
| admin.taskserverGetPreCommitTriggerLimit | This function returns the pre-commit trigger limit configured on the task server for the specified group. |
| admin.taskserverGetProfileAllow | This function returns the value for the profile-allow setting configured on the task server for the specified group. |
| admin.taskserverGetQueueSize | This function returns the number queue size configured on the task server for the specified group. |
| admin.taskserverGetThreads | This function returns the number of threads configured on the task server for the specified group. |
| admin.taskserverSetDebugAllow | This function sets the value for the debug allow setting for the task server in the configuration. |
| admin.taskserverSetDebugThreads | 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.taskserverSetDefaultInferenceSize | This function specifies the default value for any request's inference size. |
| admin.taskserverSetDefaultTimeLimit | This function sets the task server default time limit in the configuration. |
| admin.taskserverSetFileLogLevel | This function changes the host file log level setting for the task server in the configuration. |
| admin.taskserverSetLogErrors | This function sets the value for the log errors setting for the task server in the configuration. |
| admin.taskserverSetMaxInferenceSize | This function specifies the upper bound for any request's inference size. |
| admin.taskserverSetMaxTimeLimit | This function sets the task server max time limit in the configuration. |
| admin.taskserverSetOpsdirectorApplogLevel | This function changes the Ops Director application log level setting for the task server in the configuration. |
| admin.taskserverSetPostCommitTriggerDepth | This function sets the value for the task server post-commit trigger depth in the configuration. |
| admin.taskserverSetPreCommitTriggerDepth | This function sets the value for the task server pre-commit trigger depth in the configuration. |
| admin.taskserverSetPreCommitTriggerLimit | This function sets the value for the task server pre-commit trigger depth in the configuration. |
| admin.taskserverSetProfileAllow | This function sets the value for the profile allow setting for the task server in the configuration. |
| admin.taskserverSetQueueSize | This function sets the value in the configuration of the maximum queue size for the specified task server. |
| admin.taskserverSetThreads | 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.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. |
| alert.actionGetDescription | This function returns the description of a given action. |
| alert.actionGetModule | This function returns the module of a given action. |
| alert.actionGetModuleDb | This function returns the module database of a given action. |
| alert.actionGetModuleRoot | This function returns the module root of a given action. |
| alert.actionGetName | This function returns the name of a given action. |
| alert.actionGetOptions | This function returns the options of a given action. |
| alert.actionInsert | This function inserts the specified action into the collection. |
| alert.actionRemove | This function removes the named action from the database or throws an exception if the action does not exist. |
| alert.actionSetDescription | This function returns the action with the description of the action updated. |
| alert.actionSetModule | This function returns the action with the module of the action updated. |
| alert.actionSetModuleDb | This function sets the module database of a given action. |
| alert.actionSetModuleRoot | This function sets the module root of a given action. |
| alert.actionSetName | This function returns the action with the name of the action updated. |
| alert.actionSetOptions | This function returns the action with the options of the action updated. |
| alert.configDelete | Remove an alerting configuration identified by the specified URI. |
| alert.configGet | Gets the config associated with the specified URI. |
| alert.configGetCpfDomainNames | This function returns the CPF domain names set in the specified alerting configuration. |
| alert.configGetDescription | This function provides returns the description set in the specified alerting configuration. |
| alert.configGetId | This function returns the ID of the specified alerting configuration. |
| alert.configGetName | This function returns the name set in the specified an alerting configuration. |
| alert.configGetOptions | This function returns the options set in specified alerting configuration. |
| alert.configGetTriggerIds | This function returns the trigger IDs set in the specified alerting configuration. |
| alert.configGetUri | This function returns the URI set in the specified alerting configuration. |
| alert.configInsert | Inserts a config into the database. |
| alert.configSetCpfDomainNames | This function sets the CPF domain names in the specified alerting configuration. |
| alert.configSetDescription | This function sets the description within the specified alerting configuration. |
| alert.configSetName | This function sets the name in the specified alerting configuration. |
| alert.configSetOptions | This function sets the options in the specified alerting configuration. |
| alert.configSetTriggerIds | This function sets the trigger IDs in the specified alerting configuration. |
| alert.createTriggers | Create triggers that invoke the standard alerting trigger module. |
| alert.findMatchingRules | Returns a list of all rules associated with the specified config that match the specified document. |
| alert.getActions | This function retrieves all the named actions in the specified config URI. |
| alert.getAllRules | This function returns all rules visible to the current user. |
| alert.getMyRules | This function returns all rules associated with the current user. |
| alert.invokeMatchingActions | Finds the rules that match the specified document and invokes their associated actions. |
| alert.makeAction | This function creates the specified action. |
| alert.makeConfig | Create an alerting configuration associated with a particular URI. |
| alert.makeLogAction | Create a standard logging action named "log". |
| alert.makeRule | This function creates the specified rule. |
| alert.removeTriggers | Remove triggers whose IDs are listed in the config. |
| alert.ruleActionQuery | This function creates a query to find rules with any of the specified actions. |
| alert.ruleGetAction | This function returns the action of a given rule. |
| alert.ruleGetDescription | This function returns the description of a given rule. |
| alert.ruleGetId | This function returns the ID of a given rule. |
| alert.ruleGetName | This function returns the name of a given rule. |
| alert.ruleGetOptions | This function returns the options of a given rule. |
| alert.ruleGetQuery | Get the cts.query corresponding to the rule's query expression. |
| alert.ruleGetUserId | This function returns the user ID of a given rule. |
| alert.ruleIdQuery | This function creates a query to find rules with any of the specified IDs. |
| alert.ruleInsert | This function inserts rule into the database associated with the specified alerting configuration. |
| alert.ruleNameQuery | This function creates a query to find rules with any of the specified names. |
| alert.ruleRemove | This function removes the specified rule from the collection. |
| alert.ruleSetAction | This function returns the rule with the action updated. |
| alert.ruleSetDescription | This function returns the rule with the description of the rule updated. |
| alert.ruleSetName | This function returns the rule with the name of the rule updated. |
| alert.ruleSetOptions | This function returns the rule with the options of the rule updated. |
| alert.ruleSetQuery | Set the cts:query corresponding to the rule's query expression. |
| alert.ruleSetUserId | This function returns the rule with the user ID updated. |
| alert.ruleUserIdQuery | This function creates a query to find rules with any of the specified user IDs. |
| alert.spawnMatchingActions | Finds the rules that match the specified document and spawns their associated actions. |
| ArrayNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| ArrayNode.length | Length property on ArrayNode |
| ArrayNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| ArrayNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| ArrayNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| Attr.attributes | This is inherited from the XMLNode object. The attributes of this node. |
| Attr.childNodes | This is inherited from the XMLNode object. The children of this node. |
| Attr.firstChild | This is inherited from the XMLNode object. The first child of this node, if any. |
| Attr.hasAttributes | This is inherited from the XMLNode object. Whether this node has attributes. |
| Attr.hasChildNodes | This is inherited from the XMLNode object. Whether this node has any children. |
| Attr.isEqualNode | This is inherited from the XMLNode object. Whether this node is equal to another node. |
| Attr.isId | Whether this is an ID attribute. |
| Attr.isSameNode | This is inherited from the XMLNode object. Whether this node is the same exact node as another node. |
| Attr.isSpecified | Whether this attribute is specified explicitly or was defaulted from a schema. |
| Attr.lastChild | This is inherited from the XMLNode object. The last child of this node, if any. |
| Attr.localName | This is inherited from the XMLNode object. Return the local name of this node. |
| Attr.namespaceURI | This is inherited from the XMLNode object. Return the namespace URI of this node. |
| Attr.nextSibling | This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any. |
| Attr.nodeName | This is inherited from the XMLNode object. The DOM name of the node. |
| Attr.nodeValue | This is inherited from the XMLNode object. The DOM value of the node. |
| Attr.ownerDocument | This is inherited from the XMLNode object. The document node containing this node, if any. |
| Attr.ownerElement | The element that contains this attribute. |
| Attr.parentNode | This is inherited from the XMLNode object. The node that is this node's parent. |
| Attr.prefix | This is inherited from the XMLNode object. Return the namespace prefix of this node. |
| Attr.previousSibling | This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any. |
| Attr.textContent | This is inherited from the XMLNode object. The DOM text value of the node. |
| BinaryNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| BinaryNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| BinaryNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| BinaryNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| BooleanNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| BooleanNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| BooleanNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| BooleanNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| cdict.dictionaryDelete | Delete a custom dictionary. |
| cdict.dictionaryRead | Retrieve the custom dictionary for a language. |
| cdict.dictionaryWrite | Insert or update a custom dictionary for language. |
| cdict.getLanguages | Return the ISO language codes for all licensed languages. |
| CharacterData.attributes | This is inherited from the XMLNode object. The attributes of this node. |
| CharacterData.childNodes | This is inherited from the XMLNode object. The children of this node. |
| CharacterData.data | The character data. |
| CharacterData.firstChild | This is inherited from the XMLNode object. The first child of this node, if any. |
| CharacterData.hasAttributes | This is inherited from the XMLNode object. Whether this node has attributes. |
| CharacterData.hasChildNodes | This is inherited from the XMLNode object. Whether this node has any children. |
| CharacterData.isElementContentWhitespace | Whether this text node is ignorable whitespace. |
| CharacterData.isEqualNode | This is inherited from the XMLNode object. Whether this node is equal to another node. |
| CharacterData.isSameNode | This is inherited from the XMLNode object. Whether this node is the same exact node as another node. |
| CharacterData.lastChild | This is inherited from the XMLNode object. The last child of this node, if any. |
| CharacterData.length | The length of the character data (codepoints). |
| CharacterData.localName | This is inherited from the XMLNode object. Return the local name of this node. |
| CharacterData.namespaceURI | This is inherited from the XMLNode object. Return the namespace URI of this node. |
| CharacterData.nextSibling | This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any. |
| CharacterData.nodeName | This is inherited from the XMLNode object. The DOM name of the node. |
| CharacterData.nodeValue | This is inherited from the XMLNode object. The DOM value of the node. |
| CharacterData.ownerDocument | This is inherited from the XMLNode object. The document node containing this node, if any. |
| CharacterData.parentNode | This is inherited from the XMLNode object. The node that is this node's parent. |
| CharacterData.prefix | This is inherited from the XMLNode object. Return the namespace prefix of this node. |
| CharacterData.previousSibling | This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any. |
| CharacterData.substring | A substring of the character data, starting at a given offset and continuing for a given length. |
| CharacterData.textContent | This is inherited from the XMLNode object. The DOM text value of the node. |
| CharacterData.wholeText | The text of the text node concatenated with its logically adjacent text nodes. |
| clang.deleteUserLanguage | This function returns user languages configuration with any existing configuration item for a given language removed. |
| clang.languageConfigDelete | This function removes all custom language configuration from the cluster configuration files. |
| clang.languageConfigRead | This function reads the custom language configuration specification from the cluster configuration files. |
| clang.languageConfigWrite | This function saves a custom language configuration specification to the cluster configuration files. |
| clang.lexer | This function constructs a custom lexer configuration item, suitable for use with clang.userLanguagePlugin. |
| clang.stemmer | This function constructs a custom stemmer configuration item, suitable for use with clang.userLanguagePlugin. |
| clang.updateUserLanguage | Add or replace a configuration item for a language in the given language configuration item, and return the new configuration. |
| clang.userLanguage | This function constructs a user language configuration item, suitable for use with clang.updateUserLanguage. |
| clang.userLanguagePlugin | This function constructs a user language plugin configuration item, suitable for use with clang.userLanguage. |
| cma.applyConfig | Apply a named configuration, overriding parameters and setting options. |
| cma.generateConfig | Retrieve an individual resource, set of resources, or full cluster configuration; generate a configuration from scenarios. |
| Comment.data | This is inherited from the CharacterData object. The character data. |
| Comment.isElementContentWhitespace | This is inherited from the CharacterData object. Whether this text node is ignorable whitespace. |
| Comment.length | This is inherited from the CharacterData object. The length of the character data (codepoints). |
| Comment.substring | This is inherited from the CharacterData object. A substring of the character data, starting at a given offset and continuing for a given length. |
| Comment.wholeText | This is inherited from the CharacterData object. The text of the text node concatenated with its logically adjacent text nodes. |
| configast.apply | This function takes the Config AST representation of a server configuration for parsing and processing as a JSON object or XQuery map and applies the configuration using the functions of the Admin API. |
| configdsl.apply | This function takes the Config DSL representation of a server configuration for parsing and processing as a string or text and applies the configuration using the functions of the Admin API. |
| console.assert | If value is true, do nothing. |
| console.debug | Logs a debug-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| console.dir | Logs an object to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| console.error | Logs an error-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| console.log | Logs an info-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| console.trace | Logs a message and the JavaScript stack trace to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| console.warn | Logs a warning-level message to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| cpf.checkTransition | Verify that the current transition is the correct one for the document. |
| cpf.documentGetError | Fetch a trace of the error that caused the document's processing to fail, if any. |
| cpf.documentGetLastUpdated | Determine the date and time of the last update to the document's content, if any. |
| cpf.documentGetProcessingStatus | Determine the document's current processing status, if any. |
| cpf.documentGetState | Determine the document's current state, if any. |
| cpf.documentSetError | Set the document's error trace to the given value. |
| cpf.documentSetLastUpdated | Set the date and time of the document's last update. |
| cpf.documentSetProcessingStatus | Set the document's processing status to the given value. |
| cpf.documentSetState | Set the document's state to the given state. |
| cpf.failure | Concludes the state action in failure, advancing the state as defined by the state transition. |
| cpf.success | Concludes the action successfully, advancing the state as defined by the transition. |
| cts.afterQuery | Returns a query matching fragments committed after a specified timestamp. |
| cts.afterQueryTimestamp | Returns the timestamp with which a specified query was constructed. |
| cts.aggregate | Executes a user-defined extension aggregate function against a value lexicon or n-way co-occurrence of multiple value lexicons. |
| cts.andNotQuery | Returns a query specifying the set difference of the matches specified by two sub-queries. |
| cts.andNotQueryNegativeQuery | Returns the negative (second parameter) query used to construct the specified query. |
| cts.andNotQueryPositiveQuery | Returns the positive (first parameter) query used to construct the specified query. |
| cts.andQuery | Returns a query specifying the intersection of the matches specified by the sub-queries. |
| cts.andQueryOptions | Returns the options for the specified query. |
| cts.andQueryQueries | Returns a sequence of the queries that were used to construct the specified query. |
| cts.approxCenter | [DEPRECATED: use geo:approx-center instead] Return a point approximating the center of the given region. |
| cts.arcIntersection | [DEPRECATED: use geo:arc-intersection instead] Returns the point at the intersection of two arcs. |
| cts.avgAggregate | Returns the average of the values given a value lexicon. |
| cts.bearing | [DEPRECATED: use geo:bearing instead] Returns the true bearing in radians of the path from the first point to the second. |
| cts.beforeQuery | Returns a query matching fragments committed before or at a specified timestamp. |
| cts.beforeQueryTimestamp | Returns the timestamp with which a specified query was constructed. |
| cts.boostQuery | Returns a query specifying that matches to $matching-query should have their search relevance scores boosted if they also match $boosting-query. |
| cts.boostQueryBoostingQuery | Returns the boosting (second parameter) query used to construct the specified boost query. |
| cts.boostQueryMatchingQuery | Returns the matching (first parameter) query used to construct the specified boost query. |
| cts.boundingBoxes | [DEPRECATED: use geo:bounding-boxes instead] Returns a sequence of boxes that bound the given region. |
| cts.box | Returns a geospatial box value. |
| cts.boxEast | Returns a box's eastern boundary. |
| cts.boxIntersects | [DEPRECATED: use geo:box-intersects instead] Returns true if the box intersects with a region. |
| cts.boxNorth | Returns a box's northern boundary. |
| cts.boxSouth | Returns a box's southern boundary. |
| cts.boxWest | Returns a box's western boundary. |
| cts.circle | Returns a geospatial circle value. |
| cts.circleCenter | Returns a circle's center point. |
| cts.circleIntersects | [DEPRECATED: use geo:circle-intersects instead] Returns true if the circle intersects with a region. |
| cts.circleRadius | Returns a circle's radius. |
| cts.classify | Classifies an array of nodes based on training data. |
| cts.cluster | Produces a set of clusters from an array of nodes. |
| cts.collectionMatch | Returns values from the collection lexicon that match the specified wildcard pattern. |
| cts.collectionQuery | Match documents in at least one of the specified collections. |
| cts.collectionQueryUris | Returns the URIs used to construct the specified query. |
| cts.collectionReference | Creates a reference to the collection lexicon, for use as a parameter to cts:value-tuples. |
| cts.collections | Returns values from the collection lexicon. |
| cts.columnRangeQuery | Returns a cts.query matching documents matching a TDE-view column equals to an value. |
| cts.complexPolygon | Returns a geospatial complex polygon value. |
| cts.complexPolygonContains | [DEPRECATED: use geo:complex-polygon-contains instead] Returns true if the complex-polygon contains a region. |
| cts.complexPolygonInner | Returns a complex polygon's inner polygons. |
| cts.complexPolygonIntersects | [DEPRECATED: use geo:complex-polygon-intersects instead] Returns true if the complex-polygon intersects with a region. |
| cts.complexPolygonOuter | Returns a complex polygon's outer polygon. |
| cts.confidence | Returns the confidence of a node, or of the context node if no node is provided. |
| cts.confidenceOrder | Creates a confidence-based ordering clause, for use as an option to cts.search. |
| cts.contains | Returns true if any of a sequence of values matches a query. |
| cts.correlation | Returns the frequency-weighted correlation given a 2-way co-occurrence. |
| cts.countAggregate | Returns the count of a value lexicon. |
| cts.covariance | Returns the frequency-weighted sample covariance given a 2-way co-occurrence. |
| cts.covarianceP | Returns the frequency-weighted covariance of the population given a 2-way co-occurrence. |
| cts.deregister | Deregister a registered query, explicitly releasing the associated resources. |
| cts.destination | [DEPRECATED: use geo:destination instead] Returns the point at the given distance (in miles) along the given bearing (in radians) from the starting point. |
| cts.directoryQuery | Returns a query matching documents in the directories with the given URIs. |
| cts.directoryQueryDepth | Returns the depth used to construct the specified query. |
| cts.directoryQueryUris | Returns the URIs used to construct the specified query. |
| cts.distance | [DEPRECATED: use geo:distance instead] Returns the distance (in miles) between two points. |
| cts.distinctiveTerms | Return the most "relevant" terms in the model nodes (that is, the terms with the highest scores). |
| cts.doc | Returns the document stored in the database at the specified URI. |
| cts.documentFragmentQuery | Returns a query that matches all documents where $query matches any document fragment. |
| cts.documentFragmentQueryQuery | Returns the query used to construct the specified query. |
| cts.documentOrder | Creates a document-based ordering clause, for use as an option to cts.search. |
| cts.documentQuery | Returns a query matching documents with the given URIs. |
| cts.documentQueryUris | Returns the URIs used to construct the specified query. |
| cts.elementAttributePairGeospatialBoxes | Returns boxes derived from the specified element point lexicon(s). |
| cts.elementAttributePairGeospatialQuery | Returns a query matching elements by name which has specific attributes representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.elementAttributePairGeospatialQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementAttributePairGeospatialQueryLatitudeName | Returns the QNames used to construct the specified query. |
| cts.elementAttributePairGeospatialQueryLongitudeName | Returns the QNames used to construct the specified query. |
| cts.elementAttributePairGeospatialQueryOptions | Returns the options for the specified query. |
| cts.elementAttributePairGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.elementAttributePairGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementAttributePairGeospatialValueMatch | Returns values from the specified element attribute pair geospatial value lexicon(s) that match the specified wildcard pattern. |
| cts.elementAttributePairGeospatialValues | Returns values from the specified element-attribute-pair geospatial value lexicon(s). |
| cts.elementAttributeRangeQuery | Constructs a query that matches element-attributes by name with a range-index entry equal to a given value. |
| cts.elementAttributeRangeQueryAttributeName | Returns the QNames used to construct the specified query. |
| cts.elementAttributeRangeQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementAttributeRangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.elementAttributeRangeQueryOptions | Returns the options for the specified query. |
| cts.elementAttributeRangeQueryValue | Returns the value used to construct the specified query. |
| cts.elementAttributeRangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementAttributeReference | Creates a reference to an element attribute value lexicon, for use as a parameter to cts:value-tuples. |
| cts.elementAttributeValueCoOccurrences | Returns value co-occurrences from the specified element or element-attribute value lexicon(s). |
| cts.elementAttributeValueGeospatialCoOccurrences | Returns value co-occurrences from the specified element-attribute value lexicon with the specified geospatial lexicon. |
| cts.elementAttributeValueMatch | Returns values from the specified element-attribute value lexicon(s) that match the specified pattern. |
| cts.elementAttributeValueQuery | Returns a query matching elements by name with attributes by name with text content equal a given phrase. |
| cts.elementAttributeValueQueryAttributeName | Returns the attribute QNames used to construct the specified query. |
| cts.elementAttributeValueQueryElementName | Returns the element QNames used to construct the specified query. |
| cts.elementAttributeValueQueryOptions | Returns the options for the specified query. |
| cts.elementAttributeValueQueryText | Returns the text used to construct the specified query. |
| cts.elementAttributeValueQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementAttributeValueRanges | Returns value ranges from the specified element-attribute value lexicon(s). |
| cts.elementAttributeValues | Returns values from the specified element-attribute value lexicon(s). |
| cts.elementAttributeWordMatch | Returns words from the specified element-attribute word lexicon(s) that match a wildcard pattern. |
| cts.elementAttributeWordQuery | Returns a query matching elements by name with attributes by name with text content containing a given phrase. |
| cts.elementAttributeWordQueryAttributeName | Returns the attribute QNames used to construct the specified query. |
| cts.elementAttributeWordQueryElementName | Returns the element QNames used to construct the specified query. |
| cts.elementAttributeWordQueryOptions | Returns the options for the specified query. |
| cts.elementAttributeWordQueryText | Returns the text used to construct the specified query. |
| cts.elementAttributeWordQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementAttributeWords | Returns words from the specified element-attribute word lexicon(s). |
| cts.elementChildGeospatialBoxes | Returns boxes derived from the specified element point lexicon(s). |
| cts.elementChildGeospatialQuery | Returns a query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.elementChildGeospatialQueryChildName | Returns the QNames used to construct the specified query. |
| cts.elementChildGeospatialQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementChildGeospatialQueryOptions | Returns the options for the specified query. |
| cts.elementChildGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.elementChildGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementChildGeospatialValueMatch | Returns values from the specified element child geospatial value lexicon(s) that match the specified wildcard pattern. |
| cts.elementChildGeospatialValues | Returns values from the specified element-child geospatial value lexicon(s). |
| cts.elementGeospatialBoxes | Returns boxes derived from the specified element point lexicon(s). |
| cts.elementGeospatialQuery | Returns a query matching elements by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.elementGeospatialQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementGeospatialQueryOptions | Returns the options for the specified query. |
| cts.elementGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.elementGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementGeospatialValueMatch | Returns values from the specified element geospatial value lexicon(s) that match the specified wildcard pattern. |
| cts.elementGeospatialValues | Returns values from the specified element geospatial value lexicon(s). |
| cts.elementPairGeospatialBoxes | Returns boxes derived from the specified element point lexicon(s). |
| cts.elementPairGeospatialQuery | Returns a query matching elements by name which has specific element children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.elementPairGeospatialQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementPairGeospatialQueryLatitudeName | Returns the QNames used to construct the specified query. |
| cts.elementPairGeospatialQueryLongitudeName | Returns the QNames used to construct the specified query. |
| cts.elementPairGeospatialQueryOptions | Returns the options for the specified query. |
| cts.elementPairGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.elementPairGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementPairGeospatialValueMatch | Returns values from the specified element pair geospatial value lexicon(s) that match the specified wildcard pattern. |
| cts.elementPairGeospatialValues | Returns values from the specified element-pair geospatial value lexicon(s). |
| cts.elementQuery | Constructs a query that matches elements by name with the content constrained by the query given in the second parameter. |
| cts.elementQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementQueryQuery | Returns the query used to construct the element query. |
| cts.elementRangeQuery | Constructs a query that matches elements by name with range index entry equal to a given value. |
| cts.elementRangeQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementRangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.elementRangeQueryOptions | Returns the options for the specified query. |
| cts.elementRangeQueryValue | Returns the value used to construct the specified query. |
| cts.elementRangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementReference | Creates a reference to an element value lexicon, for use as a parameter to cts.valueTuples, temporal.axisCreate, or any other function that takes an index reference. |
| cts.elementValueCoOccurrences | Returns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified element value lexicon(s). |
| cts.elementValueGeospatialCoOccurrences | Returns value co-occurrences from the specified element value lexicon with the specified geospatial lexicon. |
| cts.elementValueMatch | Returns values from the specified element value lexicon(s) that match the specified wildcard pattern. |
| cts.elementValueQuery | Returns a query matching elements by name with text content equal a given phrase. |
| cts.elementValueQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementValueQueryOptions | Returns the options for the specified query. |
| cts.elementValueQueryText | Returns the text used to construct the specified query. |
| cts.elementValueQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementValueRanges | Returns value ranges from the specified element value lexicon(s). |
| cts.elementValues | Returns values from the specified element value lexicon(s). |
| cts.elementWalk | Returns a copy of the node, replacing any elements found with the specified expression. |
| cts.elementWordMatch | Returns words from the specified element word lexicon(s) that match a wildcard pattern. |
| cts.elementWordQuery | Returns a query matching elements by name with text content containing a given phrase. |
| cts.elementWordQueryElementName | Returns the QNames used to construct the specified query. |
| cts.elementWordQueryOptions | Returns the options for the specified query. |
| cts.elementWordQueryText | Returns the text used to construct the specified query. |
| cts.elementWordQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.elementWords | Returns words from the specified element word lexicon. |
| cts.entity | Returns a cts:entity object. |
| cts.entityDictionary | Returns a cts:entity-dictionary object. |
| cts.entityDictionaryGet | Retrieve an entity dictionary previously cached in the database. |
| cts.entityDictionaryParse | Construct a cts:entity-dictionary object by parsing it from a formatted string. |
| cts.entityHighlight | Returns a copy of the node, replacing any entities found with the specified expression. |
| cts.entityWalk | Walk an XML document or element node, evaluating a callback function against any matching entities. |
| cts.estimate | Returns the number of fragments selected by a search. |
| cts.exists | Returns true if any fragment is selected by the search, false if no fragments are selected. |
| cts.falseQuery | Returns a query that matches no fragments. |
| cts.fieldRangeQuery | Returns a cts:query matching fields by name with a range-index entry equal to a given value. |
| cts.fieldRangeQueryFieldName | Returns the fieldname used to construct the specified query. |
| cts.fieldRangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.fieldRangeQueryOptions | Returns the options for the specified query. |
| cts.fieldRangeQueryValue | Returns the value used to construct the specified query. |
| cts.fieldRangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.fieldReference | Creates a reference to a field value lexicon, for use as a parameter to cts.valueTuples. |
| cts.fieldValueCoOccurrences | Returns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified field value lexicon(s). |
| cts.fieldValueMatch | Returns values from the specified field value lexicon(s) that match the specified wildcard pattern. |
| cts.fieldValueQuery | Returns a query matching text content containing a given value in the specified field. |
| cts.fieldValueQueryFieldName | Returns the names used to construct the specified cts:field-value-query. |
| cts.fieldValueQueryOptions | Returns the options for the specified cts:field-value-query. |
| cts.fieldValueQueryText | Returns the values used to construct the specified cts:field-value-query. |
| cts.fieldValueQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.fieldValueRanges | Returns value ranges from the specified field value lexicon(s). |
| cts.fieldValues | Returns values from the specified field value lexicon(s). |
| cts.fieldWordMatch | Returns words from the specified field word lexicon(s) that match a wildcard pattern. |
| cts.fieldWordQuery | Returns a query matching fields with text content containing a given phrase. |
| cts.fieldWordQueryFieldName | Returns the names used to construct the specified cts:field-word-query. |
| cts.fieldWordQueryOptions | Returns the options for the specified cts:field-word-query. |
| cts.fieldWordQueryText | Returns the text used to construct the specified cts:field-word-query. |
| cts.fieldWordQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.fieldWords | Returns words from the specified field word lexicon. |
| cts.fitness | Returns the fitness of a node, or of the context node if no node is provided. |
| cts.fitnessOrder | Creates a fitness-based ordering clause, for use as an option to cts.search. |
| cts.frequency | Returns an integer representing the number of times in which a particular value occurs in a value lexicon lookup. |
| cts.geospatialAttributePairReference | Creates a reference to a geospatial attribute pair range index, for use as a parameter to cts.valueTuples This function will throw an exception if the specified range index does not exist. |
| cts.geospatialBoxes | Returns boxes derived from the specified point lexicon(s). |
| cts.geospatialCoOccurrences | Find value co-occurrences from two geospatial lexicons. |
| cts.geospatialElementChildReference | Creates a reference to a geospatial element child range index, for use as a parameter to cts.valueTuples. |
| cts.geospatialElementPairReference | Creates a reference to a geospatial element pair range index, for use as a parameter to cts.valueTuples. |
| cts.geospatialElementReference | Creates a reference to a geospatial element range index, for use as a parameter to cts.valueTuples. |
| cts.geospatialJsonPropertyChildReference | Creates a reference to a geospatial json property child range index, for use as a parameter to cts:value-tuples cts.valueTuples. |
| cts.geospatialJsonPropertyPairReference | Creates a reference to a geospatial JSON property pair range index, for use as a parameter to cts.valueTuples. |
| cts.geospatialJsonPropertyReference | Creates a reference to a geospatial json property range index, for use as a parameter to cts.valueTuples. |
| cts.geospatialPathReference | Creates a reference to a geospatial path range index, for use as a parameter to cts.valueTuples. |
| cts.geospatialRegionPathReference | Create a reference to a geospatial region path index, for use as a parameter to cts.geospatialRegionQuery and other query operations on geospatial region indexes. |
| cts.geospatialRegionQuery | Construct a query to match regions in documents that satisfy a specified relationship relative to other regions. |
| cts.geospatialRegionQueryOperation | Returns the comparison operation specified when constructing the input query. |
| cts.geospatialRegionQueryOptions | Returns the options specified when constructing the input query. |
| cts.geospatialRegionQueryReference | Returns the geospatial region path index reference(s) specified when constructing the input query. |
| cts.geospatialRegionQueryRegion | Returns the region criteria specified when constructing the input query. |
| cts.geospatialRegionQueryWeight | Returns the weight specified when constructing the input query. |
| cts.highlight | Returns a copy of the node, replacing any text matching the query with the specified expression. |
| cts.indexOrder | Creates a index-based ordering clause, for use as an option to cts.search. |
| cts.jsonPropertyChildGeospatialQuery | Returns a query matching json properties by name which has specific children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.jsonPropertyChildGeospatialQueryChildName | Returns the names used to construct the specified query. |
| cts.jsonPropertyChildGeospatialQueryOptions | Returns the options for the specified query. |
| cts.jsonPropertyChildGeospatialQueryPropertyName | Returns the names used to construct the specified query. |
| cts.jsonPropertyChildGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.jsonPropertyChildGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.jsonPropertyGeospatialQuery | Returns a query matching json properties by name whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.jsonPropertyGeospatialQueryOptions | Returns the options for the specified query. |
| cts.jsonPropertyGeospatialQueryPropertyName | Returns the json property names used to construct the specified query. |
| cts.jsonPropertyGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.jsonPropertyGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.jsonPropertyPairGeospatialQuery | Returns a query matching json properties by name which has specific property children representing latitude and longitude values for a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.jsonPropertyPairGeospatialQueryLatitudeName | Returns the property names used to construct the specified query. |
| cts.jsonPropertyPairGeospatialQueryLongitudeName | Returns the property names used to construct the specified query. |
| cts.jsonPropertyPairGeospatialQueryOptions | Returns the options for the specified query. |
| cts.jsonPropertyPairGeospatialQueryPropertyName | Returns the property names used to construct the specified query. |
| cts.jsonPropertyPairGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.jsonPropertyPairGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.jsonPropertyRangeQuery | Returns a cts:query matching JSON properties by name with a range-index entry equal to a given value. |
| cts.jsonPropertyRangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.jsonPropertyRangeQueryOptions | Returns the options for the specified query. |
| cts.jsonPropertyRangeQueryPropertyName | Returns the JSON property name used to construct the specified query. |
| cts.jsonPropertyRangeQueryValue | Returns the value used to construct the specified query. |
| cts.jsonPropertyRangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.jsonPropertyReference | Creates a reference to a JSON property value lexicon, for use as a parameter to cts:value-tuples. |
| cts.jsonPropertyScopeQuery | Returns a cts:query matching JSON properties by name with the content constrained by the given cts:query in the second parameter. |
| cts.jsonPropertyScopeQueryPropertyName | Returns the JSON property name used to construct the specified query. |
| cts.jsonPropertyScopeQueryQuery | Returns the query used to construct the property scope query. |
| cts.jsonPropertyValueQuery | Returns a query matching JSON properties by name with value equal the given value. |
| cts.jsonPropertyValueQueryOptions | Returns the options for the specified query. |
| cts.jsonPropertyValueQueryPropertyName | Returns the JSON property name used to construct the specified query. |
| cts.jsonPropertyValueQueryText | Returns the text used to construct the specified query. |
| cts.jsonPropertyValueQueryValue | Returns the value used to construct the specified query. |
| cts.jsonPropertyValueQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.jsonPropertyWordMatch | Returns words from the specified JSON property word lexicon(s) that match a wildcard pattern. |
| cts.jsonPropertyWordQuery | Returns a query matching JSON properties by name with text content containing a given phrase. |
| cts.jsonPropertyWordQueryOptions | Returns the options for the specified query. |
| cts.jsonPropertyWordQueryPropertyName | Returns the name used to construct the specified query. |
| cts.jsonPropertyWordQueryText | Returns the text used to construct the specified query. |
| cts.jsonPropertyWordQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.jsonPropertyWords | Returns words from the specified JSON property word lexicon. |
| cts.linearModel | Returns a linear model that fits the frequency-weighted data set. |
| cts.linestring | Returns a geospatial linestring value. |
| cts.linestringVertices | Returns a linestring's vertices. |
| cts.locksFragmentQuery | Returns a query that matches all documents where $query matches document-locks. |
| cts.locksFragmentQueryQuery | Returns the query used to construct the specified query. |
| cts.lsqtQuery | Returns only documents before LSQT or a timestamp before LSQT for stable query results. |
| cts.lsqtQueryOptions | Returns the options for the specified query. |
| cts.lsqtQueryTemporalCollection | Returns the name of the temporal collection used to construct specified query. |
| cts.lsqtQueryTimestamp | Returns timestamp used to construct the specified query. |
| cts.lsqtQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.matchRegions | Find regions in documents that have a spatial relationship to one or more caller-supplied regions. |
| cts.max | Returns the maximal value given a value lexicon. |
| cts.median | Returns a frequency-weighted median of a sequence. |
| cts.min | Returns the minimal value given a value lexicon. |
| cts.nearQuery | Returns a query matching all of the specified queries, where the matches occur within the specified distance from each other. |
| cts.nearQueryDistance | Returns the distance used to construct the near query. |
| cts.nearQueryOptions | Returns the options for the specified query. |
| cts.nearQueryQueries | Returns the query sequence used to construct the near query. |
| cts.nearQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.notInQuery | Returns a query matching the first sub-query, where those matches do not occur within 0 distance of the other query. |
| cts.notInQueryNegativeQuery | Returns the negative (second parameter) query used to construct the specified query. |
| cts.notInQueryPositiveQuery | Returns the positive (first parameter) query used to construct the specified query. |
| cts.notQuery | Returns a query specifying the matches not specified by its sub-query. |
| cts.notQueryQuery | Returns the query used to construct the specified query. |
| cts.notQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.orQuery | Returns a query specifying the union of the matches specified by the sub-queries. |
| cts.orQueryOptions | Returns the options for the specified query. |
| cts.orQueryQueries | Returns a sequence of the queries that were used to construct the specified query. |
| cts.parse | Parses a query string |
| cts.parseWkt | [DEPRECATED: use geo:parse-wkt instead] Returns a sequence of geospatial regions parsed from Well-Known Text format. |
| cts.partOfSpeech | Returns the part of speech for a cts:token, if any. |
| cts.pathGeospatialQuery | Returns a query matching path expressions whose content represents a point contained within the given geographic box, circle, or polygon, or equal to the given point. |
| cts.pathGeospatialQueryOptions | Returns the options for the specified query. |
| cts.pathGeospatialQueryPathExpression | Returns the path expressions used to construct the specified query. |
| cts.pathGeospatialQueryRegion | Returns the geographical regions with which the specified query was constructed. |
| cts.pathGeospatialQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.pathRangeQuery | Returns a cts:query matching documents where the content addressed by an XPath expression satisfies the specified relationship (=, <, >, etc.) with respect to the input criteria values. |
| cts.pathRangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.pathRangeQueryOptions | Returns the options for the specified query. |
| cts.pathRangeQueryPathName | Returns the path expression used to construct the specified query. |
| cts.pathRangeQueryValue | Returns the value used to construct the specified query. |
| cts.pathRangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.pathReference | Creates a reference to a path value lexicon, for use as a parameter to cts:value-tuples. |
| cts.percentile | Returns a sequence of percentile(s) given a sequence of percentage(s). |
| cts.percentRank | Returns the rank of a value in a data set as a percentage of the data set. |
| cts.period | Creates a period value, for use as a parameter to cts:period-range-query or cts:period-compare-query. |
| cts.periodCompare | Compares two periods using the specified comparison operator. |
| cts.periodCompareQuery | Returns a cts:query matching documents that have relevant pair of period values. |
| cts.periodCompareQueryAxis1 | Returns the name of the first axis used to construct the specified query. |
| cts.periodCompareQueryAxis2 | Returns the name of the second axis used to construct the specified query. |
| cts.periodCompareQueryOperator | Returns the operator used to construct the specified query. |
| cts.periodCompareQueryOptions | Returns the options for the specified query. |
| cts.periodRangeQuery | Returns a cts:query matching axis by name with a period value with an operator. |
| cts.periodRangeQueryAxis | Returns the axis name used to construct the specified query. |
| cts.periodRangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.periodRangeQueryOptions | Returns the options for the specified query. |
| cts.periodRangeQueryPeriod | Returns the period used to construct the specified query. |
| cts.plan | Returns an array of JavaScript objects recording information about how the given search will be processed by the index. |
| cts.point | Returns a point value. |
| cts.pointLatitude | Returns a point's latitude value. |
| cts.pointLongitude | Returns a point's longitude value. |
| cts.polygon | Returns a geospatial polygon value. |
| cts.polygonContains | [DEPRECATED: use geo:polygon-contains instead] Returns true if the polygon contains a region. |
| cts.polygonIntersects | [DEPRECATED: use geo:polygon-intersects instead] Returns true if the polygon intersects with a region. |
| cts.polygonVertices | Returns a polygon's vertices. |
| cts.propertiesFragmentQuery | Returns a query that matches all documents where $query matches document-properties. |
| cts.propertiesFragmentQueryQuery | Returns the query used to construct the specified query. |
| cts.quality | Returns the quality of a node, or of the context node if no node is provided. |
| cts.qualityOrder | Creates a quality-based ordering clause, for use as an option to cts.search. |
| cts.query | Creates a query. |
| cts.rangeQuery | Returns a cts:query matching specified nodes with a range-index entry compared to a given value. |
| cts.rangeQueryIndex | Returns the range index used to construct the specified query. |
| cts.rangeQueryOperator | Returns the operator used to construct the specified query. |
| cts.rangeQueryOptions | Returns the options for the specified query. |
| cts.rangeQueryValue | Returns the value used to construct the specified query. |
| cts.rangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.rank | Returns the rank of a value in a data set. |
| cts.referenceCollation | Accessor for the collation of a reference to a string value lexicon. |
| cts.referenceCoordinateSystem | Accessor for the coordinate-system of a reference to a geospatial lexicon. |
| cts.referenceNamespaces | Accessor for the namespaces of a reference to a [geospatial] path lexicon. |
| cts.referenceNullable | Returns true() if the reference is nullable, false() otherwise. |
| cts.referenceParse | Creates a reference to a value lexicon by parsing its XML or JSON representation, for use as a parameter to cts:value-tuples. |
| cts.referenceScalarType | Accessor for the scalar type of a reference to a value lexicon. |
| cts.regionContains | [DEPRECATED: use geo:region-contains instead] Returns true if the region contains the other region. |
| cts.regionIntersects | [DEPRECATED: use geo:region-intersects instead] Returns true if the region intersects with a region. |
| cts.register | Register a query for later use. |
| cts.registeredQuery | Returns a query matching fragments specified by previously registered queries (see cts:register). |
| cts.registeredQueryIds | Returns the registered query identifiers used to construct the specified query. |
| cts.registeredQueryOptions | Returns the options for the specified query. |
| cts.registeredQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.relevanceInfo | Return the relevance score computation report for a node. |
| cts.remainder | Returns an estimated search result size for a node, or of the context node if no node is provided. |
| cts.reverseQuery | Construct a query that matches serialized cts queries, based on a set of model input nodes. |
| cts.reverseQueryNodes | Returns the nodes used to construct the specified query. |
| cts.reverseQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.score | Returns the score of a node, or of the context node if no node is provided. |
| cts.scoreOrder | Creates a score-based ordering clause, for use as an option to cts.search. |
| cts.search | Returns a relevance-ordered sequence of nodes specified by a given query. |
| cts.shortestDistance | [DEPRECATED: use geo:shortest-distance instead] Returns the great circle distance (in miles) between a point and an region. |
| cts.similarQuery | Returns a query matching nodes similar to the model nodes. |
| cts.similarQueryNodes | Returns the nodes used to construct the specified query. |
| cts.similarQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.stddev | Returns a frequency-weighted sample standard deviation given a value lexicon. |
| cts.stddevP | Returns a frequency-weighted standard deviation of the population given a value lexicon. |
| cts.stem | Returns the stem(s) for a word. |
| cts.sumAggregate | Returns the sum of the values given a value lexicon. |
| cts.thresholds | Compute precision, recall, the F measure, and thresholds for the classes computed by the classifier, by comparing with the labels for the same set. |
| cts.tokenize | Tokenizes text into words, punctuation, and spaces. |
| cts.toWkt | [DEPRECATED: use geo:to-wkt instead] Returns a sequence of strings in Well-Known Text format. |
| cts.train | Produces a set of classifiers from a list of labeled training documents. |
| cts.tripleRangeQuery | Returns a cts.query matching triples with a triple index entry equal to the given values. |
| cts.tripleRangeQueryObject | Returns the object value used to construct the specified query. |
| cts.tripleRangeQueryOperator | Returns the operators used to construct the specified query. |
| cts.tripleRangeQueryOptions | Returns the options for the specified query. |
| cts.tripleRangeQueryPredicate | Returns the predicate value used to construct the specified query. |
| cts.tripleRangeQuerySubject | Returns the subject value used to construct the specified query. |
| cts.tripleRangeQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.triples | Returns values from the triple index. |
| cts.tripleValueStatistics | Returns statistics from the triple index for the values given. |
| cts.trueQuery | Returns a query that matches all fragments. |
| cts.unordered | Specifies that results should be unordered, for use with cts.search. |
| cts.uriMatch | Returns values from the URI lexicon that match the specified wildcard pattern. |
| cts.uriReference | Creates a reference to the URI lexicon, for use as a parameter to cts:value-tuples. |
| cts.uris | Returns values from the URI lexicon. |
| cts.validDocumentPatchPath | Parses path expressions and resolves namespaces using the $map parameter. |
| cts.validExtractPath | Parses path expressions and resolves namespaces using the $map parameter. |
| cts.validIndexPath | Parses path expressions and resolves namespaces based on the server run-time environment. |
| cts.validOpticPath | Parses path expressions and resolves namespaces using the $map parameter. |
| cts.validTdeContext | Parses path expressions and resolves namespaces using the $map parameter. |
| cts.valueCoOccurrences | Returns value co-occurrences (that is, pairs of values, both of which appear in the same fragment) from the specified value lexicon(s). |
| cts.valueMatch | Returns values from the specified value lexicon(s) that match the specified wildcard pattern. |
| cts.valueRanges | Returns value ranges from the specified value lexicon(s). |
| cts.values | Returns values from the specified value lexicon(s). |
| cts.valueTuples | Returns value co-occurrence tuples (that is, tuples of values, each of which appear in the same fragment) from the specified value lexicons. |
| cts.variance | Returns a frequency-weighted sample variance given a value lexicon. |
| cts.varianceP | Returns a frequency-weighted variance of the population given a value lexicon. |
| cts.walk | Walks a node, evaluating a callback function for any text matching a query. |
| cts.wordMatch | Returns words from the word lexicon that match the wildcard pattern. |
| cts.wordQuery | Returns a query matching text content containing a given phrase. |
| cts.wordQueryOptions | Returns the options for the specified query. |
| cts.wordQueryText | Returns the text used to construct the specified query. |
| cts.wordQueryWeight | Returns the weight with which the specified query was constructed. |
| cts.words | Returns words from the word lexicon. |
| dls.asOfQuery | This function returns a query that matches the most recent numbered version of documents that were created before the specified date and time. |
| dls.authorQuery | This function returns a query that matches documents authored by the specified user. |
| dls.breakCheckout | This function breaks (unlocks) a checked-out document |
| dls.documentAddCollections | This function adds the named document to the specified collections. |
| dls.documentAddPermissions | This function adds the specified permissions for the named document. |
| dls.documentAddProperties | This function adds the specified properties to any existing properties associated with the named document. |
| dls.documentCheckin | This function checks in (unlocks) the document at the specified URI to allow other users to modify the document. |
| dls.documentCheckout | This function checks out (locks) the document at the specified URI to prevent other users from modifying the document. |
| dls.documentCheckoutStatus | This function returns a checkout element containing the checkout status of the specified document. |
| dls.documentCheckoutUpdateCheckin | This function allows you to checkout, update, and checkin a managed document in a single transaction. |
| dls.documentDelete | This function removes the specified managed document. |
| dls.documentExtractPart | This function extracts an XML element from an existing document and creates a new document from the extracted element. |
| dls.documentGetPermissions | This function gets the permissions for the specified document from the point of view of the Library Services API. |
| dls.documentHistory | Returns the version history of the document located at the specified URI. |
| dls.documentIncludeQuery | This function returns a query that matches any managed document that has an XInclude link that exactly matches the specified URI. |
| dls.documentInsertAndManage | This function inserts a document into the database and places the document under management. |
| dls.documentIsManaged | This function determines whether or not the document at the specified URI is managed. |
| dls.documentManage | This function places a document under management. |
| dls.documentPurge | This function deletes all numbered versions of the specified managed document and its referenced documents, as specified by the retention policies set by dls.retentionRule . |
| dls.documentRemoveCollections | This function removes the named document from the specified collection. |
| dls.documentRemovePermissions | This function removes the specified permissions from the named document. |
| dls.documentRemoveProperties | This function removes the specified properties from the named document. |
| dls.documentRetentionRules | This function returns a sequence of dls:retentionRule element nodes. |
| dls.documentSetCollections | This function sets the named document to the specified collections. |
| dls.documentSetPermissions | This function sets the specified permissions for the named document. |
| dls.documentSetProperties | This function sets the properties of a document to the given sequence of elements. |
| dls.documentSetProperty | This function sets a property on a document. |
| dls.documentSetQuality | This function sets the quality of the document with the given URI. |
| dls.documentsQuery | This function returns a query that matches the latest versions of the managed documents in the database. |
| dls.documentUnmanage | Removes the specified document from management. |
| dls.documentUpdate | This function updates the managed document at the specified URI with the specified contents. |
| dls.documentVersion | This function returns a particular version of a managed document. |
| dls.documentVersionAsOf | This function returns the most recent version of a document as of a point in time. |
| dls.documentVersionDelete | This function removes the specified version of the managed document at the specified URI. |
| dls.documentVersionQuery | This function returns a query that matches the specified version of the managed documents. |
| dls.documentVersionsQuery | This function returns a query that matches any version of the specified URI. |
| dls.documentVersionUri | This function returns the URI of the specified version of the document located at the specified URI. |
| dls.documentVersionUris | This function returns the URIs of all versions of a managed document. |
| dls.latestValidationResults | Returns a report describing the status of an upgrade from a pre-MarkLogic 8 DLS repository. |
| dls.linkExpand | This function performs a single level expansion of a single XInclude reference. |
| dls.linkReferences | This function returns a list of all the distinct URIs of documents referenced (either directly or indirectly) in the expansion of the node. |
| dls.nodeExpand | This function recursively examines the node for XInclude references and expands them, following the rules of the XInclude specification. |
| dls.purge | This function deletes all numbered versions of managed documents and its referenced documents (such as /foo/bar.xml_versions/1-bar.xml), as specified by the retention policy set by one or more dls.retentionRule functions. |
| dls.retentionRule | This function creates and returns a retention rule element. |
| dls.retentionRuleInsert | This function inserts retention rules into the database. |
| dls.retentionRuleRemove | This function removes the specified retention rules from the database. |
| dls.retentionRules | This function returns the specified retention rules from the database. |
| dls.setUpgradeStatus | Sets DLS the upgrade status to current or compatibility-mode. |
| dls.startUpgrade | Upgrades a previous version DLS Database to the current format. |
| dls.validateAllDocuments | Returns a report of the status of the DLS upgrade process. |
| Document.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| Document.documentFormat | The format of the document node, "JSON", "XML", "TEXT", or "BINARY" |
| Document.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| Document.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| Document.root | The root node of the document. |
| Document.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| DocumentsSearch.filter | Specifies filtering the documents by inspecting the contents of matched and ordered documents to populate the slice. |
| DocumentsSearch.map | Specifies a function similar to Array.prototype.map() to apply to each document within the slice or the configuration for the built-in mapper. |
| DocumentsSearch.orderBy | Specifies the sort order for matched documents. |
| DocumentsSearch.reduce | Specifies a function similar to Array.prototype.reduce() to apply to each document within the slice. |
| DocumentsSearch.result | Executes the document search definition and returns a result Iterable with an estimate property for the total number of matched documents, a results property with an array holding the subsequence of documents in the slice, and other properties if specified by withOptions(). |
| DocumentsSearch.slice | Specifies a subsequence of matched, sorted, and filtered documents to retrieve. |
| DocumentsSearch.where | Specifies which documents to match based on the indexes over the documents. |
| DocumentsSearch.withOptions | Configure advanced document search options. |
| Element.attributes | This is inherited from the XMLNode object. The attributes of this node. |
| Element.childNodes | This is inherited from the XMLNode object. The children of this node. |
| Element.firstChild | This is inherited from the XMLNode object. The first child of this node, if any. |
| Element.getAttribute | Get the value of the attribute of this element with the given name, if any. |
| Element.getAttributeNode | Get the attribute of this element with the given name, if any. |
| Element.getAttributeNodeNS | Get the attribute of this element with the given localname and namespace URI, if any. |
| Element.getAttributeNS | Get the value of the attribute of this element with the given localname and namespace URI, if any. |
| Element.getElementsByTagName | Return all the elements that are descendants of the current element that have the given name. |
| Element.getElementsByTagNameNS | Return all the elements that are descendants of the current element that have the given localname and namespace URI. |
| Element.hasAttribute | Whether this element has an attribute with the given name. |
| Element.hasAttributeNS | Whether this element has an attribute the given localname and namespace URI. |
| Element.hasAttributes | This is inherited from the XMLNode object. Whether this node has attributes. |
| Element.hasChildNodes | This is inherited from the XMLNode object. Whether this node has any children. |
| Element.isEqualNode | This is inherited from the XMLNode object. Whether this node is equal to another node. |
| Element.isSameNode | This is inherited from the XMLNode object. Whether this node is the same exact node as another node. |
| Element.lastChild | This is inherited from the XMLNode object. The last child of this node, if any. |
| Element.localName | This is inherited from the XMLNode object. Return the local name of this node. |
| Element.namespaceURI | This is inherited from the XMLNode object. Return the namespace URI of this node. |
| Element.nextSibling | This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any. |
| Element.nodeName | This is inherited from the XMLNode object. The DOM name of the node. |
| Element.nodeValue | This is inherited from the XMLNode object. The DOM value of the node. |
| Element.ownerDocument | This is inherited from the XMLNode object. The document node containing this node, if any. |
| Element.parentNode | This is inherited from the XMLNode object. The node that is this node's parent. |
| Element.prefix | This is inherited from the XMLNode object. Return the namespace prefix of this node. |
| Element.previousSibling | This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any. |
| Element.schemaTypeInfo | The schema type information associated with this element. |
| Element.textContent | This is inherited from the XMLNode object. The DOM text value of the node. |
| entity.dictionaryInsert | Put an entity dictionary into the database in the appropriate format. |
| entity.dictionaryLoad | Load an entity dictionary from the filesystem into the database in the appropriate format. |
| entity.enrich | Returns the entity-enriched XML for the given XML node using the provided dictionary. |
| entity.extract | Extract entities from a document using the provided entity dictionary. |
| entity.skosDictionary | Construct an entity dictionary from a SKOS ontology loaded into the database as triples. |
| Error.code | For DOM errors, this is the DOM error code. |
| Error.data | The data passed to the error. |
| Error.message | The formatted error message. |
| Error.name | The error name. |
| Error.retryable | Whether the error can be retried. |
| Error.stack | A string representation of the call stack. |
| Error.stackFrames | An array of stack frames. |
| Error.toString | A string representation of the error. |
| es.databasePropertiesGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| es.extractionTemplateGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| es.instanceConverterGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| es.instanceFromDocument | This function is deprecated and will not be supported in MarkLogic 11. |
| es.instanceGetAttachments | This function is deprecated and will not be supported in MarkLogic 11. |
| es.instanceJsonFromDocument | This function is deprecated and will not be supported in MarkLogic 11. |
| es.instanceXmlFromDocument | This function is deprecated and will not be supported in MarkLogic 11. |
| es.modelFromXml | This function is deprecated and will not be supported in MarkLogic 11. |
| es.modelGetTestInstances | This function is deprecated and will not be supported in MarkLogic 11. |
| es.modelToXml | This function is deprecated and will not be supported in MarkLogic 11. |
| es.modelValidate | Validates an entity services model descriptor. |
| es.piiGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| es.schemaGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| es.searchOptionsGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| es.versionTranslatorGenerate | This function is deprecated and will not be supported in MarkLogic 11. |
| FacetDefinition.groupInto | Groups facet values into buckets between bound values as in a ValuesSearch definition. |
| FacetDefinition.map | Specifies a function similar to Array.prototype.map() to apply to each value within the slice or the configuration for the built-in mapper, as in a ValuesSearch definition. |
| FacetDefinition.orderBy | Specifies the sort order for facet values, as in a ValuesSearch definition. |
| FacetDefinition.othersWhere | Specify a query to apply to facets other than this one. |
| FacetDefinition.reduce | Specifies a function similar to Array.prototype.reduce() to apply to each value within the slice or a configuration object for the built-in reducer, as in a ValuesSearch definition. |
| FacetDefinition.slice | Specifies a subsequence of values to retrieve as in a ValuesSearch definition. |
| FacetDefinition.thisWhere | Specify a query to apply only to this facet. |
| FacetDefinition.withOptions | Configure advanced options for facet generation. |
| FacetsSearch.result | Executes the facets search definition and returns the results. |
| FacetsSearch.where | Specify one or an array of cts.query's used to qualify the facet values and the document result set (if requested). |
| FacetsSearch.withOptions | Configure advanced options for facet generation. |
| flexrep.apply | This function applies an update element to the current database. |
| flexrep.binaryChunkUris | This function returns the URIs of binary chunks that were created before the given dateTime. |
| flexrep.configurationCreate | This function creates a new replication configuration element. |
| flexrep.configurationDelete | This function deletes a replication configuration. |
| flexrep.configurationDomainIds | This function returns the IDs of the domains configured for the Master database. |
| flexrep.configurationGet | This function gets the replication configuration for a CPF domain. |
| flexrep.configurationGetAlertingUri | Get the alerting URI associated with a FlexRep configuration. |
| flexrep.configurationGetDomainName | This function returns the domain name associated with the specified replication configuration. |
| flexrep.configurationGetId | This function returns the ID of the replication configuration. |
| flexrep.configurationInsert | This function inserts a replication configuration to the database. |
| flexrep.configurationSetAlertingUri | Set the alerting URI for a FlexRep configuration. |
| flexrep.configurationTarget | This function returns a specified target for a configuration, or throws an error if it does not exist. |
| flexrep.configurationTargetGetDocumentsPerBatch | This function returns the value of the documents-per-batch setting for the replication target. |
| flexrep.configurationTargetGetEnabled | This function returns true if the specified replication target is enabled, otherwise it returns false. |
| flexrep.configurationTargetGetExternalUser | This function returns the external user information for a target, if any exists. |
| flexrep.configurationTargetGetFilterModule | This function returns the filter module used by the specified replication target. |
| flexrep.configurationTargetGetFilterOptions | This function returns the filter options configured for the specified replication target. |
| flexrep.configurationTargetGetHttpOptions | This function returns the HTTP options configured for the specified replication target. |
| flexrep.configurationTargetGetId | This function returns the ID of the named replication target. |
| flexrep.configurationTargetGetImmediatePush | Get the immediate push flag for a target. |
| flexrep.configurationTargetGetName | This function returns the name of the specified target. |
| flexrep.configurationTargetGetReplicateCpf | This function returns true if CFG replication is enabled for the specified replication target, otherwise it returns false. |
| flexrep.configurationTargetGetRetrySecondsMax | This function sets the replication retry maximum value for the specified replication target. |
| flexrep.configurationTargetGetRetrySecondsMin | This function returns the value of the minimum retry setting for the replication target. |
| flexrep.configurationTargetGetUrls | This function returns the URLs for the specified targets. |
| flexrep.configurationTargetGetUserId | Get the user ID associated with a target, if one exists. |
| flexrep.configurationTargets | This function returns the replication targets for a configuration. |
| flexrep.configurationTargetSetDocumentsPerBatch | This function sets the documents-per-batch value for the specified replication target. |
| flexrep.configurationTargetSetEnabled | This function enables or disables the specified replication target. |
| flexrep.configurationTargetSetFilterModule | This function sets the specified filter for this replication configuration. |
| flexrep.configurationTargetSetFilterOptions | This function sets the specified filter options for this replication configuration. |
| flexrep.configurationTargetSetHttpOptions | This function sets the HTTP options on the specified replication target. |
| flexrep.configurationTargetSetImmediatePush | Set a target's "immediate push" flag. |
| flexrep.configurationTargetSetName | This function sets the name of the specified replication target. |
| flexrep.configurationTargetSetReplicateCpf | This function enables and disables CPF replication. |
| flexrep.configurationTargetSetRetrySecondsMax | This function sets the replication retry maximum value for the specified replication target. |
| flexrep.configurationTargetSetRetrySecondsMin | This function sets the replication retry minimum value for the specified replication target. |
| flexrep.configurationTargetSetUrls | This function sets the URLs for the specified replication target. |
| flexrep.configurationTargetSetUserId | Set a target's user-id. |
| flexrep.configureDatabase | This function creates any indexes needed for CPF based replication. |
| flexrep.createAppserver | This function creates a flexrep App Server programatically, without needing to know all of the specific settings. |
| flexrep.databaseNeedsConfiguration | This function checks the configuration of a database to see if it has all of the necessary indexes for Flexible Replication to work at its best. |
| flexrep.delete | This function applies a delete element to the current database. |
| flexrep.documentReset | This function resets the URI status for all replication targets. |
| flexrep.documentStatus | This function returns the flexrep.documentStatus element for the document at the specified URI in the specified domain. |
| flexrep.domainAlertingUri | Generate an alerting URI for a CPF domain. |
| flexrep.domainStatus | This function returns the replication status for the specified replicated CPF domain. |
| flexrep.domainTargetReset | This function resets the domain for the specified replication targets. |
| flexrep.domainTargetStatuses | This function returns the status for each domain target. |
| flexrep.doPull | This function is used by a Replica to pull updates from the Master. |
| flexrep.getDomainName | Get a CPF domain's name. |
| flexrep.getTargetName | Get a target's name, or nothing if the domain or target does not exist. |
| flexrep.inboundFilterCreate | This function creates an inbound filter element. |
| flexrep.inboundFilterDelete | This function deletes the inbound filter for this database. |
| flexrep.inboundFilterGet | This function gets any inbound filter that is contained in the database, or an empty sequence if none is configured. |
| flexrep.inboundFilterInsert | This function inserts an inbound filter configuration into the database. |
| flexrep.process | This function processes one or more replicated updates for the specified domain ID, ordered by oldest changes first, and returns the results. |
| flexrep.pullCreate | This function creates a configuration on a Replica database to pull updates from the Master database. |
| flexrep.pullDelete | This function deletes the pull configuration from the Replica database. |
| flexrep.pullGet | This function returns the pull replication configuration for the specified domain. |
| flexrep.pullGetAll | This function returns the pull replication configurations for all of the domains. |
| flexrep.pullGetById | This function returns the pull replication configuration for the specified Pull ID. |
| flexrep.pullGetDomainId | This function returns the ID of the domain associated with the specified pull configuration. |
| flexrep.pullGetEnabled | Get the enabled flag for a pull configuration. |
| flexrep.pullGetHttpOptions | This function returns the HTTP options associated with the specified pull configuration. |
| flexrep.pullGetId | This function returns the ID for the specified pull configuration. |
| flexrep.pullGetName | This function returns the name of the specified pull configuration. |
| flexrep.pullGetTargetId | This function returns the ID of the target associated with the specified pull configuration. |
| flexrep.pullGetUrls | This function returns the URLs associated with the specified pull configuration. |
| flexrep.pullInsert | This function inserts the specified pull configuration into the Replica database. |
| flexrep.pullSetDomainId | This function sets the domain ID for the specified pull configuration. |
| flexrep.pullSetEnabled | Set the enabled flag for a pull. |
| flexrep.pullSetHttpOptions | This function sets the HTTP options for the specified pull configuration. |
| flexrep.pullSetName | This function sets the name of the specified pull configuration. |
| flexrep.pullSetTargetId | This function sets the ID of the replication target for the specified pull replication configuration. |
| flexrep.pullSetUrls | This function sets the URLs for the specified pull configuration. |
| flexrep.pushLocalForest | This function pushes pending replication updates (either retries or zero-day) for the specified forest on the current host. |
| flexrep.pushLocalForests | This function pushes deletes and any pending replication updates (either retries or zero-day) from all of the forests on the current host. |
| flexrep.pushLocalForestTarget | Push a batch of documents from a single forest to a single target, and respawn a new task to do this repeatedly until either nothing remains to replicate or the spawn limit is reached. |
| flexrep.remoteTargetStatus | This function returns the status of the target in a pull replication configuration. |
| flexrep.targetCreate | This function creates a new target and add it to the specified configuration. |
| flexrep.targetDelete | This function deletes a target from a replication configuration. |
| flexrep.targetErrorDocuments | This function returns status information for documents that failed to replicate for the specified domain and targets. |
| flexrep.targetStatus | This function returns the replication status for the specified targets within the specified replicated domain. |
| flexrep.upgradeAppserver | This function is used by appserver upgrade code. |
| fn.abs | Returns the absolute value of $arg. |
| fn.adjustDateTimeToTimezone | Adjusts an xs:dateTime value to a specific timezone, or to no timezone at all. |
| fn.adjustDateToTimezone | Adjusts an xs:date value to a specific timezone, or to no timezone at all. |
| fn.adjustTimeToTimezone | Adjusts an xs:time value to a specific timezone, or to no timezone at all. |
| fn.analyzeString | The result of the function is a new element node whose string value is the original string, but which contains markup to show which parts of the input match the regular expression. |
| fn.avg | Returns the average of the values in the input sequence $arg, that is, the sum of the values divided by the number of values. |
| fn.baseUri | Returns the value of the base-uri property for the specified node. |
| fn.boolean | Computes the effective boolean value of the sequence $arg. |
| fn.ceiling | Returns the smallest (closest to negative infinity) number with no fractional part that is not less than the value of $arg. |
| fn.codepointEqual | Returns true if the specified parameters are the same Unicode code point, otherwise returns false. |
| fn.codepointsToString | Creates an xs:string from a sequence of Unicode code points. |
| fn.collection | Returns all of the documents that belong to the specified collection(s). |
| fn.compare | Returns -1, 0, or 1, depending on whether the value of the $comparand1 is respectively less than, equal to, or greater than the value of $comparand2, according to the rules of the collation that is used. |
| fn.concat | Returns the xs:string that is the concatenation of the values of the specified parameters. |
| fn.contains | Returns true if the first parameter contains the string from the second parameter, otherwise returns false. |
| fn.count | Returns the number of items in the value of $arg. |
| fn.currentDate | Returns xs:date(fn:current-dateTime()). |
| fn.currentDateTime | Returns the current dateTime value (with timezone) from the dynamic context. |
| fn.currentTime | Returns xs:time(fn:current-dateTime()). |
| fn.data | Takes a sequence of items and returns a sequence of atomic values. |
| fn.dateTime | Returns an xs:dateTime value created by combining an xs:date and an xs:time. |
| fn.dayFromDate | Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg. |
| fn.dayFromDateTime | Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg. |
| fn.daysFromDuration | Returns an xs:integer representing the days component in the canonical lexical representation of the value of $arg. |
| fn.deepEqual | This function assesses whether two sequences are deep-equal to each other. |
| fn.defaultCollation | Returns the value of the default collation property from the static context. |
| fn.distinctValues | Returns the sequence that results from removing from $arg all but one of a set of values that are eq to one other. |
| fn.doc | Returns the document(s) stored in the database at the specified URI(s). |
| fn.docAvailable | If fn:doc($uri) returns a document node, this function returns true. |
| fn.document | Returns the document(s) stored in the database at the specified URI(s). |
| fn.documentUri | Returns the value of the document-uri property for the specified node. |
| fn.empty | If the value of $arg is the empty sequence, the function returns true; otherwise, the function returns false. |
| fn.encodeForUri | Invertible function that escapes characters required to be escaped inside path segments of URIs. |
| fn.endsWith | Returns true if the first parameter ends with the string from the second parameter, otherwise returns false. |
| fn.error | [1.0 and 1.0-ml only, 0.9-ml has a different signature] Throw the given error. |
| fn.escapeHtmlUri | %-escapes everything except printable ASCII characters. |
| fn.exactlyOne | Returns $arg if it contains exactly one item. |
| fn.exists | If the value of $arg is not the empty sequence, the function returns true; otherwise, the function returns false. |
| fn.false | Returns the xs:boolean value false. |
| fn.floor | Returns the largest (closest to positive infinity) number with no fractional part that is not greater than the value of $arg. |
| fn.formatDate | Returns a formatted date value based on the picture argument. |
| fn.formatDateTime | Returns a formatted dateTime value based on the picture argument. |
| fn.formatNumber | Returns a formatted string representation of value argument based on the supplied picture. |
| fn.formatTime | Returns a formatted time value based on the picture argument. |
| fn.functionAvailable | Returns true if and only if there is an XQuery or XSLT function whose name and optionally arity matches the value of the $function-name and the optional $arity arguments. |
| fn.generateId | Returns a string that uniquely identifies a given node. |
| fn.head | Returns the first item in a sequence. |
| fn.hoursFromDateTime | Returns an xs:integer between 0 and 23, both inclusive, representing the hours component in the localized value of $arg. |
| fn.hoursFromDuration | Returns an xs:integer representing the hours component in the canonical lexical representation of the value of $arg. |
| fn.hoursFromTime | Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg. |
| fn.id | Returns the sequence of element nodes that have an ID value matching the value of one or more of the IDREF values supplied in $arg. |
| fn.idref | Returns the sequence of element or attribute nodes that have an IDREF value matching the value of one or more of the ID values supplied in $arg. |
| fn.implicitTimezone | Returns the value of the implicit timezone property from the dynamic context. |
| fn.indexOf | Returns a sequence of positive integers giving the positions within the sequence $seqParam of items that are equal to $srchParam. |
| fn.inScopePrefixes | Returns the prefixes of the in-scope namespaces for $element. |
| fn.insertBefore | Returns a new sequence constructed from the value of $target with the value of $inserts inserted at the position specified by the value of $position. |
| fn.iriToUri | Idempotent function that escapes non-URI characters. |
| fn.lang | This function tests whether the language of $node, or the context node if the second argument is omitted, as specified by xml:lang attributes is the same as, or is a sublanguage of, the language specified by $testlang. |
| fn.localName | Returns the local part of the name of $arg as an xs:string that will either be the zero-length string or will have the lexical form of an xs:NCName. |
| fn.localNameFromQName | Returns an xs:NCName representing the local part of $arg. |
| fn.lowerCase | Returns the specified string converting all of the characters to lower-case characters. |
| fn.matches | Returns true if the specified $input matches the specified $pattern, otherwise returns false. |
| fn.max | Selects an item from the input sequence $arg whose value is greater than or equal to the value of every other item in the input sequence. |
| fn.min | Selects an item from the input sequence $arg whose value is less than or equal to the value of every other item in the input sequence. |
| fn.minutesFromDateTime | Returns an xs:integer value between 0 and 59, both inclusive, representing the minute component in the localized value of $arg. |
| fn.minutesFromDuration | Returns an xs:integer representing the minutes component in the canonical lexical representation of the value of $arg. |
| fn.minutesFromTime | Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg. |
| fn.monthFromDate | Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg. |
| fn.monthFromDateTime | Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg. |
| fn.monthsFromDuration | Returns an xs:integer representing the months component in the canonical lexical representation of the value of $arg. |
| fn.name | Returns the name of a node, as an xs:string that is either the zero-length string, or has the lexical form of an xs:QName. |
| fn.namespaceUri | Returns the namespace URI of the xs:QName of the node specified by $arg. |
| fn.namespaceUriForPrefix | Returns the namespace URI of one of the in-scope namespaces for $element, identified by its namespace prefix. |
| fn.namespaceUriFromQName | Returns the namespace URI for $arg as an xs:string. |
| fn.nilled | Summary: Returns an xs:boolean indicating whether the argument node is "nilled". |
| fn.nodeName | Returns an expanded-QName for node kinds that can have names. |
| fn.normalizeSpace | Returns the specified string with normalized whitespace, which strips off any leading or trailing whitespace and replaces any other sequences of more than one whitespace characters with a single space character (#x20). |
| fn.normalizeUnicode | Return the argument normalized according to the normalization criteria for a normalization form identified by the value of $normalizationForm. |
| fn.not | Returns true if the effective boolean value is false, and false if the effective boolean value is true. |
| fn.number | Returns the value indicated by $arg or, if $arg is not specified, the context item after atomization, converted to an xs:double. |
| fn.oneOrMore | Returns $arg if it contains one or more items. |
| fn.prefixFromQName | Returns an xs:NCName representing the prefix of $arg. |
| fn.QName | Returns an xs:QName with the namespace URI given in $paramURI. |
| fn.remove | Returns a new sequence constructed from the value of $target with the item at the position specified by the value of $position removed. |
| fn.replace | Returns a string constructed by replacing the specified $pattern on the $input string with the specified $replacement string. |
| fn.resolveQName | Returns an xs:QName value (that is, an expanded QName) by taking an xs:string that has the lexical form of an xs:QName (a string in the form "prefix:local-name" or "local-name") and resolving it using the in-scope namespaces for a given element. |
| fn.resolveUri | Resolves a relative URI against an absolute URI. |
| fn.reverse | Reverses the order of items in a sequence. |
| fn.root | Returns the root of the tree to which $arg belongs. |
| fn.round | Returns the number with no fractional part that is closest to the argument. |
| fn.roundHalfToEven | The value returned is the nearest (that is, numerically closest) numeric to $arg that is a multiple of ten to the power of minus $precision. |
| fn.secondsFromDateTime | Returns an xs:decimal value between 0 and 60.999..., both inclusive representing the seconds and fractional seconds in the localized value of $arg. |
| fn.secondsFromDuration | Returns an xs:decimal representing the seconds component in the canonical lexical representation of the value of $arg. |
| fn.secondsFromTime | Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg. |
| fn.startsWith | Returns true if the first parameter starts with the string from the second parameter, otherwise returns false. |
| fn.staticBaseUri | Returns the value of the base-uri property from the static context. |
| fn.string | Returns the value of $arg represented as an xs:string. |
| fn.stringJoin | Returns an xs:string created by concatenating the members of the $parameter1 sequence using $parameter2 as a separator. |
| fn.stringLength | Returns an integer representing the length of the specified string. |
| fn.stringToCodepoints | Returns the sequence of Unicode code points that constitute an xs:string. |
| fn.subsequence | Returns the contiguous sequence of items in the value of $sourceSeq beginning at the position indicated by the value of $startingLoc and continuing for the number of items indicated by the value of $length. |
| fn.substring | Returns a substring starting from the $startingLoc and continuing for $length characters. |
| fn.substringAfter | Returns the substring created by taking all of the input characters that occur after the specified $after characters. |
| fn.substringBefore | Returns the substring created by taking all of the input characters that occur before the specified $before characters. |
| fn.sum | Returns a value obtained by adding together the values in $arg. |
| fn.tail | Returns all but the first item in a sequence. |
| fn.timezoneFromDate | Returns the timezone component of $arg if any. |
| fn.timezoneFromDateTime | Returns the timezone component of $arg if any. |
| fn.timezoneFromTime | Returns the timezone component of $arg if any. |
| fn.tokenize | Returns a sequence of strings constructed by breaking the specified input into substrings separated by the specified $pattern. |
| fn.trace | Return the input $value unchanged and, if $label is the name of an enabled server event, log event to the App Server log file <install_dir>/Logs/<port>_ErrorLog.txt; where <install_dir> is the MarkLogic install directory, and <port> is the port number of the current App Server or "TaskServer" if the current request is running on the Task Server. |
| fn.translate | Returns a string where every character in $src that occurs in some position in the $mapString is translated into the $transString character in the corresponding location of the $mapString character. |
| fn.true | Returns the xs:boolean value true. |
| fn.typeAvailable | Returns true if and only if there is a type whose name matches the value of the $type-name argument is present in the static context. |
| fn.unordered | Returns the items of $sourceSeq in an implementation dependent order. |
| fn.unparsedText | Reads a file stored in the database as either text or binary file and returns its contents as a string. |
| fn.unparsedTextAvailable | Returns true if a call to unparsed-text would succeed with identical arguments. |
| fn.upperCase | Returns the specified string converting all of the characters to upper-case characters. |
| fn.yearFromDate | Returns an xs:integer representing the year component in the localized value of $arg. |
| fn.yearFromDateTime | Returns an xs:integer representing the year component in the localized value of $arg. |
| fn.yearsFromDuration | Returns an xs:integer representing the years component in the canonical lexical representation of the value of $arg. |
| fn.zeroOrOne | Returns $arg if it contains zero or one items. |
| geo.approxCenter | Return a point approximating the center of the given region. |
| geo.arcIntersection | Returns the point at the intersection of two arcs. |
| geo.bearing | Returns the true bearing in radians of the path from the first point to the second. |
| geo.boundingBoxes | Returns a sequence of boxes that bound the given region. |
| geo.box | Create a cts.box value from a node representing a box in one of the supported markup vocabularies, such as KML, GML, or GeoJSON. |
| geo.boxIntersects | Returns true if the box intersects with a region. |
| geo.circle | Create a cts.box value from a radius and a node representing a point in one of the supported markup vocabularies, such as KML, GML, or GeoJSON. |
| geo.circleIntersects | Returns true if the circle intersects with a region. |
| geo.circlePolygon | Construct a polygon approximating a circle. |
| geo.complexPolygon | Create a cts.complexPolygon value from a node representing a complex polygon in one of the supported markup vocabularies, such as KML, GML, or GeoJSON. |
| geo.complexPolygonContains | Returns true if the complex-polygon contains a region. |
| geo.complexPolygonIntersects | Returns true if the complex-polygon intersects with a region. |
| geo.coordinateSystemCanonical | Get the canonical name for the coordinate system. |
| geo.countDistinctVertices | Return a count of the distinct number of vertices in a region, taking tolerance into account. |
| geo.countVertices | This function returns a count of the number of vertices in a region. |
| geo.defaultCoordinateSystem | Get the canonical name for the coordinate system currently in effect. |
| geo.destination | Returns the point at the given distance (in units) along the given bearing (in radians) from the starting point. |
| geo.distance | Returns the distance (in units) between two points. |
| geo.distanceConvert | This function converts a distance from one unit of measure to another. |
| geo.ellipsePolygon | Construct a polygon approximating an ellipse. |
| geo.geohashDecode | Given a geohash string, return the bounding box for that hash. |
| geo.geohashDecodePoint | Given a geohash string, return the point for that hash. |
| geo.geohashEncode | Compute a set of covering geohashes for the given region, to the given level of precision. |
| geo.geohashNeighbors | Given a geohash string, return hashes for the neighbors. |
| geo.geohashPrecisionDimensions | Given a geohash string, return the height and width for the given precision. |
| geo.geohashSubhashes | Given a geohash string, return the 32 subhashes. |
| geo.geospatialQuery | Returns a query matching points within given regions. |
| geo.geospatialQueryFromElements | Returns a query matching points within given regions. |
| geo.geospatialQueryFromNodes | Returns a query matching points within given regions. |
| geo.interiorPoint | This function returns a point that is guaranteed to be inside the bounds of the given region. |
| geo.interiorPolygon | Create a sequence of cts.polygon values from a polygon node in one of the supported markup vocabularies, such as KML or GML. |
| geo.linestring | Create a cts.linestring value from a node representing a linestring in one of the supported markup vocabularies, such as GML or KML. |
| geo.linestringConcat | Construct a linestring by concatenating the vertices of the input linestrings, in order. |
| geo.linestringReverse | Construct a linestring with the vertices in reverse order. |
| geo.parse | Convert nodes in one or more of the supported geospatial representations into cts.region values. |
| geo.parseWkb | Returns a sequence of geospatial regions parsed from Well-Known Binary format. |
| geo.parseWkt | Returns a sequence of geospatial regions parsed from Well-Known Text format. |
| geo.point | Create a cts.point value from a node representing a point in one of the supported markup vocabularies, such as KML or GML. |
| geo.polygon | Create a cts.polygon value from a sequence of point nodes in one of the supported markup vocabularies, such as KML or GML. |
| geo.polygonContains | Returns true if the polygon contains a region. |
| geo.polygonIntersects | Returns true if the polygon intersects with a region. |
| geo.polygonToLinestring | Construct a linestring from the vertices of a polygon, or construct a sequence of linestrings from the outer and inner polygons of a complex polygon. |
| geo.regionAffineTransform | Perform an affine transformation on a geospatial region. |
| geo.regionApproximate | This function returns a simplified approximation of the region, using the Douglas-Peucker algorithm. |
| geo.regionClean | This function fixes various problems with the region or raises an error if it is not repairable. |
| geo.regionContains | Returns true if one region contains the other region. |
| geo.regionDe9im | Calculates the Dimensionally Extended nine-Intersection Matrix (DE-9IM) of two geospatial regions. |
| geo.regionIntersects | Returns true if the target region intersects with a region. |
| geo.regionRelate | Compares geospatial regions based on a specified relationship. |
| geo.removeDuplicateVertices | Remove duplicate (adjacent) vertices. |
| geo.shortestDistance | Returns the great circle distance (in units) between a point and a region. |
| geo.toWkb | Returns a binary node in Well-Known Binary format. |
| geo.toWkt | Returns a sequence of strings in Well-Known Text format. |
| geo.validateWkb | Returns true if the binary data can be parsed as WKB into a supported region type. |
| geo.validateWkt | Returns true if the string is valid Well-Known Text for a supported region type. |
| geogml.box | Create a cts:box value from a GML Envelope element. |
| geogml.circle | Create a cts:circle value from a radius and GML Point element. |
| geogml.complexPolygon | Create a cts:complex-polygon value from a GML Polygon element. |
| geogml.geospatialQuery | Returns a cts:query matching points within given regions. |
| geogml.geospatialQueryFromElements | Returns a cts:query matching points within given regions. |
| geogml.interiorPolygon | Create a sequence of cts:polygon values from a GML Polygon element. |
| geogml.linestring | Create a cts:linestring value from a GML LineString element. |
| geogml.parseGml | Construct regions from GML elements. |
| geogml.point | Create a cts:point value from a GML Point element. |
| geogml.polygon | Create a cts.polygon value from a sequence of GML Point elements or a GML Polygon element. |
| geogml.toGml | Construct GML elements from cts:region values. |
| geojson.box | Create a cts:box value from GeoJSON bbox property. |
| geojson.circle | Create a cts:circle value from a radius and a GeoJSON "Point" type geometry object. |
| geojson.complexPolygon | Create a cts:complex-polygon value from a GeoJSON "Polygon" type geometry object. |
| geojson.geospatialQuery | Returns a cts:query matching points within given regions. |
| geojson.geospatialQueryFromNodes | Returns a cts:query matching points within given regions. |
| geojson.interiorPolygon | Create a sequence of cts:polygon values from a GeoJSON "Polygon" type geometry object. |
| geojson.linestring | Create a cts:linestring value from a GeoJSON "LineString" type geometry object. |
| geojson.multiLinestring | Create a set of cts:linestring values from a GeoJSON "MultiLineString" type geometry object. |
| geojson.multiPoint | Create a set of cts:point values from a GeoJSON "MultiPoint" type geometry object. |
| geojson.parseGeojson | Convert GeoJSON object nodes into cts:region values. |
| geojson.point | Create a cts:point value from a GeoJSON "Point" type geometry object. |
| geojson.polygon | Create a cts:polygon value from a GeoJSON "Polygon" type geometry object or a sequence of GeoJSON "Point" type geometry objects. |
| geojson.toGeojson | Convert cts:region values into GeoJSON object nodes. |
| geokml.box | Create a cts:box value from a KML LatLongBox element. |
| geokml.circle | Create a cts:circle value from a radius and KML Point or Location element. |
| geokml.complexPolygon | Create a cts:complex-polygon value from a KML Polygon element. |
| geokml.geospatialQuery | Returns a cts:query matching points within given regions. |
| geokml.geospatialQueryFromElements | Returns a cts:query matching points within given regions. |
| geokml.interiorPolygon | Create a sequence of cts:polygon values from a KML Polygon element. |
| geokml.linestring | Create a cts:linestring value from a KML LineString element. |
| geokml.parseKml | Construct regions from KML elements. |
| geokml.point | Create a cts:point value from a KML Point or Location element. |
| geokml.polygon | Create a cts:polygon value from a KML polygon or a sequence of KML Point or Location elements. |
| geokml.toKml | Construct KML elements from cts:region values. |
| georss.circle | Create a cts:circle value from a radius and GeoRSS point element. |
| georss.complexPolygon | Create a cts:complex-polygon value from a GeoRSS "Polygon" element. |
| georss.geospatialQuery | Returns a cts:query matching points within given regions. |
| georss.linestring | Create a cts:linestring value from a GeoRSS line element. |
| georss.parseGeorss | Construct zero or more cts:region values from GeoRSS XML elements. |
| georss.point | Create a cts:point value from a GeoRSS point element. |
| georss.polygon | Create a cts:polygon value from a sequence of GeoRSS point elements or a GeoRSS polygon element. |
| georss.toGeorss | Convert cts:region values to GeoRSS XML elements. |
| Global-Object.declareUpdate | Declares the statement to be an update. |
| Global-Object.require | Imports a module at the specified location, and returns a JavaScript object. |
| IteratePlan.prototype.explain | This method returns a representation of the builtin execution plan. |
| IteratePlan.prototype.export | This method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload. |
| IteratePlan.prototype.generateView | This method generates a view that encapsulates a query. |
| IteratePlan.prototype.result | This method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan. |
| jsearch.bucketName | Names a bucket below the smallest bound, between two bounds, or above the largest bound as input for the ValuesSearch.groupInto or FacetDefinition.groupInto method. |
| jsearch.byExample | Constructs a cts.query working by example. |
| jsearch.collections | Creates a jsearch object for searching within the scope of the union of one or more collections. |
| jsearch.databaseLexicon | Identifies the lexicon for all words in the database as input for the jsearch.words method. |
| jsearch.documents | Creates a DocumentsSearch object to define and execute a search for documents. |
| jsearch.documentSelect | Applies document selection logic to the documents returned by cts.search, fn.collection, fn.doc, or another document iterator or to an array of documents or one document. |
| jsearch.elementAttributeLexicon | Identifies the word lexicon for an attribute of an element as input for the jsearch.words method. |
| jsearch.elementLexicon | Identifies the word lexicon for an element as input for the jsearch.words method. |
| jsearch.facet | Creates a FacetDefinition object to define the value enumeration as part of a facet search. |
| jsearch.facets | Creates a FacetsSearch object to define and execute a report listing value facets and, optionally, a page of documents. |
| jsearch.fieldLexicon | Identifies the word lexicon for a field as input for the jsearch.words method. |
| jsearch.jsonPropertyLexicon | Identifies the word lexicon for a JSON property as input for the jsearch.words method. |
| jsearch.makeBuckets | Returns a list of bounds for grouping by subdividing an interval either with a fixed step size or a fixed number of division buckets within the min and max boundary values as input for the ValuesSearch.groupInto or FacetDefinition.groupInto method. |
| jsearch.makeHeatmap | Returns a list of bounds for grouping geospatial points as a heatmap by subdividing a geospatial box with latitude and longitude divisions as input for the ValuesSearch.groupInto or FacetDefinition.groupInto method. |
| jsearch.tuples | Creates a TuplesSearch object to define and execute a search for a list of rows where the values in each row co-occur in indexes for a document. |
| jsearch.udf | Identifies a UDF (User Defined Function) to the ValuesSearch.aggregate function for aggregating values from a single index or to the TuplesSearch.aggregate function for aggregating co-occurring values from multiple indexes. |
| jsearch.values | Creates a ValuesSearch object to define and execute a search for a list of indexed values. |
| jsearch.words | Creates a WordsSearch object to define and execute a search for a list of indexed words. |
| json.checkConfig | This function checks a json configuration object and returns a report. |
| json.config | This function creates a configuration object for a specified strategy. |
| json.transformFromJson | This function transforms a JSON document to XML using the default ("basic") strategy. |
| json.transformToJson | This function transforms an XML document to JSON using the default ("basic") strategy if none is supplied. |
| json.transformToJsonObject | This function transforms an XML document to JSON and returns an object. |
| json.transformToJsonXml | This function transforms an XML document to JSON and returns an xml element. |
| math.acos | Returns the arc cosine of x, in radians, in the range from 0 to pi (inclusive). |
| math.asin | Returns the arc sine of x, in radians, in the range from -pi/2 to +pi/2 (inclusive). |
| math.atan | Returns the arc tangent of x, in radians. |
| math.atan2 | Returns the arc tangent of y/x, in radians, in the range from -pi/2 to +pi/2 (inclusive), using the signs of y and x to determine the appropriate quadrant. |
| math.ceil | Returns the smallest integer greater than or equal to x. |
| math.correlation | Returns the Pearson correlation coefficient of a data set. |
| math.cos | Returns the cosine of x, in the range from -1 to +1 (inclusive). |
| math.cosh | Returns the hyperbolic cosine of x. |
| math.cot | Returns the cotangent of x. |
| math.covariance | Returns the sample covariance of a data set. |
| math.covarianceP | Returns the population covariance of a data set. |
| math.degrees | Returns numeric expression converted from radians to degrees. |
| math.exp | Returns e (approximately 2.71828182845905) to the xth power. |
| math.fabs | Returns the absolute value of x. |
| math.floor | Returns the largest integer less than or equal to x. |
| math.fmod | Returns the remainder of x/y. |
| math.frexp | Returns x broken up into mantissa and exponent, where x = mantissa*2^exponent. |
| math.ldexp | Returns x*2^i. |
| math.linearModel | Returns a linear model that fits the given data set. |
| math.linearModelCoeff | Returns the coefficients of the linear model. |
| math.linearModelIntercept | Returns the intercept of the linear model. |
| math.linearModelRsquared | Returns the R^2 value of the linear model. |
| math.log | Returns the base-e logarithm of x. |
| math.log10 | Returns the base-10 logarithm of x. |
| math.median | Returns the median of a sequence of values. |
| math.mode | Returns the mode of a sequence. |
| math.modf | Returns x broken up into fraction and integer. |
| math.percentile | Returns a sequence of percentile(s) given a sequence of percentage(s). |
| math.percentRank | Returns the rank of a value in a data set as a percentage of the data set. |
| math.pi | Returns the value of pi. |
| math.pow | Returns x^y. |
| math.radians | Returns numeric expression converted from degrees to radians. |
| math.rank | Returns the rank of a value in a data set. |
| math.sin | Returns the sine of x, in the range from -1 to +1 (inclusive). |
| math.sinh | Returns the hyperbolic sine of x. |
| math.sqrt | Returns the square root of x. |
| math.stddev | Returns the sample standard deviation of a sequence of values. |
| math.stddevP | Returns the standard deviation of a population. |
| math.tan | Returns the tangent of x. |
| math.tanh | Returns the hyperbolic tangent of x, in the range from -1 to +1 (inclusive). |
| math.trunc | Returns the number truncated to a certain number of decimal places. |
| math.variance | Returns the sample variance of a sequence of values. |
| math.varianceP | Returns the population variance of a sequence of values. |
| ModifyPlan.prototype.bind | This function adds new columns or modifies existing columns based on expressions while preserving existing unmodified columns in the row set. |
| ModifyPlan.prototype.bindAs | This function is deprecated in favor of the bind() function and will not be supported in MarkLogic 11. |
| ModifyPlan.prototype.except | This method restricts the left row set to rows where a row with the same columns and values doesn't exist in the right row set. |
| ModifyPlan.prototype.existsJoin | This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. |
| ModifyPlan.prototype.explain | This method returns a representation of the builtin execution plan. |
| ModifyPlan.prototype.export | This method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload. |
| ModifyPlan.prototype.facetBy | This method counts values for multiple grouping key columns. |
| ModifyPlan.prototype.generateView | This method generates a view that encapsulates a query. |
| ModifyPlan.prototype.groupBy | This method collapses a group of rows into a single row. |
| ModifyPlan.prototype.groupByUnion | This method performs the union of multiple group-by operations on a row set. |
| ModifyPlan.prototype.groupToArrays | This method performs multiple group-by operations on a row set and produces a single row with a column for each group having an array value whose items are the rows for the group. |
| ModifyPlan.prototype.intersect | This method restricts the left row set to rows where a row with the same columns and values exists in the right row set. |
| ModifyPlan.prototype.joinCrossProduct | This method yields one output row set that concatenates every left row with every right row. |
| ModifyPlan.prototype.joinDoc | This function specifies a document column to add to the rows by reading the documents for an existing source column having a value of a document uri (which can be used to read other documents) or a fragment id (which can be used to read the source documents for rows). |
| ModifyPlan.prototype.joinDocUri | This method adds a uri column to rows based on an existing fragment id column to identify the source document for each row. |
| ModifyPlan.prototype.joinFullOuter | This method yields one output row set with the rows from an inner join as well as the other rows from both the left and right row sets. |
| ModifyPlan.prototype.joinInner | This method returns all rows from multiple tables where the join condition is met. |
| ModifyPlan.prototype.joinLeftOuter | This method yields one output row set with the rows from an inner join as well as the other rows from the left row set. |
| ModifyPlan.prototype.limit | This method specifies the maximum number of rows to be returned by this Plan. |
| ModifyPlan.prototype.map | This method applies the specified function to each row returned by the plan to produce a different result row. |
| ModifyPlan.prototype.notExistsJoin | This method is a filtering join that filters based on whether the join exists or not but doesn't add any columns. |
| ModifyPlan.prototype.offset | This method returns a subset of the rows in the result set. |
| ModifyPlan.prototype.offsetLimit | This method returns a subset of the rows in the result set by skipping the number of rows specified by start and returning the remaining rows up to the length limit. |
| ModifyPlan.prototype.orderBy | This method sorts the row set by the specified order definition. |
| ModifyPlan.prototype.prepare | This method prepares the specified plan for execution as an optional final step before execution. |
| ModifyPlan.prototype.reduce | This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array. |
| ModifyPlan.prototype.result | This method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan. |
| ModifyPlan.prototype.select | This call projects the specified columns from the current row set and / or applies a qualifier to the columns in the row set. |
| ModifyPlan.prototype.union | This method yields all of the rows from the input row sets. |
| ModifyPlan.prototype.where | This method restricts the row set to rows matched by the boolean expression. |
| ModifyPlan.prototype.whereDistinct | This method removes duplicate rows from the row set. |
| NamedNodeMap.getNamedItem | Return the named node, if it exists in the map. |
| NamedNodeMap.getNamedItemNS | Return the node with the given localname and namespace URI, if it exists in the map. |
| Node.baseURI | Returns a string representing the base URI of the node. |
| Node.nodeKind | Return a string indicating the type of the node. |
| Node.nodeType | Return the DOM code indicating the type of the node. |
| Node.toObject | This is inherited from the Value object. Return a JavaScript object value. |
| Node.toString | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| Node.valueOf | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| Node.xpath | Evaluate an XPath using the node as context. |
| NodeBuilder.addAttribute | Add an attribute node to the node tree the builder is building. |
| NodeBuilder.addBinary | Add a binary node to the node tree the builder is building. |
| NodeBuilder.addBoolean | Add a boolean node to the node tree the builder is building. |
| NodeBuilder.addComment | Add an XML comment node to the node tree the builder is building. |
| NodeBuilder.addDocument | Add a document node to the node tree the builder is building. |
| NodeBuilder.addElement | Add an XML element node to the node tree the builder is building. |
| NodeBuilder.addNode | Add a node to the node tree the builder is building. |
| NodeBuilder.addNull | Add a null node to the node tree the builder is building. |
| NodeBuilder.addNumber | Add a number node to the node tree the builder is building. |
| NodeBuilder.addProcessingInstruction | Add an XML processing instruction node to the node tree the builder is building. |
| NodeBuilder.addText | Add a text node to the node tree the builder is building. |
| NodeBuilder.endDocument | Close out the current document node. |
| NodeBuilder.endElement | Close out the current XML element node. |
| NodeBuilder.startDocument | Start a new document node in the node tree the builder is building. |
| NodeBuilder.startElement | Start a new XML element node in the node tree the builder is building. |
| NodeBuilder.toNode | Return the node tree that has been built. |
| NodeList.item | Return the nth node. |
| NodeList.length | Return the number of nodes in the node list. |
| NullNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| NullNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| NullNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| NullNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| NumberNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| NumberNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| NumberNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| NumberNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| ObjectNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| ObjectNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| ObjectNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| ObjectNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| op.add | This function returns the sum of the specified numeric expressions. |
| op.and | This function returns true if the specified boolean expressions all return true. |
| op.arrayAggregate | This function constructs an array whose items are the result of evaluating the column for each row in the group or row set. |
| op.as | This function defines a column by assigning the value of an expression over the rows in the row set. |
| op.asc | This function sorts the rows by the values of the specified column in ascending order. |
| op.avg | This function averages the non-null values of the column for the rows in the group or row set. |
| op.bucketGroup | This function can be used as a named group in functions prototype.groupToArrays or prototype.facetBy . |
| op.call | This function to calls a built-in function on every row. |
| op.case | This function returns the specified valueExpression if the specified valueExpression is true. |
| op.col | Identifies a column where the column name is unique and a qualifier on the column name isn't necessary (and might not exist). |
| op.count | This function counts the rows where the specified input column has a value. |
| op.cube | This function specifies a list of grouping keys for a group and returns that group and every possible larger group (including all rows) formed from any subset of keys. |
| op.desc | This function sorts the rows by the values of the specified column in descending order. |
| op.divide | This function divides the left numericExpression by the right numericExpression and returns the value. |
| op.eq | This function takes two or more expressions and returns true if all of the expressions return the same value. |
| op.fragmentIdCol | Specifies a name for adding a fragment id column to the row set identifying the source documents for the rows from a view, lexicons or triples. |
| op.fromLexicons | This function dynamically constructs a view from range indexes or the uri or collection lexicons. |
| op.fromLiterals | Constructs a literal row set as in the SQL VALUES or SPARQL VALUES statements. |
| op.fromSearch | This function dynamically constructs a row set based on a cts.query where the columns for the document fragment id and score reflecting the degree of match of the document with the query criteria. |
| op.fromSearchDocs | This function matches and returns the uri, content, and score for documents. |
| op.fromSPARQL | This function dynamically constructs a row set based on a SPARQL SELECT query from triples. |
| op.fromSQL | This function dynamically constructs a row set based on a SQL SELECT query from views. |
| op.fromTriples | Reads rows by matching patterns in the triple index. |
| op.fromView | This function reads a row set from a configured view over TDE-indexed rows or a predefined view over range indexes. |
| op.ge | This function returns true if the value of the left expression is greater than or equal to the value of the right expression. |
| op.graphCol | Identifies the graph for a triple providing one or more columns for a row. |
| op.group | This function specifies the grouping keys for a group as a list of zero or more columns. |
| op.groupConcat | This function concatenates the non-null values of the column for the rows in the group or row set. |
| op.gt | This function returns true if the value of the left expression is greater than the value of the right expression. |
| op.hasGroupKey | This aggregate function adds a flag to a grouped row specifying whether a column acted as a grouping key for the row. |
| op.import | This function instantiates a plan from the JSON representation of a plan that was exported by the prototype.export function. |
| op.in | This function returns true if a test expression evaluates to the same value as any of a list of candidate expressions. |
| op.isDefined | This function tests whether the value of an expression is null in the row where the expression might be as simple as a column identified by op.col . |
| op.jsonArray | This function constructs a JSON array during row processing. |
| op.jsonBoolean | This function constructs a JSON boolean node with the specified value. |
| op.jsonDocument | This function constructs a JSON document with the root content, which must be exactly one JSON object or array node. |
| op.jsonNull | This function constructs a JSON null node. |
| op.jsonNumber | This function constructs a JSON number node with the specified value. |
| op.jsonObject | This function constructs a JSON object with the specified properties. |
| op.jsonString | This function constructs a JSON text node with the specified value. |
| op.le | This function returns true if the value of the left expression is less than or equal to the value of the right expression. |
| op.lt | This function returns true if the value of the left expression is less than the value of the right expression. |
| op.max | This function gets the largest non-null value of the column for the rows in the group or row set. |
| op.min | This function gets the smallest non-null value of the column for the rows in the group or row set. |
| op.modulo | This function returns the remainder afer the division of the dividend and divisor expressions. |
| op.multiply | This function multiplies the left numericExpression by the right numericExpression and returns the value. |
| op.namedGroup | This function specifies the grouping keys for a group as a named list of zero or more columns. |
| op.ne | This function returns true if the value of the left expression is not equal to the value of the right expression. |
| op.not | This function returns true if neither of the specified boolean expressions return true. |
| op.on | Specifies an equijoin using one columndef each from the left and right rows. |
| op.or | This function returns true if either of the specified boolean expressions return true. |
| op.param | This function creates a placeholder for a literal value in an expression or as the offset or max for a limit. |
| op.pattern | This function builds the parameters for the op.fromTriples function. |
| op.prefixer | This function factory returns a new function that takes a name parameter and prepends the specified base URI onto the name. |
| op.prop | This function specifies the key expression and value content for a JSON property of a JSON object constructed by the op.jsonObject function. |
| op.rollup | This function specifies a list of grouping keys for a group and returns that group and larger groups (including all rows) formed by dropping columns from right to left. |
| op.sample | This function randomly selects one non-null value of the column from the rows in the group or row set. |
| op.schemaCol | Unambiguously identifies a column with the schema name, view name, and column name. |
| op.sequenceAggregate | This call constructs a sequence whose items are the values of a column for each row in the group or row set. |
| op.sqlCondition | This function returns a filter definition as input for a WHERE operation. |
| op.subtract | This function subtracts the right numericExpression from the left numericExpression and returns the value. |
| op.sum | This function adds the non-null values of the column for the rows in the group or row set. |
| op.toSource | This function generates a server-side JavaScript source code representation of a plan from the JSON or JavaScript literal object representation of a plan that was exported by the prototype.export function. |
| op.uda | This function processes the values of column for each row in the group or row set with the specified user-defined aggregate as implemented by an aggregate user-defined function (UDF) plugin. |
| op.viewCol | Identifies a column where the combination of view and column name is unique. |
| op.when | This function executes the specified expression if the specified condition is true for the row. |
| op.xmlAttribute | This function constructs an XML attribute with the name (which can be a string or QName) and atomic value. |
| op.xmlComment | This function constructs an XML comment with the atomic value. |
| op.xmlDocument | This function constructs an XML document with the root content, which must be exactly one node. |
| op.xmlElement | This function constructs an XML element with the name (which can be a string or QName), zero or more attributes, and child content. |
| op.xmlPI | This function constructs an XML processing instruction with the atomic value. |
| op.xmlText | This function constructs an XML text node with the specified value. |
| op.xpath | This function extracts a sequence of child nodes from a column with node values -- especially, the document nodes from a document join. |
| opdsl.import | This function takes the Query DSL representation of an Optic query as a string or text and returns the built query, which can then be executed with the prototype.result method. |
| ordt.maskDeterministic | This function redacts a column with string values by replacing each value with deterministic masking text. |
| ordt.maskRandom | This function redacts a column with string values by replacing each value with random masking text. |
| ordt.redactDatetime | This function redacts a column with date or datetime values either by masking part of the existing value or by generating a random value. |
| ordt.redactEmail | This function redacts a column with email address string that conforms to the pattern name@domain. |
| ordt.redactIpv4 | This function redacts a column with IPv4 address string that conforms to a pattern with four blocks of 1-3 decimal digits separated by period (.) where the value of each block of digits is less than or equal to 255 as in 123.201.098.112 and 123.45.678.0. |
| ordt.redactNumber | This function redacts a column by generating a random number within a configurable range either as a numeric data type or as a formatted string. |
| ordt.redactRegex | This function redacts a string column by applying a regular expression. |
| ordt.redactUsPhone | This function redacts a column with a 10-digit US phone number string by generating random numbers or replacing numbers with a masking character. |
| ordt.redactUsSsn | This function redacts a column with a 9-digit US SSN (Social Security Number) string by generating random numbers or replacing numbers with a masking character. |
| ort.getValue | For an ort.value with value type "SEQUENCE", returns the ort.value at specified index; for value type "MAP", index 0 returns the key, and index 1 returns the value. |
| ort.map | Creates a value with type "MAP", using an ort.value as key and an ort.value as value. |
| ort.run | Perform inference of a session, based on supplied input values. |
| ort.sequence | Creates a value with type "SEQUENCE". |
| ort.session | Load an ONNX model from the database, as an inference session. |
| ort.sessionInputCount | Returns the number of inputs of a session. |
| ort.sessionInputName | Returns the name of an input of a session, specified by an index. |
| ort.sessionInputType | Returns a Map containing the type information of an input of a session, specified by an index. |
| ort.sessionOutputCount | Returns the number of outputs of a session. |
| ort.sessionOutputName | Returns the name of an output of a session, specified by an index. |
| ort.sessionOutputType | Returns a Map containing the type information of an output of a session, specified by an index. |
| ort.string | Creates a string tensor. |
| ort.stringContent | Returns the content of a string tensor. |
| ort.value | Constructs an ort.value to be supplied to an ort.session to perform inference. |
| ort.valueCount | Returns the number of ort.value in an ort.value with value type "SEQUENCE", and always return 2 for "MAP". |
| ort.valueGetArray | Returns the tensor represented by the ort.value as a flattened one-dimensional array. |
| ort.valueGetShape | Returns the shape of the ort.value as an Array. |
| ort.valueGetType | Returns the tensor element type of the ort.value as a String. |
| ort.valueIsTensor | Returns if the ort.value has value type "TENSOR". |
| PreparePlan.prototype.explain | This method returns a representation of the builtin execution plan. |
| PreparePlan.prototype.export | This method generates a serialized representation of the Optic query to JSON so that it can be persisted as a file or used as a REST payload. |
| PreparePlan.prototype.generateView | This method generates a view that encapsulates a query. |
| PreparePlan.prototype.map | This method applies the specified function to each row returned by the plan to produce a different result row. |
| PreparePlan.prototype.reduce | This method applies a function or the builtin reducer to each row returned by the plan to produce a single result as with the reduce() method of JavaScript Array. |
| PreparePlan.prototype.result | This method executes the plan (mapping or reducing, if specified) to generate the result, which is a plan, document plan, prepared plan, or map or reduce result plan. |
| ProcessingInstruction.attributes | This is inherited from the XMLNode object. The attributes of this node. |
| ProcessingInstruction.childNodes | This is inherited from the XMLNode object. The children of this node. |
| ProcessingInstruction.firstChild | This is inherited from the XMLNode object. The first child of this node, if any. |
| ProcessingInstruction.hasAttributes | This is inherited from the XMLNode object. Whether this node has attributes. |
| ProcessingInstruction.hasChildNodes | This is inherited from the XMLNode object. Whether this node has any children. |
| ProcessingInstruction.isEqualNode | This is inherited from the XMLNode object. Whether this node is equal to another node. |
| ProcessingInstruction.isSameNode | This is inherited from the XMLNode object. Whether this node is the same exact node as another node. |
| ProcessingInstruction.lastChild | This is inherited from the XMLNode object. The last child of this node, if any. |
| ProcessingInstruction.localName | This is inherited from the XMLNode object. Return the local name of this node. |
| ProcessingInstruction.namespaceURI | This is inherited from the XMLNode object. Return the namespace URI of this node. |
| ProcessingInstruction.nextSibling | This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any. |
| ProcessingInstruction.nodeName | This is inherited from the XMLNode object. The DOM name of the node. |
| ProcessingInstruction.nodeValue | This is inherited from the XMLNode object. The DOM value of the node. |
| ProcessingInstruction.ownerDocument | This is inherited from the XMLNode object. The document node containing this node, if any. |
| ProcessingInstruction.parentNode | This is inherited from the XMLNode object. The node that is this node's parent. |
| ProcessingInstruction.prefix | This is inherited from the XMLNode object. Return the namespace prefix of this node. |
| ProcessingInstruction.previousSibling | This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any. |
| ProcessingInstruction.target | The target of an XML processing instruction. |
| ProcessingInstruction.textContent | This is inherited from the XMLNode object. The DOM text value of the node. |
| prof.eval | Evaluate a string as JavaScript for profiling. |
| qbe.byExample | This function transforms a query by example into a cts.query object. |
| qbe.validate | This function validates a query by example. |
| rdf.langString | Returns an rdf.langString value with the given value and language tag. |
| rdf.langStringLanguage | Returns the language of an rdf.langString value. |
| rdt.redact | Apply redaction rules to a set of XML and/or JSON documents, returning the resulting documents. |
| rdt.ruleValidate | Validate the redaction rules in one or more redaction rule collections and return the URIs of the rule documents validated. |
| sc.annotations | Returns the schema annotations of the component, if any. |
| sc.attributeDecl | Returns the attribute declaration of item, as a schema component, if any. |
| sc.attributes | Returns the attribute declarations of the schema component, if any. |
| sc.canonicalPath | Returns the canonical schema component path of the component. |
| sc.complexType | Returns the complex type of item, as a schema component, if any. |
| sc.componentProperty | Returns the named property of the schema component. |
| sc.elementDecl | Returns the element declaration of item, as a schema component, if any. |
| sc.facets | Returns the facets of the component, if any. |
| sc.functionParameterType | Returns the declared parameter type of a specific parameter of the function item as a schema component. |
| sc.functionReturnType | Returns the return type of a function item as a schema component. |
| sc.name | Returns the name of the schema component, if any. |
| sc.particles | Returns the particles of the schema component, if any. |
| sc.schema | Returns the root schema of the item. |
| sc.schemaFromPath | Get a schema object as a value based on its namespace and schema location hint. |
| sc.simpleType | Returns the simple type of item, as a schema component, if any. |
| sc.type | Returns the type of item, as a schema component, if any. |
| sc.typeApply | Apply a type to an item to construct a typed instance of that type. |
| sc.typeNamed | Returns the type with the given name, if any, as a schema component. |
| schematron.compile | This function compiles the Schematron schema. |
| schematron.delete | This function deletes the Schematron schema from the schema database and, if found, the validator XSLT from the modules database. |
| schematron.get | This function returns the validator XSLT from the modules database. |
| schematron.put | This function compiles the Schematron schema with $schematron-uri as the URI of the Schematron document in the schema database and inserts the generated validator XSLT in the modules database with the URI, {$schematron-uri}-validator.xsl. |
| schematron.validate | This function accepts the document to be validated and the validator XSLT and returns the output of the validation in SVRL (Schematron Validation Report Language) format, which is a simple XML based language used to report the results of Schematron validation. |
| sec.addQueryRolesets | This function adds query rolesets to the Security database. |
| sec.ampAddRoles | Adds the roles ($role-names) to the list of roles granted to the amp ($namespace, $local-name, $document-uri). |
| sec.ampDocCollections | Returns a sequence of strings corresponding to the collection uri's that amps belong to. |
| sec.ampDocPermissions | Returns a sequence of permission elements that all newly created amp documents receive. |
| sec.ampExists | This function returns true if the specified amp exists in the security database. |
| sec.ampGetRoles | Returns a sequence of role names for the roles directly assigned to the amp ($namespace, $local-name, $document-uri). |
| sec.ampRemoveRoles | Removes a role ($role-name) from the set of roles included by the amp ($namespace, $local-name, $document-uri). |
| sec.ampsChangeModulesDatabase | This function changes all amps that refer to one modules database to refer to a different database. |
| sec.ampsCollection | Returns a string corresponding to the uri for the amps collection. |
| sec.ampSetRoles | Assigns the amp identified by $namespace, $local-name and $document-uri to have the roles identified by $roles-names. |
| sec.checkAdmin | Throws an error if the current user does not have the admin-ui privilege. |
| sec.collectionAddPermissions | Add the permissions $permissions to the protected collection identified by $uri. |
| sec.collectionGetPermissions | Returns a sequence of permission elements corresponding to the current permissions granted to the protected collection identified by $uri. |
| sec.collectionRemovePermissions | Removes the permissions $permissions from the protected collection identified by $uri. |
| sec.collectionsCollection | Returns a string corresponding to the uri for the protected collections collection. |
| sec.collectionSetPermissions | Sets the permissions of a protected collection identified by $uri to $permissions. |
| sec.compartmentGetRoles | This function returns a list of roles in the specified compartment. |
| sec.createAmp | Creates a new amp in the system database for the context database. |
| sec.createCredential | This function creates a new security credential with the specified values. |
| sec.createExternalSecurity | This function creates an external authentication configuration object and returns the id of the configuration. |
| sec.createPrivilege | Creates a new privilege and returns the new privilege-id. |
| sec.createRole | Creates a new role in the system database for the context database. |
| sec.createUser | Creates a new user in the system database for the context database. |
| sec.createUserWithRole | Creates a new user in the system database for the context database. |
| sec.credentialGetCertificate | This function returns the certificate for a credential, if it exists. |
| sec.credentialGetDescription | This function returns the description of the specified credential. |
| sec.credentialGetId | This function returns the ID of the specified credential. |
| sec.credentialGetPassword | This function returns the encrypted password for a credential, if it exists. |
| sec.credentialGetPermissions | This function returns the permissions for a credential. |
| sec.credentialGetPrivateKey | This function returns the private key for a credential, if it exists. |
| sec.credentialGetSigning | This function returns the signing flag for a credential. |
| sec.credentialGetTargets | This function returns the targets for a credential, if they exist. |
| sec.credentialGetUsername | This function returns the username for a credential, if it exists. |
| sec.credentialSetCertificate | This function updates the certificate for the credential. |
| sec.credentialSetDescription | This function updates the description for the specified credential. |
| sec.credentialSetName | This function updates the name of a credential. |
| sec.credentialSetPassword | This function updates the password for the specified credential. |
| sec.credentialSetPermissions | This function updates the permission for the specified credential. |
| sec.credentialSetSigning | This function updates the signing flag for the specified credential. |
| sec.credentialSetTargets | This function updates the targets for the specified credential. |
| sec.credentialSetUsername | This function updates the username for the specified credential. |
| sec.credentialsGetAws | Returns the Amazon Web Services access key, secret key, and session token (if one exists) used to access the Amazon Simple Storage Service. |
| sec.credentialsGetAzure | Returns the Azure storage account name and access key used to access Microsoft Azure Blob Storage. |
| sec.credentialsSetAws | Sets the Amazon Web Services credentials. |
| sec.credentialsSetAzure | Sets the Azure storage account name and access key. |
| sec.externalSecurityClearCache | This function clears the login cache in the named external authorization configuration object. |
| sec.externalSecurityGetAuthentication | This function returns the authentication protocol set in the named external authorization configuration object. |
| sec.externalSecurityGetAuthorization | This function returns the authorization scheme set in the named external authorization configuration object. |
| sec.externalSecurityGetCacheTimeout | This function returns the login cache timeout (in seconds) set in the named external authorization configuration object. |
| sec.externalSecurityGetDescription | This function returns the description set in the named external authorization configuration object. |
| sec.externalSecurityGetHttpOptions | This function returns the http options for the named SAML server configuration. |
| sec.externalSecurityGetLdapAttribute | This function returns the LDAP attribute for user lookup set in the named external authorization configuration object. |
| sec.externalSecurityGetLdapBase | This function returns the LDAP base for user lookup set in the named external authorization configuration object. |
| sec.externalSecurityGetLdapBindMethod | This function returns the bind method set on the named external security object. |
| sec.externalSecurityGetLdapCertificate | This function returns the LDAP client certificate set for the name external security configuration. |
| sec.externalSecurityGetLdapDefaultUser | This function returns the default LDAP user name set in the named external authorization configuration object. |
| sec.externalSecurityGetLdapMemberAttribute | This function returns the member attribute for the specified LDAP server. |
| sec.externalSecurityGetLdapMemberofAttribute | This function returns the memberof attribute for the specified LDAP server. |
| sec.externalSecurityGetLdapNestedLookup | This function returns a boolean value specifying whether ldap nested group lookups are enabled. |
| sec.externalSecurityGetLdapPrivateKey | This function returns the private key set for the name external security configuration. |
| sec.externalSecurityGetLdapRemoveDomain | This function returns the ldap-remove-domain setting for the named external security configuration. |
| sec.externalSecurityGetLdapServerUri | This function returns the LDAP server uri set in the named external authorization configuration object. |
| sec.externalSecurityGetLdapStartTls | This function returns the ldap-start-tls setting for the named external security configuration. |
| sec.externalSecurityGetSamlAssertionHost | This function returns the SAML assertion host for the named external security configuration. |
| sec.externalSecurityGetSamlAttributeNames | This function returns the SAML attribute names set for the named external security configuration. |
| sec.externalSecurityGetSamlDestination | This function returns the saml destination in the external security configuration. |
| sec.externalSecurityGetSamlEntityId | This function returns the SAML entity id set for the named external security configuration. |
| sec.externalSecurityGetSamlIdpCertificateAuthority | This function returns the saml idp certificate authority in the external security configuration. |
| sec.externalSecurityGetSamlIssuer | This function returns the saml issuer in the external security configuration. |
| sec.externalSecurityGetSamlPrivilegeAttributeName | This function returns the SAML privilege attribute name set for the named external security configuration. |
| sec.externalSecurityGetSamlSpCertificate | This function returns the saml Service Provider certificate in the external security configuration. |
| sec.externalSecuritySetAuthentication | This function sets the authentication protocol for the named external authorization configuration object. |
| sec.externalSecuritySetAuthorization | This function sets the authentication scheme for the named external authorization configuration object. |
| sec.externalSecuritySetCacheTimeout | This function sets the login cache timeout for the named external authorization configuration object. |
| sec.externalSecuritySetDescription | This function sets the description for the named external authorization configuration object. |
| sec.externalSecuritySetHttpOptions | This function sets the http options for the named SAML server configuration. |
| sec.externalSecuritySetLdapAttribute | This function sets the LDAP attribute for user lookup for the named external authorization configuration object. |
| sec.externalSecuritySetLdapBase | This function sets the LDAP base for user lookup for the named external authorization configuration object. |
| sec.externalSecuritySetLdapBindMethod | This function sets the bind method on the named external security object. |
| sec.externalSecuritySetLdapCertificate | This function sets the LDAP certificate and private key for the named external security configuration. |
| sec.externalSecuritySetLdapDefaultUser | This function sets the default user name for the named external authorization configuration object. |
| sec.externalSecuritySetLdapMemberAttribute | This function sets the member LDAP attribute for group lookup. |
| sec.externalSecuritySetLdapMemberofAttribute | This function sets the memberof LDAP attribute for group lookup. |
| sec.externalSecuritySetLdapNestedLookup | This function sets the nested-lookup boolean. |
| sec.externalSecuritySetLdapPassword | This function sets the default user password for the named external authorization configuration object. |
| sec.externalSecuritySetLdapRemoveDomain | This function updates the ldap-remove-domain setting in the external security configuration. |
| sec.externalSecuritySetLdapServerUri | This function sets the LDAP server uri for the named external authorization configuration object. |
| sec.externalSecuritySetLdapStartTls | This function updates the ldap-start-tls setting in the external security configuration. |
| sec.externalSecuritySetName | This function sets the name of the external authorization configuration object. |
| sec.externalSecuritySetSamlAssertionHost | This function sets the SAML assertion host in the SAML configuration. |
| sec.externalSecuritySetSamlAttributeNames | This function sets one or more SAML attribute named used by other security objects to identify the named SAML configuration. |
| sec.externalSecuritySetSamlDestination | This function updates the saml destination in the external security configuration. |
| sec.externalSecuritySetSamlEntityId | \ This function sets the SAML entity ID used by other security objects to identify the named SAML configuration. |
| sec.externalSecuritySetSamlIdpCertificateAuthority | This function updates the saml idp certificate authority in the external security configuration. |
| sec.externalSecuritySetSamlIssuer | This function updates the saml issuer in the external security configuration. |
| sec.externalSecuritySetSamlPrivilegeAttributeName | This function sets the SAML privilege attribute name in the SAML configuration. |
| sec.externalSecuritySetSamlSpCertificate | This function updates the saml sp certificate and private key in the external security configuration. |
| sec.getAmp | Returns an sec:amp element corresponding to an amp identified by ($namespace, $local-name, $document-uri). |
| sec.getCollection | Gets the security document corresponding to a protected collection with uri equal to $uri. |
| sec.getCompartments | This function returns a list of all of the compartments. |
| sec.getCredential | Gets a credential. |
| sec.getCredentialById | This function returns the specified PEM encoded X509 certificate. |
| sec.getCredentialIds | This function returns a list of all of the credential IDs in the security database. |
| sec.getCredentialNames | This function returns a list of all of the credential names in the security database. |
| sec.getDistinctPermissions | Returns a sequence of permission elements made up of a concatenation of $output-perms and the distinct permission elements of $input-perms. |
| sec.getPrivilege | Returns a sec:privilege element corresponding to a privilege identified by ($action,$kind). |
| sec.getRoleIds | Returns a sequence of unique sec:role-id elements that corresponds to the sequence of role names $role-names. |
| sec.getRoleNames | Returns sequence of unique sec:role-name's that corresponds to the sequence of role IDs $role-ids. |
| sec.getSamlEntity | This function returns the named SAML entity. |
| sec.getSamlEntityIds | This function returns the SAML entity ids stored in the Security database. |
| sec.getUserNames | Returns sequence of unique sec:user-names that corresponds to the sequence of user IDs $user-ids. |
| sec.ldapServer | This function configures an LDAP server for use by the sec:create-external-security function. |
| sec.pathAddPermissions | This function adds permissions for a protected path. |
| sec.pathGetPermissions | This function gets a list of permissions for the path named. |
| sec.pathRemovePermissions | This function removes permissions for a protected path. |
| sec.pathSetPermissions | This function sets the permissions for a protected path. |
| sec.privDocCollections | Returns a sequence of strings corresponding to the collection uri's that privileges belong to. |
| sec.privDocPermissions | Returns a sequence of permission elements that all newly created privilege documents receive. |
| sec.privilegeAddRoles | Adds the roles ($role-names) to the list of roles assigned to the privilege ($action,$kind). |
| sec.privilegeExists | This function returns true if the specified privilege exists. |
| sec.privilegeGetRoles | Returns a sequence of role names for the roles assigned to the privilege ($action,$kind). |
| sec.privilegeRemoveRoles | Removes roles ($role-names) from the roles assigned to the privilege ($action,$kind). |
| sec.privilegesCollection | Returns a string corresponding to the uri for the privileges collection. |
| sec.privilegeSetName | Changes the sec:privilege-name of a sec:privilege to $new-privilege-name. |
| sec.privilegeSetRoles | Assigns the privilege ($action,$kind) to have the roles identified by $role-names. |
| sec.protectCollection | Protects a collection $uri with the given permissions ($permissions). |
| sec.protectedPathDocPermissions | Returns a sequence of permission elements that all newly created protected-path documents receive. |
| sec.protectedPathsCollection | This function returns the collection of protected paths. |
| sec.protectPath | This function protects the path specified, restricting the ability to view content based on the user's permissions. |
| sec.queryRoleset | This function creates a query roleset that can be passed into a function used to add or remove rolesets. |
| sec.queryRolesets | This is a helper function to return a query-rolesets element from a list of query-roleset elements. |
| sec.queryRolesetsCollection | This function returns the collection of query rolesets. |
| sec.queryRolesetsDocPermissions | Returns a sequence of permission elements that all newly created query-rolesets documents receive. |
| sec.queryRolesetsId | This function returns the ID of a query-rolesets. |
| sec.removeAmp | Removes the amp ($namespace, $local-name, $document-uri, $database) and returns empty-sequence(). |
| sec.removeCredential | This function removes the specified credential. |
| sec.removeCredentialById | This function removes the specified credential. |
| sec.removeExternalSecurity | This function deletes the named external authentication configuration object. |
| sec.removePath | This function removes protection from the specified protected path and removes the path from the Security database. |
| sec.removePrivilege | Removes the privilege identified by ($action,$kind). |
| sec.removeQueryRolesets | This function removes query rolesets from the Security database. |
| sec.removeRole | Removes the role ($role-name). |
| sec.removeRoleFromAmps | Removes references to the role ($role-name) from all amps. |
| sec.removeRoleFromPrivileges | Removes references to the role ($role-name) from all privileges. |
| sec.removeRoleFromRoles | Removes references to the role ($role-name) from all other roles. |
| sec.removeRoleFromUsers | Removes references to the role ($role-name) from all users. |
| sec.removeUser | Removes the user with name $user-name. |
| sec.resecureCredentials | This function re-encrypts credentials, if necessary. |
| sec.roleAddRoles | Adds new roles ($new-roles) to the role specified by $role-name. |
| sec.roleDocCollections | Returns a sequence of strings corresponding to the collection uri's that roles belong to. |
| sec.roleDocPermissions | Returns a sequence of permission elements that all newly created role documents receive. |
| sec.roleExists | This function returns true if the specified role exists in the security database. |
| sec.roleGetCompartment | This function returns the compartment for the specified role. |
| sec.roleGetDefaultCollections | Returns a sequence of strings corresponding to the uri's of the role's default collections. |
| sec.roleGetDefaultPermissions | Returns a sequence of permission elements corresponding to the role's default permissions. |
| sec.roleGetDescription | Returns the description for the specified role. |
| sec.roleGetExternalNames | This function returns the external LDAP group names assigned to the named role. |
| sec.roleGetQueries | Returns the queries for the specified role. |
| sec.roleGetRoles | Returns a sequence of role names for the roles directly assigned to the given role ($role-name). |
| sec.rolePrivileges | Returns a set of privilege elements corresponding to all privileges that a role has. |
| sec.roleRemoveRoles | Removes the roles ($role-names) from the set of roles included by the role ($role-name). |
| sec.rolesCollection | Returns a string corresponding to the uri for the roles collection. |
| sec.roleSetDefaultCollections | Sets the default collections of a role with name $role-name to $collections. |
| sec.roleSetDefaultPermissions | Sets the default permissions for a role with name $role-name. |
| sec.roleSetDescription | Changes the description of the role identified by $role-name to $description. |
| sec.roleSetExternalNames | This function sets a role to be matched to one or more external LDAP distinguished names. |
| sec.roleSetName | Changes the sec:role-name of a role from $role-name to $new-role-name. |
| sec.roleSetQueries | Sets the queries of a role with name $role-name to $queries. |
| sec.roleSetQuery | Sets the $capability query of a role with $role-name to $query. |
| sec.roleSetRoles | Assigns roles (named $role-names) to be the set of included roles for the role ($role-name). |
| sec.samlEntityDelete | This function deletes the named SAML entity. |
| sec.samlEntityInsert | This function inserts a SAML entity into the Security database. |
| sec.samlServer | This function configures an SAML server for use by the sec:create-external-security function. |
| sec.securityCollection | Returns a string corresponding to the uri for the Security collection. |
| sec.securityInstalled | Returns fn:true() if security has been installed on the current database. |
| sec.securityNamespace | Returns a string corresponding to the uri of the security namespace. |
| sec.securityPathNamespace | This function creates a protected namespace. |
| sec.securityVersion | Returns the current version of the security database. |
| sec.setRealm | Changes the realm of this security database to $realm. |
| sec.uidForName | Returns the uids for the named user or () if no such user exists. |
| sec.unprotectCollection | Removes the protection of a collection $uri. |
| sec.unprotectPath | This function removes protection from the specified protected path, without removing the path itself from the Security database. |
| sec.uriCredentialTarget | This function generates a sec:credential-target element, for use with sec:create-credential. |
| sec.userAddRoles | Adds the roles ($role-names) to the list of roles granted to the user ($user-name). |
| sec.userDocCollections | Returns a sequence of strings corresponding to the collection uri's that users belong to. |
| sec.userDocPermissions | Returns a sequence of permission elements that all newly created user documents receive. |
| sec.userExists | This function returns true if the specified user exists in the security database. |
| sec.userGetDefaultCollections | Returns a sequence of strings corresponding to the uri's of the user's default collections. |
| sec.userGetDefaultPermissions | Returns a sequence of permission elements corresponding to the user's default permissions. |
| sec.userGetDescription | Returns the user's description. |
| sec.userGetExternalNames | This function returns the external LDAP group names assigned to the named user. |
| sec.userGetPasswordExtra | This function returns the extra information for the specified user. |
| sec.userGetQueries | Returns the queries for the specified user. |
| sec.userGetRoles | Returns a sequence of role names for the roles directly assigned to the user ($user-name). |
| sec.userPrivileges | Returns a set of privilege elements corresponding to all privileges that a user has. |
| sec.userRemoveRoles | Removes the roles ($role-names) from the list of roles granted to the user ($user-name). |
| sec.usersCollection | Returns a string corresponding to the uri for the users collection. |
| sec.userSetDefaultCollections | Sets the default collections of a user with name $user-name to $collections. |
| sec.userSetDefaultPermissions | Sets the default permissions for a user with name $user-name. |
| sec.userSetDescription | Changes the description of the user identified by $user-name to $description. |
| sec.userSetExternalNames | This function sets the external names for the named user. |
| sec.userSetName | Changes the name of the user from $user-name to $new-user-name. |
| sec.userSetPassword | Changes the password for the user identified by $user-name to $password. |
| sec.userSetPasswordExtra | This function sets extra information for the specified user. |
| sec.userSetQueries | Sets the queries of a user with name $user-name to $queries. |
| sec.userSetQuery | Sets the $capability query of a user with $user-name to $query. |
| sec.userSetRoles | Assigns the user with name $user-name to have the roles identified by $role-names. |
| sec.validatePermissions | This function throws the SEC_NOPERMCAP exception if a permission has no capability specified and it throws the SEC-NOPERMROLEID exception if there is no role specified in the permission. |
| sem.binding | Creates a sem:binding object, which is a sub-type of json:object (and map:map). |
| sem.bnode | This function returns an identifier for a blank node, allowing the construction of a triple that refers to a blank node. |
| sem.coalesce | Returns the value of the first argument that evaluates without error. |
| sem.curieExpand | This function expands a CURIE (Compact URI) into a sem:iri object. |
| sem.curieShorten | This function shortens an IRI into a CURIE (Compact URI) into a sem:iri object. |
| sem.databaseNodes | This function returns database nodes backing given triples. |
| sem.datatype | Returns the name of the simple type of the atomic value argument as a SPARQL style IRI. |
| sem.defaultGraphIri | Returns the iri of the default graph. |
| sem.describe | This function implements the Concise Bounded Description (CBD) specification to describe one or more nodes in the graph. |
| sem.graph | This function returns all triples from a named graph in the database. |
| sem.graphAddPermissions | Add permissions to the graph specified. |
| sem.graphDelete | This function deletes a named graph, and its graph document containing metadata, from the database. |
| sem.graphGetPermissions | Get permissions to the graph specified. |
| sem.graphInsert | This function inserts triples into a named graph, creating the graph if necessary. |
| sem.graphRemovePermissions | Remove permissions from the graph specified. |
| sem.graphSetPermissions | Set permissions to the graph specified. |
| sem.if | The IF function form evaluates the first argument, interprets it as a effective boolean value, then returns the value of expression2 if the EBV is true, otherwise it returns the value of expression3. |
| sem.inMemoryStore | Returns a sem:store constructor that queries from the sequence of sem:triple values passed in as an argument. |
| sem.invalid | Returns a sem:invalid value with the given literal value and datatype IRI. |
| sem.invalidDatatype | Returns the datatype IRI of a sem:invalid value. |
| sem.iri | This is a constructor function that takes a string and constructs an item of type sem.iri from it. |
| sem.isBlank | Returns true if the argument is an RDF blank node - that is, derived from type sem:blank. |
| sem.isIRI | Returns true if the argument is an RDF IRI - that is, derived from type sem:iri, but not derived from type sem:blank. |
| sem.isLiteral | Returns true if the argument is an RDF literal - that is, derived from type xs:anyAtomicType, but not derived from type sem:iri. |
| sem.isNumeric | Returns true if the argument is a valid numeric RDF literal. |
| sem.lang | Returns the language of the value passed in, or the empty string if the value has no language. |
| sem.langMatches | Returns true if $lang-tag matches $lang-range according to the basic filtering scheme defined in RFC4647. |
| sem.prefixes | This function returns a set of prefix mappings for use with CURIE processing. |
| sem.queryResultsSerialize | This function implements the W3C SPARQL Query Results format. |
| sem.random | Returns a random double between 0 and 1. |
| sem.rdfBuilder | This function returns a function that builds triples from CURIE and blank node syntax. |
| sem.rdfGet | This function returns sem:triples from a specified location. |
| sem.rdfInsert | This function inserts triples into a specified database as one or more sem:triples documents. |
| sem.rdfLoad | This function inserts an RDF document from a specified location into the designated database. |
| sem.rdfParse | This function returns parsed sem:triple objects from a text format or XML. |
| sem.rdfSerialize | This function returns a string or json or XML serialization of the provided triples. |
| sem.resolveIri | Resolves a relative URI against an absolute URI. |
| sem.rulesetStore | The sem:ruleset-store function returns a set of triples derived by applying the ruleset to the triples in the sem:store constructor provided in $store ("the triples that can be inferred from these rules"). |
| sem.sameTerm | Returns true if the arguments are the same RDF term as defined by the RDF concepts specification. |
| sem.sparql | Executes a SPARQL query against the database. |
| sem.sparqlPlan | Return a node representing the query plan of the given SPARQL query. |
| sem.sparqlUpdate | Executes a SPARQL Update operation against the database. |
| sem.sparqlValues | This function executes a SPARQL SELECT query using passed-in bindings participating as a starting point for the query. |
| sem.store | The sem:store function defines a set of criteria, that when evaluated, selects a set of triples to be passed in to sem:sparql(), sem:sparql-update(), or sem:sparql-values() as part of the options argument. |
| sem.timezoneString | Returns the timezone of an xs:dateTime value as a string. |
| sem.transitiveClosure | From a starting set of seeds, follow a given set of predicates, to a given depth, and return all unique node IRIs. |
| sem.triple | Creates a triple object, which represents an RDF triple containing atomic values representing the subject, predicate, object, and optionally graph identifier (graph IRI). |
| sem.tripleGraph | Returns the graph identifier (graph IRI) from a sem:triple value. |
| sem.tripleObject | Returns the object from a sem:triple value. |
| sem.triplePredicate | Returns the predicate from a sem:triple value. |
| sem.tripleSubject | Returns the subject from a sem:triple value. |
| sem.typedLiteral | Returns a value to represent the RDF typed literal with lexical value $value and datatype IRI $datatype. |
| sem.unknown | Returns a sem:unknown value with the given literal value and datatype IRI. |
| sem.unknownDatatype | Returns the datatype IRI of a sem:unknown value. |
| sem.uuid | Return a UUID URN (RFC4122) as a sem:iri value. |
| sem.uuidString | Return a string that is the scheme specific part of random UUID URN (RFC4122). |
| Sequence.from | Create a Sequence object from an array-like or iterable object. |
| Sequence.prototype.@@iterator | Return an iterator object. |
| Sequence.prototype.toArray | Return an array containing the values in the Sequence. |
| Sequence.toObject | This is inherited from the Value object. Return a JavaScript object value. |
| Sequence.toString | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| Sequence.valueOf | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| spell.addWord | Add the word $word to the dictionary at $uri. |
| spell.doubleMetaphone | Given a word returns the two metaphone keys. |
| spell.insert | Load the words in $dict into the dictionary at $uri. |
| spell.isCorrect | Returns true() if the specified word is spelled correctly, otherwise returns false(). |
| spell.levenshteinDistance | Given two strings, returns the Levenshtein distance between those strings. |
| spell.load | Add the words from the file specified in $path to the dictionary at $uri. |
| spell.makeDictionary | Creates a dictionary node from a sequence of words. |
| spell.removeWord | Remove the word $word from the dictionary at $uri. |
| spell.romanize | Returns the romanization of the string, substituting basic Latin letters for the letters in the string, according to their sound. |
| spell.suggest | Suggests a list of spellings for a word. |
| spell.suggestDetailed | Suggests a list of spellings for a word. |
| sql.bitLength | Returns the length of the string "str" in bits. |
| sql.bucket | Returns an unsignedLong specifying the index of the bucket the second parameter belongs to in buckets formed by the first parameter. |
| sql.collatedString | Returns an rdf.collatedString value with the given value and collation tag. |
| sql.collatedStringCollation | Returns the collation of an sql.collatedString value. |
| sql.columnID | Returns the column ID from a schema name, a view name and a column name. |
| sql.day | Returns an xs:integer between 1 and 31, both inclusive, representing the day component in the localized value of $arg. |
| sql.dayname | Returns an xs:string representing the dayname value in the localized value of $arg. |
| sql.difference | Returns an integer value that indicates the difference between the SOUNDEX values of two character expressions. |
| sql.glob | Returns true if the specified $input glob the specified $pattern, otherwise returns false. |
| sql.hours | Returns an xs:integer between 0 and 23, both inclusive, representing the value of the hours component in the localized value of $arg. |
| sql.ifnull | If the first expression is NULL, then the value of the second expression is returned. |
| sql.insert | Returns a string that that is the first argument with length characters removed starting at start and the second string has been inserted beginning at start. |
| sql.instr | Find the starting location of a pattern in a string. |
| sql.left | Returns a string that is the leftmost characters of the target string. |
| sql.like | Returns true if the specified $input like the specified $pattern, otherwise returns false. |
| sql.ltrim | Return a string that removes leading empty spaces in the input string. |
| sql.minutes | Returns an xs:integer value between 0 to 59, both inclusive, representing the value of the minutes component in the localized value of $arg. |
| sql.month | Returns an xs:integer between 1 and 12, both inclusive, representing the month component in the localized value of $arg. |
| sql.monthname | Returns month name, calculated from the localized value of $arg. |
| sql.nullif | Returns a NULL value if the two specified values are equal. |
| sql.octetLength | Returns the length of the string "str" in bits. |
| sql.quarter | Returns an xs:integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg. |
| sql.rand | Return a random number. |
| sql.repeat | Returns a string that concatenates the first argument as many times as specified by the second argument. |
| sql.right | Returns a string that is the rightmost characters of the target string. |
| sql.rtrim | Return a string that removes trailing empty spaces in the input string. |
| sql.seconds | Returns an xs:decimal value between 0 and 60.999..., both inclusive, representing the seconds and fractional seconds in the localized value of $arg. |
| sql.sign | Returns the sign of number x. |
| sql.soundex | Returns a four-character (SOUNDEX) code to evaluate the similarity of two strings. |
| sql.space | Returns a string that is the given number of spaces. |
| sql.strpos | Returns an integer value representing the starting position of a string within the search string. |
| sql.timestampadd | Returns a xs:string? timestamp created by adding a number to the given dateTimeType field of a given timestamp. |
| sql.timestampdiff | Returns the difference in dateTimeType field of two given timestamps. |
| sql.trim | Return a string that removes leading and trailing empty spaces in the input string. |
| sql.week | Returns an xs:integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg. |
| sql.year | Returns an xs:integer representing the year component in the localized value of $arg. |
| sql.yearday | Returns an xs:integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg. |
| tde.columnGetPermissions | This function returns the permissions granted to a protected column. |
| tde.columnRemovePermissions | This function removes all permissions from a protected column. |
| tde.columnSetPermissions | This function sets the permissions of a protected column. |
| tde.getView | This function returns a view's description using a schema and a view name. |
| tde.nodeDataExtract | Extracts row or triple data from a list of specified documents by applying extraction templates that are either stored in the schema database or provided as a second argument. |
| tde.templateBatchInsert | This function validates and inserts multiple templates, is similar to tde.templateInsert for individual template, throw errors for any invalid template or duplicate template URIs provided by sequence of argument with tde.templateInfo. |
| tde.templateInfo | This function returns a map:map (object[]) containing individual template information used for inserting templates with tde:template-batch-insert(). |
| tde.templateInsert | This function validates the template, inserts the template as a document into the tde collection of the schema database (if executed on the content database) with the default permissions, and reindexes the database. |
| tde.validate | In addition to xdmp.validate that can be used for validating against the extraction template schema. |
| temporal.advanceLsqt | This function enables Last Stable Query Time (LSQT) on the named collection and advances the LSQT for the collection to the maximum system start time. |
| temporal.axes | This function returns all the axis names defined in the schema databases. |
| temporal.axisCreate | This function constructs an axis definition based on the existing range indexes that can be added to a temporal collection in subsequent API calls. |
| temporal.axisGetEnd | This function returns the range index used to define the end of the period by the named axis. |
| temporal.axisGetStart | This function returns the range index used to define the start of the period by the named axis. |
| temporal.axisRemove | This function removes an axis definition from the schema database. |
| temporal.collectionCreate | This function constructs a named and protected temporal collection in the schema database with the specified system and optional valid axes. |
| temporal.collectionGetAxis | This function returns the name of either the system or valid axis in the named temporal collection. |
| temporal.collectionGetOptions | This function returns the options set on the temporal collection. |
| temporal.collectionRemove | This function removes the named temporal collection from the Schemas database. |
| temporal.collections | This function returns all of the temporal collection names in the schema database. |
| temporal.collectionSetOptions | This function sets the options on the temporal collection. |
| temporal.documentDelete | This function deletes the temporal document identified by the given URI. |
| temporal.documentInsert | This function inserts a document into the database and stores it as a temporal document. |
| temporal.documentLoad | This function inserts a document into the database and stores it as a temporal document. |
| temporal.documentPeriod | This function returns the period (as a dateTime pair) for the named axis in the document identified by its root node in the named collection. |
| temporal.documentProtect | Protects a temporal document from certain temporal operations, such as update, delete or wipe for a specific period of time. |
| temporal.documentWipe | Deletes all versions of a temporal document. |
| temporal.getLsqt | This function returns the Last Stable Query Time (LSQT) for the collection at current moment. |
| temporal.getLsqtAutomation | This function returns whether Last Stable Query Time (LSQT) management is automatically managed (true) or not automatically managed (false). |
| temporal.getLsqtAutomationLag | When the LSQT is advanced automatically, this function returns how far behind (in milliseconds) the Last Stable Query Time (LSQT) is from latest system time. |
| temporal.getLsqtAutomationPeriod | This function returns how often Last Stable Query Time (LSQT) is automatically advanced, in milliseconds. |
| temporal.getUseLsqt | This function specifies whether the named temporal collection has LSQT (Last Stable Query Time) enabled (true) or disabled (false). |
| temporal.nodeDelete | Deletes a node from the database. |
| temporal.nodeInsertAfter | Adds an immediately following sibling to a node in a temporal document. |
| temporal.nodeInsertBefore | Adds an immediately preceding sibling to a node in a temporal document. |
| temporal.nodeInsertChild | Adds a new last child to a node in a temporal document. |
| temporal.nodeReplace | Replaces a node in a temporal document. |
| temporal.setLsqtAutomation | This function sets whether Last Stable Query Time (LSQT) management is automatic. |
| temporal.setUseLsqt | This function enables or disables the use of LSQT (Last Stable Query Time) on the named collection. |
| temporal.statementGetSystemTime | This function gets the system start time on temporal documents that are inserted or deleted in the same statement as this function. |
| temporal.statementSetDocumentVersionUri | This function sets document URI for a temporal document to be used for the new version of temporal document to be generated in the current statement. |
| temporal.statementSetSystemTime | This function sets the system start time on temporal documents that are inserted or deleted in the same statement as this function. |
| Text.data | This is inherited from the CharacterData object. The character data. |
| Text.isElementContentWhitespace | This is inherited from the CharacterData object. Whether this text node is ignorable whitespace. |
| Text.length | This is inherited from the CharacterData object. The length of the character data (codepoints). |
| Text.substring | This is inherited from the CharacterData object. A substring of the character data, starting at a given offset and continuing for a given length. |
| Text.wholeText | This is inherited from the CharacterData object. The text of the text node concatenated with its logically adjacent text nodes. |
| thsr.addSynonym | Adds a synonym to the specified thesaurus entry. |
| thsr.expand | Returns a query that searches for all the query strings specified in $query and their synonyms as found in $entries. |
| thsr.insert | Load the entries in $thsr into the thesaurus at $uri. |
| thsr.load | Load the file specified in $path to the thesaurus at $uri. |
| thsr.lookup | Returns all entries for term $term in the thesaurus document(s) at $uri. |
| thsr.queryLookup | Returns a Sequence of all entries that are found by looking up terms in the query and/or subqueries of $query in the thesaurus document(s) at $uri. |
| thsr.removeEntry | Removes all entries that exactly match $entry from the thesaurus documents(s) at $uri. |
| thsr.removeSynonym | Removes synonym $synonym from thesaurus entry $entry. |
| thsr.removeTerm | Removes all entries with term $term from the thesaurus document(s) at $uri. |
| thsr.setEntry | Adds the entry $entry to the thesaurus at $uri. |
| tieredstorage.databaseCreateSubDatabase | This function creates a database with the name $database-name and make the created database the sub database of the database designated by $database-id. |
| tieredstorage.databaseCreateSuperDatabase | This function creates a database with the name $database-name and make the created database the super database of the database designated by $database-id. |
| tieredstorage.databaseDeleteSubDatabase | This function disassociates the sub database designated by $delete-dbid with the super-database designated by $database-id and deletes the sub database. |
| tieredstorage.databaseDeleteSuperDatabase | This function disassociates the super database designated by $delete-dbid with the sub-database designated by $database-id and deletes the super database. |
| tieredstorage.databasePartitionNumbers | This function returns the partition numbers of the forests in the database |
| tieredstorage.databasePartitions | This function returns the names of the partitions in the named database. |
| tieredstorage.forestCombine | This function combines data in multiple forests into one new forest. |
| tieredstorage.forestMigrate | This function moves data in a forest to new data directories and optionally sets new host for the forest. |
| tieredstorage.partitionDelete | This function deletes all forests in the specified partition. |
| tieredstorage.partitionDeleteQuery | This function deletes the query from the specified partition. |
| tieredstorage.partitionForests | This function returns a sequence of ids for the forests in the named partition. |
| tieredstorage.partitionGetExclusionEnabled | This function returns the safe-to-exclude setting for the database. |
| tieredstorage.partitionGetQuery | This function returns the query of a partition specified by the partition number. |
| tieredstorage.partitionMigrate | This function migrates all forests in a partition to the specified data directory and hosts. |
| tieredstorage.partitionNumberForests | This function returns the IDs of the forests with the specified partition-number in the named database. |
| tieredstorage.partitionQueries | This function returns all the queries in this schema database. |
| tieredstorage.partitionResize | This function either creates or combines forests in a partition. |
| tieredstorage.partitionSetAvailability | This function sets the availability of the partition to either online or offline. |
| tieredstorage.partitionSetExclusionEnabled | By default, when a search query is given to MarkLogic, all query partitions are searched, regardless of the query assignment policy set on the partition. |
| tieredstorage.partitionSetQuery | This function sets the query for a partition specified by the partition number. |
| tieredstorage.partitionSetUpdatesAllowed | This function sets update-allowed state for the forests in the specified partition. |
| tieredstorage.partitionTransfer | This function detaches forests in a partition from one database and attaches them to another. |
| tieredstorage.queryPartitionCreate | This function creates forests on specified hosts and forms a partition with the specified partition number. |
| tieredstorage.rangePartitionCreate | This function creates forests on the specified hosts and forms a range partition with the specified partition range. |
| trgr.anyPropertyContent | Returns the XML representation of an all-properties part to a triggering event, usable as the content parameter of a trigger event constructor such as trgr.triggerDataEvent . |
| trgr.collectionScope | Returns the XML representation of a collection scope, usable as the scope parameter of a trigger event constructor such as trgr.triggerDataEvent . |
| trgr.createTrigger | Creates a new trigger in the context database. |
| trgr.directoryScope | Returns the XML representation of a directory scope, usable as the scope parameter of a trigger event constructor such as trgr.triggerDataEvent . |
| trgr.documentContent | Returns the XML representation of a document part of a triggering event, usable as the content parameter of a trigger event constructor such as trgr.triggerDataEvent . |
| trgr.documentScope | Returns the XML representation of a document scope, usable as the scope parameter of a trigger event constructor such as trgr.triggerDataEvent . |
| trgr.getTrigger | Returns the XML representation of a trigger with the given name. |
| trgr.getTriggerById | Returns the XML representation of the trigger with the given trigger id. |
| trgr.postCommit | Returns the XML representation of a post-commit trigger timing. |
| trgr.preCommit | Returns the XML representation of a pre-commit trigger timing. |
| trgr.propertyContent | Returns the XML representation of a property part to a triggering event, usable as the content parameter of a trigger event constructor such as trgr.triggerDataEvent . |
| trgr.removeTrigger | Removes the named trigger. |
| trgr.triggerAddPermissions | Adds permissions to the set of permissions on the named trigger. |
| trgr.triggerDatabaseOnlineEvent | Returns the XML representation of a database coming online event, usable as the event parameter of trgr.createTrigger . |
| trgr.triggerDataEvent | Returns the XML representation of a triggering eventa, usable as the event parameter of trgr.createTrigger . |
| trgr.triggerDisable | Disables the named trigger. |
| trgr.triggerEnable | Enables the named trigger. |
| trgr.triggerGetPermissions | Returns the permissions for the named trigger. |
| trgr.triggerModule | Returns the XML representation of a trigger module which can be used as the module parameter of trgr.createTrigger . |
| trgr.triggerRemovePermissions | Removes a set of permissions from the set of permissions on the named trigger. |
| trgr.triggersChangeModulesDatabase | Any Trigger with a module referring to $old-db will be updated to refer to $new-db. |
| trgr.triggerSetDescription | Sets the description of the named trigger. |
| trgr.triggerSetEvent | Assigns a triggering event to the named trigger. |
| trgr.triggerSetModule | Sets or replaces the action module associated with the named trigger. |
| trgr.triggerSetName | Changes the name of a trigger. |
| trgr.triggerSetPermissions | Sets the permissions that determine which roles are permitted to modify the named trigger. |
| trgr.triggerSetRecursive | Sets the recursive setting of the identified trigger. |
| trgr.triggerSetTaskPriority | Sets the task priority setting of the identified trigger. |
| TuplesSearch.aggregate | Applies one or more aggregates to the tuples. |
| TuplesSearch.map | Specifies a function similar to Array.prototype.map() to apply to each tuple within the slice or the configuration for the built-in mapper. |
| TuplesSearch.orderBy | Specifies the sort method for the tuples. |
| TuplesSearch.reduce | Specifies a function similar to Array.prototype.reduce() to apply to each tuple within the slice. |
| TuplesSearch.result | Executes the tuples search definition and returns results. |
| TuplesSearch.slice | Specifies a subset of tuples to retrieve. |
| TuplesSearch.where | Specifies which documents have the co-occurring values. |
| TuplesSearch.withOptions | Configure advanced options for a tuples query. |
| TypeInfo.isDerivedFrom | Whether this type is derived from a named type by the selected methods. |
| TypeInfo.toObject | This is inherited from the Value object. Return a JavaScript object value. |
| TypeInfo.toString | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| TypeInfo.typeName | The local name of the type. |
| TypeInfo.typeNamespace | The namespace URI of the type. |
| TypeInfo.valueOf | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| Value.toObject | Return a JavaScript object value. |
| Value.toString | The atomic value of the object (for example, of the Node). |
| Value.valueOf | The atomic value of the object (for example, of the Node). |
| ValueIterator.clone | [DEPRECATED: Only available for type checking; use Sequence instead.] Clone the value iterator. |
| ValueIterator.count | [DEPRECATED: Only available for type checking; use Sequence instead.] Return a count of how many values are in the iterator. |
| ValueIterator.next | [DEPRECATED: Only available for type checking; use Sequence instead.] Advance the iterator to obtain the next value. |
| ValueIterator.toArray | [DEPRECATED: Only available for type checking; use Sequence instead.] Return an array containing the values in the value iterator. |
| ValueIterator.toObject | This is inherited from the Value object. Return a JavaScript object value. |
| ValueIterator.toString | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| ValueIterator.valueOf | This is inherited from the Value object. The atomic value of the object (for example, of the Node). |
| ValuesSearch.aggregate | Applies one or more aggregates to the values in the index. |
| ValuesSearch.groupInto | Groups the values into buckets between bound values, which must appear in increasing order. |
| ValuesSearch.map | Specify a function similar to Array.prototype.map() to apply to each value within the slice, or configure the built-in mapper. |
| ValuesSearch.match | Limits the values to those that match the pattern. |
| ValuesSearch.orderBy | Specifies the sort order for values. |
| ValuesSearch.reduce | Specifies a function similar to Array.prototype.reduce() to apply to each value within the slice or a configuration object for the built-in reducer. |
| ValuesSearch.result | Executes the values search definition and returns an array or object depending on whether the results are generated by default, with a mapper, or with a reducer. |
| ValuesSearch.slice | Specifies a subsequence of values to retrieve. |
| ValuesSearch.where | Specifies which documents have values in the index. |
| ValuesSearch.withOptions | Configure advanced options for a values query. |
| view.addColumn | This function adds column specifications to the current set of column specifications on the named view in the named schema. |
| view.addField | This function adds a field to the named view. |
| view.addPermissions | This function adds permissions to those already set for the named view in the named schema specification. |
| view.collection | This function return the URI of the protected collection holding all the views. |
| view.collectionViewScope | This function constructs a new collection-style view scope specification. |
| view.column | This function constructs a new column specification. |
| view.columns | This function returns the sequence of column specifications set in the named view in the named schema. |
| view.create | This function creates a new view in the specified schema specification. |
| view.elementViewScope | This function constructs a new element-style view scope specification. |
| view.field | This function constructs a new element-style field specification for the named field. |
| view.fields | This function returns the fields set on the named view. |
| view.get | This function returns the named view from the named schema specification. |
| view.getBindings | This function generates a binding map suitable for use with cts:parse from the named view. |
| view.getById | This function returns the view with the specified id. |
| view.getColumn | This function returns the named column specification set in the named view in the named schema. |
| view.getField | This function returns the element specification for the named field. |
| view.getPermissions | This function returns the permissions set on the specified view. |
| view.getViewScope | This function returns the scope of the named view in the named schema. |
| view.remove | This function removes the named view from the named schema specification. |
| view.removeById | This function removes the view with the specified id. |
| view.removeColumn | This function removes a column specification from the named view in the named schema. |
| view.removeField | This function removes a field from the named view. |
| view.removePermissions | This function removes permissions from those set for the named view in the named schema specification. |
| view.schemaAddPermissions | This function adds permissions to the specified schema specification. |
| view.schemaCreate | This function creates a new relational schema in the Schema database. |
| view.schemaGet | This function returns the named schema specification document. |
| view.schemaGetPermissions | This function returns the permissions set on the specified schema. |
| view.schemaRemove | This function removes the specified schema. |
| view.schemaRemovePermissions | This function removes permissions from the specified schema specification. |
| view.schemas | This function returns all of the schema specifications. |
| view.schemaSetPermissions | This function sets permissions on the specified schema specification. |
| view.setColumns | This function replaces the current set of column specifications on the named view in the named schema with a new set of columns. |
| view.setFields | This function sets the specified fields on the specified view. |
| view.setName | This function renames the named view in the named schema specification. |
| view.setPermissions | This function sets the permissions for the named view in the named schema specification. |
| view.setViewScope | This function sets the scope of the named view in the named schema specification. |
| view.views | This function returns all of the view specifications in the named schema. |
| WordsSearch.map | Specifies a function similar to Array.prototype.map() to apply to each word within the slice. |
| WordsSearch.match | Limits the words returned by a word lexicon query to those that match a wildcard pattern. |
| WordsSearch.orderBy | Specifies the sort order for the words. |
| WordsSearch.reduce | Specifies a function similar to Array.prototype.reduce() to apply to each word within the slice. |
| WordsSearch.result | Executes the words search definition and returns an array or object depending on whether the results are generated by default, with a mapper, or with a reducer. |
| WordsSearch.slice | Specify a positional subset of words to retrieve. |
| WordsSearch.where | Limit the words returned by a word lexicon query to those in documents selected by a query. |
| WordsSearch.withOptions | Configure advanced options for a words query. |
| xdmp.access | Returns whether a given action on the specified document URI would succeed. |
| xdmp.add64 | Add two 64-bit integer values, discarding overflow. |
| xdmp.addResponseHeader | Adds an HTTP response header field. |
| xdmp.addResponseTrailer | Adds a HTTP Trailer when HTTP chunked transfer is enabled. |
| xdmp.amp | Returns the amp ID for the specified amp. |
| xdmp.ampRoles | Returns the set of all roles assigned to an amp, including roles directly assigned to the amp and roles inherited by other roles. |
| xdmp.and64 | AND two 64-bit integer values. |
| xdmp.apply | Applies an xdmp:function with the given parameters. |
| xdmp.architecture | Returns the hardware architecture upon which MarkLogic Server is running. |
| xdmp.arrayValues | Returns the array values as a Sequence. |
| xdmp.atomizable | Returns true if a value could be atomized without error. |
| xdmp.awsRegion | Returns the current Amazon Web Services region. |
| xdmp.awsServicesDomain | Returns the current Amazon Web Services services domain. |
| xdmp.awsServicesPartition | Returns the current Amazon Web Services services partition. |
| xdmp.azureEnvironment | Returns the current Microsoft Azure Environment. |
| xdmp.azureRegion | Returns the current Microsoft Azure Region. |
| xdmp.base64Decode | Converts base64-encoded string to plaintext. |
| xdmp.base64Encode | Converts plaintext into base64-encoded string. |
| xdmp.binaryDecode | Converts an encoded byte sequence, passed in as a binary node, from the specified encoding to a unicode string. |
| xdmp.binaryIsExternal | Test whether or not a binary node represents an external binary. |
| xdmp.binaryIsLarge | Check whether a binary node is a large binary. |
| xdmp.binaryIsSmall | Check whether a binary node is a small binary. |
| xdmp.binarySize | Returns the size of the data, in bytes, represented by a binary node. |
| xdmp.binaryToInteger | Parses a binary string, returning an integer. |
| xdmp.bootstrapHosts | Returns a sequence of the IDs of all the bootstrap hosts in the cluster. |
| xdmp.cacheStatus | Returns the status of the caches as a Sequence of ObjectNodes. |
| xdmp.callerDialect | Returns the dialect (e.g., "javascript", "1.0-ml", etc) of the caller or the empty sequence if no dialect information is available. |
| xdmp.canGrantRoles | Tests whether a user can grant or revoke a set of roles. |
| xdmp.castableAs | Returns true if a value is castable. |
| xdmp.certificateValidateKeyPair | Checks if a public key and private key match within an asymmetric encryption sequence. |
| xdmp.cluster | Returns the ID of the cluster named in the parameter. |
| xdmp.clusterEffectiveVersion | Returns the current MarkLogic Server effective version. |
| xdmp.clusterFedramp | Returns whether MarkLogic Server is running in a FedRAMP certified environment. |
| xdmp.clusterName | Returns the name of the cluster with the specified ID. |
| xdmp.clusterVersionAtLeast | Returns true current MarkLogic Server effective version is equal or greater that the version |
| xdmp.collationCanonicalUri | Returns the canonical URI for the given URI, if it represents a valid collation. |
| xdmp.collationLocales | Returns an enumeration of supported collation locales. |
| xdmp.collectionDelete | Deletes from the database every document in a collection. |
| xdmp.collectionId | Return the ID of a collection specified by URI. |
| xdmp.collectionLocks | Returns locks of documents in a collection. |
| xdmp.collectionProperties | Returns a sequence of properties documents, one for each document in the specified collection(s) that has a corresponding properties document. |
| xdmp.collections | Returns the IDs of all collections in the system. |
| xdmp.commit | Commit the current transaction to the database. |
| xdmp.configurationTimestamp | Returns timestamp of last configuration changed |
| xdmp.credential | Returns the credential |
| xdmp.credentialId | Returns the id of a named credential. |
| xdmp.credentials | Returns the credentials that the current user is allowed to use. |
| xdmp.crypt | Calculates the password hash for the given password and salt. |
| xdmp.crypt2 | Calculates the password hash for the given plain-text password. |
| xdmp.database | Returns the ID of the database named in the parameter. |
| xdmp.databaseAssignmentPolicy | This function returns the assignment policy for the specified database. |
| xdmp.databaseBackup | Starts an asynchronous backup of the specified list of forests to the backup data directory. |
| xdmp.databaseBackupCancel | Cancels an outstanding backup job with the specified job ID, returning true if the cancel operation is successful, false if the cancel operation is not successful. |
| xdmp.databaseBackupPurge | Purge old backups from a directory. |
| xdmp.databaseBackupStatus | Checks the status of the outstanding backup job with the specified job ID. |
| xdmp.databaseBackupValidate | Validates that the specified list of forests can be backed up to the backup data directory. |
| xdmp.databaseDirectoryCreation | This function returns the directory creation setting for the specified database. |
| xdmp.databaseEncryptionAtRest | Returns the encryption at rest setting for the database identified by database-id |
| xdmp.databaseEncryptionKeyId | Returns the encryption key ID for the database identified by database-id |
| xdmp.databaseForests | Returns a sequence of forest IDs in the specified database. |
| xdmp.databaseGlobalNonblockingTimestamp | Returns the most recent commit timestamp for which a query on the database including its foreign database will not block waiting for transactions to commit or journal frames to arrive from a foreign master. |
| xdmp.databaseIncrementalBackup | Starts an asynchronous incremental backup of the specified list of forests to the backup data directory. |
| xdmp.databaseIncrementalBackupValidate | Validates that the specified list of forests can be backed up to the backup data directory. |
| xdmp.databaseIsForestRetired | This function returns true if the specified forest is retired and false the specified forest is not retired. |
| xdmp.databaseIsRebalancerEnable | This function returns the rebalancer enable setting for the specified database. |
| xdmp.databaseIsReplica | Tests if a database is a replica of a foreign database. |
| xdmp.databaseJournalArchivePurge | Purge journal archive before last incremental backup from a directory. |
| xdmp.databaseName | Return the name of the database with the given ID. |
| xdmp.databaseNodeQueryRolesets | Return a sequence of query-rolesets that are required for proper querying of the given database nodes with Element Level Security. |
| xdmp.databaseNonblockingTimestamp | Returns the most recent commit timestamp for which a query on the database will not block waiting for transactions to commit or journal frames to arrive from a foreign master. |
| xdmp.databasePathNamespaces | Returns the list of path namespaces for the given database id. |
| xdmp.databaseRestore | Starts an asynchronous restore of the specified list of destination forests from the backup data directory. |
| xdmp.databaseRestoreCancel | Cancels an outstanding restore job with the specified job ID, returning true if the cancel operation is successful, false if the cancel operation is not successful. |
| xdmp.databaseRestoreStatus | Checks the status of the outstanding restore job with the specified job ID. |
| xdmp.databaseRestoreValidate | Validates that the specified list of destination forests can be restored from the backup data directory. |
| xdmp.databases | Returns a sequence of the IDs of all the databases in the system. |
| xdmp.daynameFromDate | Returns string representing the dayname value in the localized value of $arg. |
| xdmp.decodeFromNCName | Invertible function that decodes characters an NCName produced by xdmp.encodeForNCName. |
| xdmp.defaultCollections | Returns the collections any new document would get if the current user were to insert a document without specifying the collections. |
| xdmp.defaultPermissions | Returns the permissions any new document would get if the current user were to insert a document without specifying the default permissions. |
| xdmp.describe | Returns a string representing the description of a given item sequence. |
| xdmp.diacriticLess | Returns the specified string, converting all of the characters with diacritics to characters without diacritics. |
| xdmp.directory | Returns the documents from the database in a directory. |
| xdmp.directoryCreate | Creates a directory. |
| xdmp.directoryDelete | Deletes a directory and all of its child and descendant documents and directories from the database. |
| xdmp.directoryLocks | Returns locks of documents in a directory. |
| xdmp.directoryProperties | Returns a sequence of properties documents, one for each document in the specified directory that has a corresponding properties document. |
| xdmp.documentAddCollections | Adds the named document to the given collections. |
| xdmp.documentAddPermissions | Adds the given permissions to the given document or directory. |
| xdmp.documentAddProperties | Adds a sequence of properties to the properties of a document. |
| xdmp.documentAssign | Assign a document URI to a forest index, using the same algorithm as xdmp:document-insert. |
| xdmp.documentDelete | Deletes a document from the database. |
| xdmp.documentFilter | Filters a wide variety of document formats, extracting metadata and text, and returning XHTML. |
| xdmp.documentForest | Returns the forest ID of the forest in which a document (or a lock or a property) with the specified URI is stored. |
| xdmp.documentGet | Returns the document in the file specified by $location. |
| xdmp.documentGetCollections | Returns the collections to which a given document belongs. |
| xdmp.documentGetMetadata | Returns the metadata value of a given document. |
| xdmp.documentGetMetadataValue | Returns the metadata value of a given document. |
| xdmp.documentGetPermissions | Returns the permissions to a given document. |
| xdmp.documentGetProperties | Returns the property values for a document's property. |
| xdmp.documentGetQuality | Returns the quality of the specified document if the document exists. |
| xdmp.documentInsert | Inserts a new document into the database if a document with the specified URI does not already exist. |
| xdmp.documentLoad | Inserts a new document with the specified URI. |
| xdmp.documentLocks | Returns the locks for one or more documents or directories. |
| xdmp.documentPartitionAssign | Assign a document to a partition number, using the partition queries in the database or in the second argument. |
| xdmp.documentProperties | Returns a sequence of properties documents, one for each of the specified documents that has a corresponding properties document. |
| xdmp.documentPutMetadata | Adds metadata to the document. |
| xdmp.documentRemoveCollections | Removes the named document from the given collections. |
| xdmp.documentRemoveMetadata | Removes metadata with certain keys from a document. |
| xdmp.documentRemovePermissions | Removes the given permissions from the named document or directory. |
| xdmp.documentRemoveProperties | Removes a sequence of properties from the properties of a document. |
| xdmp.documentSetCollections | Sets the named document to belong to the given collections, replacing any previously set collections on the named document. |
| xdmp.documentSetMetadata | Sets metadata to the document. |
| xdmp.documentSetPermissions | Sets the permissions on the named document (or directory) to the given permissions, replacing any permissions previously set on the document (or directory). |
| xdmp.documentSetProperties | Sets the properties of a document to the given sequence of elements, replacing any properties that already exist on the document. |
| xdmp.documentSetProperty | Sets a property on a document. |
| xdmp.documentSetQuality | Sets the quality of the document with the given URI. |
| xdmp.documentTimestamp | Returns timestamp of the most recent visible update to a document, lock, or property. |
| xdmp.effectiveVersion | Returns the effective version of this host |
| xdmp.elapsedTime | Returns the elapsed time since the start of processing of this query. |
| xdmp.elementContentType | Returns the schema-defined content-type of an element ("empty", "simple", "element-only", or "mixed"). |
| xdmp.email | Send an email in a JavasCript program. |
| xdmp.encodeForNCName | Invertible function that escapes characters required to be part of an NCName. |
| xdmp.encodingLanguageDetect | Analyzes binary, text, or XML data and suggests possible pairs of encoding and language, with a confidence score for each pair. |
| xdmp.eval | Returns the result of evaluating a string as a Javascript program. |
| xdmp.excelConvert | Converts a Microsoft Excel document to XHTML. |
| xdmp.externalBinary | Returns an external binary node. |
| xdmp.externalBinaryPath | Return the path to the external file associated with an external binary document. |
| xdmp.externalSecurity | Returns the external security ID for the specified external security name. |
| xdmp.filesystemDirectory | Performs a directory listing of the given file pathname. |
| xdmp.filesystemDirectoryCreate | Creates the directory specified by pathname. |
| xdmp.filesystemDirectoryDelete | Deletes the directory specified by pathname. |
| xdmp.filesystemFile | Reads a file from the filesystem. |
| xdmp.filesystemFileDelete | Deletes the file specified by pathname. |
| xdmp.filesystemFileEncryptionStatus | Return the encryption status of a file. |
| xdmp.filesystemFileExists | Return true if a file exists on a host; otherwise false. |
| xdmp.filesystemFileGetTime | Returns access and modification time for a file. |
| xdmp.filesystemFileLength | Reads the length of a file from the filesystem. |
| xdmp.filesystemFilepath | Returns the canonicalized file path of the input path. |
| xdmp.filesystemFileSetTime | Sets access and modification time for a file. |
| xdmp.foreignClusters | Returns the IDs of the foreign clusters. |
| xdmp.foreignClusterStatus | Returns the status of a foreign cluster from a host's point of view as a JSON node. |
| xdmp.forest | Returns the ID of the forest specified as the parameter. |
| xdmp.forestBackup | Backs up forest data files. |
| xdmp.forestBackupStatus | Checks the status of the specified forests for any outstanding backup jobs. |
| xdmp.forestClear | Clears forest data files, including all stands and journals. |
| xdmp.forestCounts | Returns detailed forest statistics for a given forest as a Sequence of ObjectNodes. |
| xdmp.forestDatabaseReplicationResume | Resume database replication with the specified forest IDs. |
| xdmp.forestDatabaseReplicationSuspend | Suspend database replication with the specified forest IDs. |
| xdmp.forestDatabases | Returns the database ID corresponding to the database to which the specified forest belongs, or empty sequence if the forest belongs to no database. |
| xdmp.forestFailoverInfo | Return a sequence of pair of the forest IDs and host IDs for the failover forests and hosts of the given forest. |
| xdmp.forestHost | Return the host of the forest with the given id. |
| xdmp.forestName | Return the name of the forest with the given ID. |
| xdmp.forestOnline | Returns true if the specified forest is online with a state of open, open replica or sync replicating if isReplica is true, or syncing replica if syncingOk is true, otherwise returns false. |
| xdmp.forestOpenReplica | Returns the forest ID for each specified forest or for each forest's replica if the forest is currently experiencing a local disk failover. |
| xdmp.forestRestart | Restarts a forest. |
| xdmp.forestRestore | Restores forest data files. |
| xdmp.forestRollback | Rolls forests back to a previous point in time, marking any fragment newer than the specified timestamp as deleted. |
| xdmp.forests | Returns a sequence of the IDs of all the forests in the system. |
| xdmp.forestState | Returns state of the forests |
| xdmp.forestStatus | Returns the status of a forest as a Sequence of ObjectNodes. |
| xdmp.forestUpdatesAllowed | Return updates allowed state of the forest with the given ID. |
| xdmp.forestValidateReplicaIndex | Validate index data for the database replica forests of the specified forests. |
| xdmp.formatNumber | Returns a formatted number value based on the picture argument. |
| xdmp.fromJSON | Atomizes a JSON node, returning a JSON value. |
| xdmp.fromJsonString | Parses a string as JSON, returning an item sequence. |
| xdmp.function | Returns a function value as an xdmp.function type. |
| xdmp.functionModule | Returns the module location (if any) that the xdmp.function value refers to. |
| xdmp.functionName | Returns the QName of the function(s) that the xdmp.function refers to. |
| xdmp.functionParameterName | Returns the name of the parameter at the designated (1-based) position from the given function's signature. |
| xdmp.functionParameterType | Returns the type of the parameter at the designated (1-based) position from the given function's signature. |
| xdmp.functionReturnType | Returns the return type from the given function's signature. |
| xdmp.functionSignature | Returns the signature of the function that the argument refers to. |
| xdmp.getCurrentRoles | Returns all the current roles, both assigned and inherited by the current user and any received from amps. |
| xdmp.getCurrentUser | Returns the name of the current user. |
| xdmp.getCurrentUserid | Returns the ID of the current user. |
| xdmp.getInvokedPath | Returns the path of the module that is being invoked. |
| xdmp.getOriginalUrl | Returns the portion of the URL following the host_name:port_number. |
| xdmp.getOrphanedBinaries | Returns a sequence of the IDs of all orphaned large binaries in a given forest. |
| xdmp.getRequestBody | For PUT or DELETE requests, returns the body of the request. |
| xdmp.getRequestClientAddress | Returns as a string the internet address of the client from which the HTTP server request is issued. |
| xdmp.getRequestClientCertificate | Returns the PEM encoded client certificate if one was presented. |
| xdmp.getRequestErrorFormat | Returns the current error format for the request. |
| xdmp.getRequestField | Returns the value of a named request field. |
| xdmp.getRequestFieldContentType | This function is used to extract the content type from the request field. |
| xdmp.getRequestFieldFilename | Returns a list of filenames from a multipart request for the field name specified. |
| xdmp.getRequestFieldNames | Returns a sequence of the request field names. |
| xdmp.getRequestHeader | Returns the value of a named request header. |
| xdmp.getRequestHeaderNames | Returns a sequence of request header names. |
| xdmp.getRequestMethod | Returns the HTTP request method. |
| xdmp.getRequestPath | Returns the HTTP request path. |
| xdmp.getRequestPort | Returns the port of the request. |
| xdmp.getRequestProtocol | Returns as a string the request protocol (either "http" or "https") Returns the empty sequence if it is not called from an HTTP server. |
| xdmp.getRequestUrl | Returns the portion of the URL following the host_name:port_number. |
| xdmp.getRequestUser | If this App Server is using application-level authentication, returns the ID of the user in the last successful call to xdmp.login. |
| xdmp.getRequestUsername | If this App Server is using application-level authentication, returns the username in the last successful call to xdmp.login. |
| xdmp.getResponseCode | Returns two nodes, the first containing the HTTP response code and the second containing the HTTP response message. |
| xdmp.getResponseEncoding | Returns the encoding that the response from this server is in. |
| xdmp.getServerField | Returns the value of a named server field. |
| xdmp.getServerFieldNames | Returns a sequence of the server field names. |
| xdmp.getSessionField | Returns the value of a named session field from the session created by the xdmp.login function. |
| xdmp.getSessionFieldNames | Returns a sequence of the HTTP session field names from the session created by the xdmp.login function. |
| xdmp.getTransactionMode | Retrieve the transaction mode for the current session. |
| xdmp.getUrlRewriterPath | Returns the URL of the URL rewriter handler for this application server. |
| xdmp.group | Returns the ID of the group specified in the parameter. |
| xdmp.groupGetAuditEventTypeEnabled | This function returns the audit event type's enabled setting for the audit configuration. |
| xdmp.groupHosts | Returns the IDs of all hosts belonging to the group with the given ID. |
| xdmp.groupName | Returns the name of the group with the given ID. |
| xdmp.groupPortServers | Returns the IDs of all port App Servers belonging to the group with the given ID. |
| xdmp.groups | Returns a sequence of the IDs of all the groups in the system. |
| xdmp.groupServers | Returns the IDs of all App Servers belonging to the group with the given ID. |
| xdmp.groupTaskServer | Returns the ID of the Task Server belonging to the group with the given ID. |
| xdmp.gssServerNegotiate | This function is used for kerberos GSS authentication in application level authentication. |
| xdmp.gunzip | Get a node from a gzip node. |
| xdmp.gzip | Create a gzip node from a node. |
| xdmp.hash32 | Returns the 32-bit hash of a string. |
| xdmp.hash64 | Returns the 64-bit hash of a string. |
| xdmp.hasPrivilege | Tests whether the current user has at least one of a given set of privileges. |
| xdmp.hexToInteger | Parses a hexadecimal string, returning an integer. |
| xdmp.hmacMd5 | Calculates the Hash-based Message Authentication Code (HMAC) using the md5 hash function of the given secret key and message arguments. |
| xdmp.hmacSha1 | Calculates the Hash-based Message Authentication Code (HMAC) using the SHA1 hash function of the given secret key and message arguments. |
| xdmp.hmacSha256 | Calculates the Hash-based Message Authentication Code (HMAC) using the SHA256 hash function of the given secret key and message arguments. |
| xdmp.hmacSha512 | Calculates the Hash-based Message Authentication Code (HMAC) using the SHA512 hash function of the given secret key and message arguments. |
| xdmp.host | Returns the ID of the host named in the parameter. |
| xdmp.hostForests | Returns a sequence of forest IDs in the specified host. |
| xdmp.hostGetSslFipsEnabled | Returns whether fips mode is enabled. |
| xdmp.hostGroup | Returns the ID of the group that the specified host belongs to. |
| xdmp.hostMode | Returns this host mode |
| xdmp.hostModeDescription | Return the description string for this host mode setting |
| xdmp.hostName | Returns the name of the specified host. |
| xdmp.hosts | Returns a sequence of the IDs of all the hosts in the cluster. |
| xdmp.hostStatus | Returns the status of a host as a JSON node. |
| xdmp.httpDelete | Sends an http DELETE request to the http server specified in the URI to delete the specified resource. |
| xdmp.httpGet | Sends the http GET method to the specified URI. |
| xdmp.httpHead | Sends the http HEAD method to the specified URI. |
| xdmp.httpOptions | Sends the http OPTIONS method to the specified URI. |
| xdmp.httpPost | Sends an http POST request to the server. |
| xdmp.httpPut | Sends an HTTP PUT request to an HTTP server. |
| xdmp.initcap | Returns the string where the first letter of each token has been uppercased. |
| xdmp.integerToBinary | Returns a binary representation of an integer. |
| xdmp.integerToHex | Returns a hexadecimal representation of an integer. |
| xdmp.integerToOctal | Returns an octal representation of an integer. |
| xdmp.invoke | Returns the result of evaluating an XQuery or Server-Side JavaScript module at the given path. |
| xdmp.invokeFunction | Returns the result of evaluating a JavaScript function value. |
| xdmp.isWhitespaceNode | Returns true if the node is a text node containing only whitespace. |
| xdmp.jsonPointer | Resolve a (relative) JSON pointer (see RFC 6901) in the context of a node and return the result, if any. |
| xdmp.jsonValidate | Validate a JSON node against a JSON Schema. |
| xdmp.jsonValidateNode | Validate a JSON node against a JSON Schema. |
| xdmp.jsonValidateReport | Validate a JSON node against a JSON Schema and return an error report. |
| xdmp.jsonValidateReportNode | Validate a JSON node against a JSON Schema and return an error report. |
| xdmp.keyFromQName | Construct a context-independent string from a QName. |
| xdmp.keystoreExport | Exports all encryption keys stored in the MarkLogic embedded KMS. |
| xdmp.keystoreImport | Import encryption keys into the MarkLogic embedded KMS from an exported encrypted file (see keystore-export). |
| xdmp.keystoreSetCurrentHost | Set current KMS host to the first one matching the user-specified name for all online MarkLogic nodes in the cluster. |
| xdmp.keystoreSynchronize | Synchronize the Keystore's cache containing the keys used for encryption and decryption. |
| xdmp.keystoreValidateExported | Validates the content of an exported keystore file, see keystore-export and keystore-import |
| xdmp.ldapLookup | Returns an ldap entry. |
| xdmp.ldapSearch | Returns ldap search result. |
| xdmp.load | [DEPRECATED: use xdmp.documentLoad instead] Inserts a new document from the XML file at $path if a document with the specified URI does not already exist. |
| xdmp.lockAcquire | Acquire a lock on a document or directory for an extended amount of time. |
| xdmp.lockForUpdate | Acquires an intent exclusive transaction lock on a URI. |
| xdmp.lockRelease | Unlock a document or directory. |
| xdmp.log | Logs a message into a specific app server error log file. |
| xdmp.logfileScan | Scan a file in ErrorLog.txt format filtering by date range and regular expression. |
| xdmp.login | Logs in a user on an application server that is using application-level authentication and sends a session cookie containing the session ID to the user's browser. |
| xdmp.logLevel | Retrieves the current server log level. |
| xdmp.logmessageParse | Parse messages from logfile to xml, json, raw, or complex (XML with more elements) format. |
| xdmp.logout | Logs the current user out of the session on the server. |
| xdmp.lshift64 | Left-shift a 64-bit integer value. |
| xdmp.md5 | Calculates the md5 hash of the given argument. |
| xdmp.merge | Starts merging the forests of the database, subject to specified options. |
| xdmp.mergeCancel | Cancel the merge with the specified merge ID on a forest with the specified forest ID. |
| xdmp.merging | Returns the forest IDs of any currently merging database forests. |
| xdmp.mimetypes | This function returns all the mimetypes specifications of the cluster. |
| xdmp.modulesDatabase | Returns the database ID of the modules database. |
| xdmp.modulesRoot | Returns the current root path for modules. |
| xdmp.monthNameFromDate | Returns month name, calculated from the localized value of $arg. |
| xdmp.mul64 | Multiply two 64-bit integer values, discarding overflow. |
| xdmp.multipartDecode | Extract the parts from a multipart encoding. |
| xdmp.multipartEncode | Create a multipart encoding of the specified node. |
| xdmp.nodeCollections | Returns any collections for the node's document in the database. |
| xdmp.nodeDatabase | Returns the database id where the parameter is stored. |
| xdmp.nodeDelete | Deletes a node from the database. |
| xdmp.nodeInsertAfter | Adds an immediately following sibling to a node. |
| xdmp.nodeInsertBefore | Adds an immediately preceding sibling to a node. |
| xdmp.nodeInsertChild | Adds a new last child to a node. |
| xdmp.nodeKind | Returns an String representing the node's kind: either "document", "element", "attribute", "text", "namespace", "processing-instruction", "binary", or "comment". |
| xdmp.nodeMetadata | Returns the metadata value of a given node. |
| xdmp.nodeMetadataValue | Returns the metadata value of a node for a particular key. |
| xdmp.nodePermissions | Returns the permissions to a node's document. |
| xdmp.nodeQueryRolesets | Return a sequence of query-rolesets that are required for proper querying with Element Level Security if the node is inserted into the database with the given document-insert options. |
| xdmp.nodeReplace | Replaces a node. |
| xdmp.nodeUri | Returns the document-uri property of the parameter or its ancestor. |
| xdmp.not64 | NOT a 64-bit integer value. |
| xdmp.octalToInteger | Parses an octal string, returning an integer. |
| xdmp.or64 | OR two 64-bit integer values. |
| xdmp.parseDateTime | Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. |
| xdmp.parseYymmdd | Parses a string containing date, time or dateTime using the supplied picture argument and returns a dateTime value. |
| xdmp.partitionForests | Returns a sequence of forest IDs with the specified partition number |
| xdmp.passiveHasPrivilege | Tests whether the current user has at least one of a given set of privileges. |
| xdmp.passiveSecurityAssert | Tests whether the current user has at least one of a given set of privileges. |
| xdmp.path | Returns a string whose value corresponds to the path of the node. |
| xdmp.pdfConvert | Converts a PDF file to XHTML. |
| xdmp.permission | Returns a permission object corresponding to the named role and capability given. |
| xdmp.platform | Returns the operating-system platform upon which MarkLogic Server is running ("winnt", "linux", or "macosx"). |
| xdmp.position | Returns an integer value representing the starting position of a string within the search string. |
| xdmp.powerpointConvert | Converts a Microsoft Powerpoint document to XHTML. |
| xdmp.prettyPrint | Returns a well-formatted XQuery module. |
| xdmp.privilege | Returns the privilege ID for the specified privilege name. |
| xdmp.privilegeKind | Return the kind of the specified privilege. |
| xdmp.privilegeName | Return the name of the specified privilege. |
| xdmp.privilegeRoles | Returns the set of all roles that have a given privilege. |
| xdmp.privileges | Returns the IDs of all privileges in the system. |
| xdmp.productEdition | Returns the current MarkLogic product edition. |
| xdmp.productEnvironment | Returns the current MarkLogic product environment. |
| xdmp.QNameFromKey | Construct a QName from a string of the form "{namespaceURI}localname". |
| xdmp.quarterFromDate | Returns an integer between 1 and 4, both inclusive, calculating the quarter component in the localized value of $arg. |
| xdmp.queryMeters | Returns the current value of the resource meters for this query sequence as a JSON node. |
| xdmp.queryPartitions | This function returns the partition numbers of the partitions that the specified query will be searched on. |
| xdmp.queryTrace | Enables or disables tracing of this query. |
| xdmp.quote | Returns the unevaluated serialized representation of the input parameter as a string. |
| xdmp.random | Returns a random unsigned integer between 0 and a number up to 64 bits long. |
| xdmp.rangePartitionForests | Given a value, the function returns a list of forests that have ranges the value falls into. |
| xdmp.redirectResponse | Redirects the App Server response to a given location. |
| xdmp.removeOrphanedBinary | Remove an orphaned large binary |
| xdmp.request | Returns the unique key of the current request. |
| xdmp.requestCancel | Cancel the request with the given host, server, and request IDs. |
| xdmp.requestLogDelete | Deletes the value stored under the specified $key for the current request. |
| xdmp.requestLogGet | Retrieves the value stored under the specified $key for the current request. |
| xdmp.requestLogPut | Stores or updates a (key, value) pair for the current request. |
| xdmp.requestStatus | Returns the status of a running request as a Sequence of ObjectNodes. |
| xdmp.requestTimestamp | Returns the system timestamp for this request if the request is a query statement. |
| xdmp.resolveUri | Resolves a relative URI against an absolute URI. |
| xdmp.restart | Restart servers on hosts. |
| xdmp.rethrow | Within the catch section of a try-catch expression, re-throw the currently caught error. |
| xdmp.role | Returns the role ID for the specified role name. |
| xdmp.roleCompartment | Return the compartment of the specified role. |
| xdmp.roleDescription | Return the description of the specified role. |
| xdmp.roleGetDefaultCollections | Return the default collections of specified role. |
| xdmp.roleGetDefaultPermissions | Return the default permissions of specified role. |
| xdmp.roleName | Returns the role name for the specified role id. |
| xdmp.rolePrivileges | Return the IDs of privileges of specified role. |
| xdmp.roleRoles | If the parameter $inherit is true, returns the set of all roles inherited by a given role, including roles directly assigned to the role and roles inherited from other roles. |
| xdmp.roles | Returns the IDs of all roles in the system. |
| xdmp.rollback | Roll back the current transaction. |
| xdmp.rsaGenerate | Generate a new RSA public/private key pair. |
| xdmp.rshift64 | Right-shift a 64-bit integer value. |
| xdmp.save | Serializes a node as text and saves it to a file. |
| xdmp.schemaDatabase | Returns the database ID of the schema database associated with the current database. |
| xdmp.securityAssert | Tests whether the current user has at least one of a given set of privileges. |
| xdmp.securityDatabase | Returns the database ID of the security database associated with the current database. |
| xdmp.server | Return the ID(s) of the App Servers, XDBC Servers, ODBC Servers, or Task Servers with the given name. |
| xdmp.serverCollation | Return the default collation of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverCoordinateSystem | Return the default coordinate system of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverDatabase | Return the database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverDefaultXqueryVersion | Return the default xquery version of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverGroup | Return the ID of the group for an App Server, XDBC Server, ODBC Server, or Task Server. |
| xdmp.serverKind | Return the kind of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverMaxThreads | Return the maximum number of server threads allowed on each host in the group of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverModulesDatabase | Return the modules database ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverName | Return the name of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverPort | Return the port of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverRoot | Return the root of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.servers | Returns a sequence of the IDs of all the App Servers (HTTP, XDBC, ODBC, and TaskServer) in the system. |
| xdmp.serverSessionTimeout | Return the session timeout of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverSslCertificateTemplate | Return the SSL certificate template ID of the App Server, XDBC Server, ODBC Server, or Task Server with the given ID. |
| xdmp.serverStatus | Returns the status of an app-server on a host as a Sequence of ObjectNodes. |
| xdmp.setRequestLimit | Changes the meter limit ( elapsedTime/lockCount/readSize) for an actively running request to the specified value. |
| xdmp.setRequestTimeLimit | Changes the time limit for an actively running request to the specified value. |
| xdmp.setResponseChunkedEncoding | Enabble/disables chunked encoding |
| xdmp.setResponseCode | Sets the response code and message. |
| xdmp.setResponseCompression | Enabble/disables HTTP GZIP Response compression |
| xdmp.setResponseContentType | Sets the response content-type. |
| xdmp.setResponseEncoding | Sets the response encoding. |
| xdmp.setResponseOutputMethod | Sets the serialization method. |
| xdmp.setServerField | Sets the value of a named server field. |
| xdmp.setServerFieldPrivilege | Sets the privilege of a named server field. |
| xdmp.setSessionField | Sets the value of a named session field for the session created by the xdmp.login function. |
| xdmp.setTransactionMode | Set the transaction mode for the current session. |
| xdmp.setTransactionName | Set the name of a local or remote transaction. |
| xdmp.setTransactionTimeLimit | Set the transaction time limit for a local or remote transaction. |
| xdmp.sha1 | Calculates the SHA1 hash of the given argument. |
| xdmp.sha256 | Calculates the SHA256 hash of the given argument. |
| xdmp.sha384 | Calculates the SHA384 hash of the given argument. |
| xdmp.sha512 | Calculates the SHA512 hash of the given argument. |
| xdmp.shutdown | Shutdown servers on hosts. |
| xdmp.sleep | Delays for a specific amount of time. |
| xdmp.softwareVersion | Returns this host's software version |
| xdmp.spawn | Place the specified module on the task queue for evaluation. |
| xdmp.sql | Executes an ad hoc SQL query. |
| xdmp.sqlPlan | Returns a node representing the query plan of the given SQL SELECT query. |
| xdmp.startJournalArchiving | Starts journal archiving to the specified list of forests. |
| xdmp.step64 | Combines an initial hash with a subsequent hash. |
| xdmp.stopJournalArchiving | Stops journal archiving to the specified list of forests. |
| xdmp.streamable | Returns a sequence of strings describing the streaming nature of the argument value. |
| xdmp.strftime | Formats a dateTime value using POSIX strftime. |
| xdmp.subbinary | Returns a binary node made up of a subset of the given binary node. |
| xdmp.tidy | Run tidy on the specified html document to convert the document to well-formed and clean XHTML. |
| xdmp.timestampToWallclock | Converts a 64 bit timestamp value to an xs:dateTime. |
| xdmp.toJSON | Constructs a JSON document. |
| xdmp.toJsonString | Returns a string representing a JSON serialization of a given item sequence. |
| xdmp.trace | Signal a trace event. |
| xdmp.traceEnabled | Returns whether or not a trace event is enabled. |
| xdmp.transaction | Returns the transaction ID for the current transaction, or transaction IDs for all transactions with the given name. |
| xdmp.transactionCommit | Explicitly commit a transaction running on a named host. |
| xdmp.transactionLocks | Returns all URIs currently locked for read or write by a transaction. |
| xdmp.transactionRollback | Explicitly roll back a transaction running on a named host. |
| xdmp.triggersDatabase | Returns the database ID of the triggers database associated with the current database. |
| xdmp.type | Returns the name of the simple type of the atomic value argument as an xs:QName. |
| xdmp.unquote | Parses a string as XML, returning one or more document nodes. |
| xdmp.uriContentType | Returns the content type of the given URI as matched in the mimetypes configuration. |
| xdmp.uriFormat | Returns the format of the given URI as matched in the mimetypes configuration. |
| xdmp.uriIsFile | Returns true if a given URI refers to a file which exists on the current application server. |
| xdmp.urlDecode | Converts URL-encoded string to plaintext. |
| xdmp.urlEncode | Converts plaintext into URL-encoded string. |
| xdmp.user | Returns the user ID for the specified user name. |
| xdmp.userExternalSecurity | Returns external security id and user name for an external user. |
| xdmp.userGetDefaultCollections | Return the default collections of specified user. |
| xdmp.userGetDefaultPermissions | Return the default permissions of specified user. |
| xdmp.useridRoles | Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles. |
| xdmp.userLastLogin | Returns the last-login node for the current user. |
| xdmp.userPrivileges | Return IDs of all privileges that a user have. |
| xdmp.userRoles | Returns all roles assigned to a user, including roles directly assigned to the user and roles inherited by other roles. |
| xdmp.validate | Returns an element containing a summary of validation errors in a node. |
| xdmp.version | Returns the current MarkLogic Server version. |
| xdmp.wallclockToTimestamp | Converts an xs:dateTime to a 64 bit timestamp value. |
| xdmp.weekdayFromDate | Returns an integer in the range 1 to 7, inclusive, representing the weekday value in the localized value of $arg. |
| xdmp.weekFromDate | Returns an integer between 1 and 53, both inclusive, representing the week value in the localized value of $arg. |
| xdmp.wordConvert | Converts a Microsoft Word document to XHTML. |
| xdmp.x509CertificateExtract | Returns the XML representation of the specified X.509 certificate. |
| xdmp.x509CertificateGenerate | Generate a new PEM-encoded X.509 certificate. |
| xdmp.x509CertificateIssuerName | Returns the issuer distinguished name for the specified X.509 certificate. |
| xdmp.x509CertificateSubjectName | Returns the subject distinguished name for the specified X.509 certificate. |
| xdmp.xaComplete | Completes (commits or rolls back) a prepared XA transaction. |
| xdmp.xaForget | Forgets a remembered completed XA transaction. |
| xdmp.xor64 | XOR two 64-bit integer values. |
| xdmp.xqueryEval | Returns the result of evaluating a string as an XQuery module. |
| xdmp.xsltEval | Executes an XSLT stylesheet against a node. |
| xdmp.xsltInvoke | Executes an XSLT stylesheet against a node. |
| xdmp.yeardayFromDate | Returns an integer between 1 and 366, both inclusive, representing the yearday value in the localized value of $arg. |
| xdmp.zipCreate | Create a zip file from a list of nodes. |
| xdmp.zipGet | Get a named file from a zip document. |
| xdmp.zipManifest | Return a manifest for this zip file. |
| XMLDocument.attributes | This is inherited from the XMLNode object. The attributes of this node. |
| XMLDocument.childNodes | This is inherited from the XMLNode object. The children of this node. |
| XMLDocument.documentFormat | This is inherited from the Document object. The format of the document node, "JSON", "XML", "TEXT", or "BINARY". |
| XMLDocument.documentURI | The URI of this document. |
| XMLDocument.firstChild | This is inherited from the XMLNode object. The first child of this node, if any. |
| XMLDocument.getElementById | Get the element in this document with the given id, if any. |
| XMLDocument.getElementsByTagName | Return all the elements in the document with the given name. |
| XMLDocument.getElementsByTagNameNS | Return all the elements in the document with the given localname and namespace URI. |
| XMLDocument.hasAttributes | This is inherited from the XMLNode object. Whether this node has attributes. |
| XMLDocument.hasChildNodes | This is inherited from the XMLNode object. Whether this node has any children. |
| XMLDocument.isEqualNode | This is inherited from the XMLNode object. Whether this node is equal to another node. |
| XMLDocument.isSameNode | This is inherited from the XMLNode object. Whether this node is the same exact node as another node. |
| XMLDocument.lastChild | This is inherited from the XMLNode object. The last child of this node, if any. |
| XMLDocument.localName | This is inherited from the XMLNode object. Return the local name of this node. |
| XMLDocument.namespaceURI | This is inherited from the XMLNode object. Return the namespace URI of this node. |
| XMLDocument.nextSibling | This is inherited from the XMLNode object. The node that is the immediately following sibling of this node, if any. |
| XMLDocument.nodeName | This is inherited from the XMLNode object. The DOM name of the node. |
| XMLDocument.nodeValue | This is inherited from the XMLNode object. The DOM value of the node. |
| XMLDocument.ownerDocument | This is inherited from the XMLNode object. The document node containing this node, if any. |
| XMLDocument.parentNode | This is inherited from the XMLNode object. The node that is this node's parent. |
| XMLDocument.prefix | This is inherited from the XMLNode object. Return the namespace prefix of this node. |
| XMLDocument.previousSibling | This is inherited from the XMLNode object. The node that is the immediately preceding sibling of this node, if any. |
| XMLDocument.root | This is inherited from the Document object. The root node of the document. |
| XMLDocument.textContent | This is inherited from the XMLNode object. The DOM text value of the node. |
| XMLNode.attributes | The attributes of this node. |
| XMLNode.baseURI | This is inherited from the Node object. Returns a string representing the base URI of the node. |
| XMLNode.childNodes | The children of this node. |
| XMLNode.firstChild | The first child of this node, if any. |
| XMLNode.hasAttributes | Whether this node has attributes. |
| XMLNode.hasChildNodes | Whether this node has any children. |
| XMLNode.isEqualNode | Whether this node is equal to another node. |
| XMLNode.isSameNode | Whether this node is the same exact node as another node. |
| XMLNode.lastChild | The last child of this node, if any. |
| XMLNode.localName | Return the local name of this node. |
| XMLNode.namespaceURI | Return the namespace URI of this node. |
| XMLNode.nextSibling | The node that is the immediately following sibling of this node, if any. |
| XMLNode.nodeKind | This is inherited from the Node object. Return a string indicating the type of the node. |
| XMLNode.nodeName | The DOM name of the node. |
| XMLNode.nodeType | This is inherited from the Node object. Return the DOM code indicating the type of the node. |
| XMLNode.nodeValue | The DOM value of the node. |
| XMLNode.ownerDocument | The document node containing this node, if any. |
| XMLNode.parentNode | The node that is this node's parent. |
| XMLNode.prefix | Return the namespace prefix of this node. |
| XMLNode.previousSibling | The node that is the immediately preceding sibling of this node, if any. |
| XMLNode.textContent | The DOM text value of the node. |
| XMLNode.xpath | This is inherited from the Node object. Evaluate an XPath using the node as context. |
| xs.date.add | Returns the end of a time period by adding an xs.yearMonthDuration to the xs.date that starts the period. |
| xs.date.eq | Equality comparison on xs.date values |
| xs.date.ge | Greater-than or equal comparison on xs.date values |
| xs.date.gt | Greater-than comparison on xs.date values |
| xs.date.le | Less-than or equal comparison on xs.date values |
| xs.date.lt | Less-than comparison on xs.date values |
| xs.date.ne | Not equal comparison on xs.date values |
| xs.date.subtract | Returns the difference between two xs.dates as an xs.dayTimeDuration. |
| xs.dateTime.add | Returns the end of a time period by adding an xs.yearMonthDuration to the xs.dateTime that starts the period. |
| xs.dateTime.eq | Equality comparison on xs.dateTime values |
| xs.dateTime.ge | Greater-than or equal comparison on xs.dateTime values |
| xs.dateTime.gt | Greater-than comparison on xs.dateTime values |
| xs.dateTime.le | Less-than or equal comparison on xs.dateTime values |
| xs.dateTime.lt | Less-than comparison on xs.dateTime values. |
| xs.dateTime.ne | Not equal comparison on xs.dateTime values |
| xs.dateTime.subtract | Returns the difference between two xs.dateTimes as an xs.dayTimeDuration. |
| xs.dayTimeDuration.add | Adds two xs.dayTimeDurations. |
| xs.dayTimeDuration.divide | Divides an xs.dayTimeDuration by an number. |
| xs.dayTimeDuration.eq | Equality comparison on xs.dayTimeDuration values |
| xs.dayTimeDuration.ge | Greater-than or equal comparison on xs.dayTimeDuration values |
| xs.dayTimeDuration.gt | Greater-than comparison on xs.dayTimeDuration values |
| xs.dayTimeDuration.le | Less-than or equal comparison on xs.dayTimeDuration values |
| xs.dayTimeDuration.lt | Less-than comparison on xs.dayTimeDuration values. |
| xs.dayTimeDuration.multiply | Multiplies an xs.dayTimeDuration by a number. |
| xs.dayTimeDuration.ne | Not equal comparison on xs.dayTimeDuration values |
| xs.dayTimeDuration.subtract | Subtracts one xs.dayTimeDuration from another. |
| xs.gDay.eq | Equality comparison on xs.gDay values |
| xs.gDay.ne | Not equal comparison on xs.gDay values |
| xs.gMonth.eq | Equality comparison on xs.gMonth values |
| xs.gMonth.ne | Not equal comparison on xs.gMonth values |
| xs.gMonthDay.eq | Equality comparison on xs.gMonthDay values |
| xs.gMonthDay.ne | Not equal comparison on xs.gMonthDay values |
| xs.gYear.eq | Equality comparison on xs.gYear values |
| xs.gYear.ne | Not equal comparison on xs.gYear values |
| xs.gYearMonth.eq | Equality comparison on xs.gYearMonth values |
| xs.gYearMonth.ne | Not equal comparison on xs.gYearMonth values |
| xs.time.add | Adds the value of the hours, minutes and seconds components of an xs.dayTimeDuration to an xs.time value. |
| xs.time.eq | Equality comparison on xs.time values |
| xs.time.ge | Greater-than or equal comparison on xs.time values |
| xs.time.gt | Greater-than comparison on xs.time values |
| xs.time.le | Less-than or equal comparison on xs.time values |
| xs.time.lt | Less-than comparison on xs.time values |
| xs.time.ne | Not equal comparison on xs.time values |
| xs.time.subtract | Returns the difference between two xs.times as an xs.dayTimeDuration. |
| xs.yearMonthDuration.add | Adds two xs.yearMonthDuration. |
| xs.yearMonthDuration.divide | Divides an xs.yearMonthDuration by an number. |
| xs.yearMonthDuration.eq | Equality comparison on xs.yearMonthDuration values |
| xs.yearMonthDuration.ge | Greater-than or equal comparison on xs.yearMonthDuration values |
| xs.yearMonthDuration.gt | Greater-than comparison on xs.yearMonthDuration values |
| xs.yearMonthDuration.le | Less-than or equal comparison on xs.yearMonthDuration values |
| xs.yearMonthDuration.lt | Less-than comparison on xs.yearMonthDuration values. |
| xs.yearMonthDuration.multiply | Multiplies an xs.yearMonthDuration by a number. |
| xs.yearMonthDuration.ne | Not equal comparison on xs.yearMonthDuration values |
| xs.yearMonthDuration.subtract | Subtracts one xs.yearMonthDuration from another. |