|
Function Summary
|
|
admin:appserver-add-namespace
|
Add one or more namespaces to an App Server configuration,
which will predefine the namespace(s) for all requests
evaluated against the App Server.
|
|
admin:appserver-add-request-blackout
|
This function adds a request blackout specification for a
appserver to a configuration.
|
|
admin:appserver-add-schema
|
This function adds a schema binding definition to the
existing schema binding definitions in the configuration
for the specified App Server.
|
|
admin:appserver-copy
|
This function creates a new App Server specification with the
same settings as the App Server with the specified ID.
|
|
admin:appserver-delete
|
This function deletes an App Server in the configuration.
|
|
admin:appserver-delete-namespace
|
This function deletes a namespace configuration from the
configuration for the specified App Server.
|
|
admin:appserver-delete-request-blackout
|
This function deletes a request blackout specification for a
appserver from a configuration.
|
|
admin:appserver-delete-schema
|
This function deletes a schema definition in the
configuration for the specified App Server.
|
|
admin:appserver-get-address
|
This function returns the IP address of the App Server
configuration.
|
|
admin:appserver-get-authentication
|
This function returns the authentication scheme
(basic, digest, digestbasic, or application-level)
configured for the specified App Server.
|
|
admin:appserver-get-backlog
|
This function returns the socket listen backlog setting
for the specified App Server.
|
|
admin:appserver-get-collation
|
This function returns the collation URI set in the
configuration for the specified App Server.
|
|
admin:appserver-get-compute-content-length
|
This function returns the value of whether the WebDAV server
computes content length.
|
|
admin:appserver-get-concurrent-request-limit
|
This function returns the concurrent request limit for
any user for the specified App Server.
|
|
admin:appserver-get-database
|
This function returns the ID of the database to which the
App Server is set to execute queries against for the
specified database.
|
|
admin:appserver-get-debug-allow
|
This function returns the value of debug allow setting
configured for this App Server, where true indicates that
the App Server will allow queries to be debugged, and false
indicates that it will not.
|
|
admin:appserver-get-default-time-limit
|
This function returns the default time limit value configured
for the specified App Server.
|
|
admin:appserver-get-default-user
|
This function returns the default user value configured
for the specified App Server.
|
|
admin:appserver-get-default-xquery-version
|
This function returns the value of the default xquery
version configured for the specified App Server.
|
|
admin:appserver-get-display-last-login
|
This function returns the value of the whether or not the
appserver should display users' last login information.
|
|
admin:appserver-get-enabled
|
This function returns the enabled state for the specified
App Server.
|
|
admin:appserver-get-error-handler
|
This function returns the path to the error handler
configured for this App Server.
|
|
admin:appserver-get-group-id
|
This function returns the ID of the specified
App Server's group.
|
|
admin:appserver-get-host-ids
|
This function returns the ID(s) of the hosts the specified
App Server's is currently running on.
|
|
admin:appserver-get-id
|
This function returns the ID(s) of the specified
App Server(s).
|
|
admin:appserver-get-keep-alive-timeout
|
This function returns the keep alive timeout value
configured for the specified App Server.
|
|
admin:appserver-get-last-login
|
This function returns the ID of the database to which the
App Server stores users' last login information.
|
|
admin:appserver-get-log-errors
|
This function returns the value of the log errors setting
configured for this App Server, where true indicates that
the App Server will send uncaught exceptions to the
ErrorLog.txt file, and false indicates that
it will not.
|
|
admin:appserver-get-max-time-limit
|
This function returns the max time limit value configured
for the specified App Server.
|
|
admin:appserver-get-modules-database
|
This function returns the ID of the database set as the
modules database for the specified database.
|
|
admin:appserver-get-name
|
This function returns the name of the appserver with the
specified ID.
|
|
admin:appserver-get-namespaces
|
This function returns the value of any namespace definitions
predefined for the specified App Server.
|
|
admin:appserver-get-output-encoding
|
This function returns the value for the output encoding
setting for the specified App Server.
|
|
admin:appserver-get-output-sgml-character-entities
|
This function returns the value for the
output sgml character entities setting for the
specified App Server.
|
|
admin:appserver-get-port
|
This function returns the port for the specified App Server.
|
|
admin:appserver-get-pre-commit-trigger-depth
|
This function returns the pre commit trigger depth value
configured for the specified App Server.
|
|
admin:appserver-get-pre-commit-trigger-limit
|
This function returns the pre commit trigger limit value
configured for the specified App Server.
|
|
admin:appserver-get-privilege
|
This function returns the privilege ID for the
specified App Server.
|
|
admin:appserver-get-profile-allow
|
This function returns the value of the profile allow setting
configured for this App Server, where true indicates that
the App Server will allow queries to be profiled, and false
indicates that it will not.
|
|
admin:appserver-get-request-blackouts
|
This function returns the request blackouts specification
for the specified appserver from the configuration.
|
|
admin:appserver-get-request-timeout
|
This function returns the request timeout value configured
for the specified App Server.
|
|
admin:appserver-get-root
|
This function returns the root for the specified App Server.
|
|
admin:appserver-get-schemas
|
This function returns the value of any schemas definitions
predefined for the specified App Server.
|
|
admin:appserver-get-session-timeout
|
This function returns the session timeout value
configured for the specified App Server.
|
|
admin:appserver-get-static-expires
|
This function returns the value of the "expires" HTTP header for static content
to expire after this many seconds port for the specified App Server.
|
|
admin:appserver-get-threads
|
This function returns the maximum number of threads
configured for the specified App Server.
|
|
admin:appserver-get-type
|
This function returns the type of appserver with the
specified ID.
|
|
admin:appserver-one-time-request-blackout
|
This function constructs a one-time request-blackout
specification.
|
|
admin:appserver-recurring-request-blackout
|
This function constructs a request-blackout specification.
|
|
admin:appserver-set-address
|
This function changes the IP Address in the configuration for
the specified App Server to the specified address.
|
|
admin:appserver-set-authentication
|
This function sets the authentication scheme in the
configuration for the specified App Server.
|
|
admin:appserver-set-backlog
|
This function sets the value in the configuration of
the backlog (the maximum number of pending connections
allowed on the HTTP socket) for the specified App Server.
|
|
admin:appserver-set-collation
|
This function sets the default collation in the
configuration for the specified App Server.
|
|
admin:appserver-set-compute-content-length
|
This function changes the value whether a WebDAV server computes
content length.
|
|
admin:appserver-set-concurrent-request-limit
|
This function sets the limit on concurrent requests that
any user may have on a particular appserver.
|
|
admin:appserver-set-database
|
This function sets the value in the configuration of
the database for the specified App Server.
|
|
admin:appserver-set-debug-allow
|
This function sets the debug allow setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-default-time-limit
|
This function sets the default time limit (the maximum total amount
of time to service a request before the App Server throws a
timeout exception) in the configuration for the specified
App Server.
|
|
admin:appserver-set-default-user
|
This function sets the default user (for use with
application-level authentication) in the configuration
for the specified App Server.
|
|
admin:appserver-set-default-xquery-version
|
This function sets the default XQuery version setting
in the configuration for this App Server.
|
|
admin:appserver-set-display-last-login
|
This function sets the display last login setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-enabled
|
This function sets the enabled state in the configuration
for the specified App Server.
|
|
admin:appserver-set-error-handler
|
This function sets the value of the path to the error
handler in the configuration for the specified App Server.
|
|
admin:appserver-set-keep-alive-timeout
|
This function sets the keep-alive timeout (the maximum
number of second for subsequent socket requests to time
out) in the configuration for the specified App Server.
|
|
admin:appserver-set-last-login
|
This function sets the value in the configuration of
the last login database for the specified App Server.
|
|
admin:appserver-set-log-errors
|
This function sets the log errors setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-max-time-limit
|
This function sets the max time limit (the maximum total amount
of time to service a request before the App Server throws a
timeout exception) in the configuration for the specified
App Server.
|
|
admin:appserver-set-modules-database
|
This function sets the value in the configuration of
modules database for the specified App Server to the
specified database ID.
|
|
admin:appserver-set-name
|
This function changes the name of an existing App Server
to the newly specified value.
|
|
admin:appserver-set-output-encoding
|
This function sets the value for the default output encoding
in the configuration for the specified App Server.
|
|
admin:appserver-set-output-sgml-character-entities
|
This function sets the SGML character entity output
setting in the configuration for the specified App Server.
|
|
admin:appserver-set-port
|
This function changes the port in the configuration for
the specified App Server to the specified number.
|
|
admin:appserver-set-pre-commit-trigger-depth
|
This function sets the maximum depth (how many triggers can
cause other triggers to fire, which in turn cause others
to fire, and so on) in the configuration for the specifed
App Server.
|
|
admin:appserver-set-pre-commit-trigger-limit
|
This function sets the value in the configuration
for the maximum number of
pre-commit triggers a single statement can invoke
for the specified App Server.
|
|
admin:appserver-set-privilege
|
This function sets an execute privilege in the configuration
for the specified App Server.
|
|
admin:appserver-set-profile-allow
|
This function sets the profile allow setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-request-timeout
|
This function sets the value of the socket request
timeout (the number of seconds before the socket times
out) in the configuration for the specified App Server.
|
|
admin:appserver-set-root
|
This function changes the root for a specified App Server
to the newly specified value.
|
|
admin:appserver-set-session-timeout
|
This function sets the session timeout value (in seconds)
in the configuration for the specified App Server.
|
|
admin:appserver-set-static-expires
|
This function changes the value of the "expires" HTTP header for a specified App Server
to the newly specified value.
|
|
admin:appserver-set-threads
|
This function sets the value in the configuration of
the maximum number of threads for the specified App Server.
|
|
admin:database-add-backup
|
This function adds scheduled backup specifications for a
database to a configuration.
|
|
admin:database-add-element-attribute-word-lexicon
|
This function adds an element attribute word lexicon to the
specified database in the configuration.
|
|
admin:database-add-element-word-lexicon
|
This function adds an element word lexicon to the
specified database in the configuration.
|
|
admin:database-add-element-word-query-through
|
This function adds an element word query through to the
specified database in the configuration.
|
|
admin:database-add-field
|
This function adds the field specification to the specified
database in the configuration.
|
|
admin:database-add-field-excluded-element
|
This function adds the field excluded
element specification in the specified
database in the configuration.
|
|
admin:database-add-field-included-element
|
This function adds the field included
element specification tn the specified
database in the configuration.
|
|
admin:database-add-field-word-lexicon
|
This function adds a word lexicon to the
specified database in the configuration.
|
|
admin:database-add-fragment-parent
|
This function adds the specified fragment parent to the
specified database in the configuration.
|
|
admin:database-add-fragment-root
|
This function adds the specified fragment root to the specified
database in the configuration.
|
|
admin:database-add-geospatial-element-attribute-pair-index
|
This function adds a geospatial element attribute
pair index to the specified
database in the configuration.
|
|
admin:database-add-geospatial-element-child-index
|
This function adds a geospatial element child index to
the specified database in the configuration.
|
|
admin:database-add-geospatial-element-index
|
This function adds a range element index to the specified
database in the configuration.
|
|
admin:database-add-geospatial-element-pair-index
|
This function adds a geospatial element pair index to
the specified database in the configuration.
|
|
admin:database-add-merge-blackout
|
This function adds a merge blackout specification for a
database to a configuration.
|
|
admin:database-add-phrase-around
|
This function adds a phrase around to the
specified database in the configuration.
|
|
admin:database-add-phrase-through
|
This function adds a phrase through to the
specified database in the configuration.
|
|
admin:database-add-range-element-attribute-index
|
This function adds a range element attribute index to the
specified database in the configuration.
|
|
admin:database-add-range-element-index
|
This function adds a range element index to the specified
database in the configuration.
|
|
admin:database-add-word-lexicon
|
This function adds a word lexicon to the
specified database in the configuration.
|
|
admin:database-add-word-query-excluded-element
|
This function adds the word query excluded
element specification for the specified
database to the configuration.
|
|
admin:database-add-word-query-included-element
|
This function adds the word query included
element specification to the specified
database in the configuration.
|
|
admin:database-attach-forest
|
This function attaches the specified forest to the
specified database.
|
|
admin:database-copy
|
This function creates a new database specification with the
same settings as the database with the specified ID.
|
|
admin:database-create
|
This function creates a new database specification.
|
|
admin:database-delete
|
This function deletes the configuration from the
specified database(s).
|
|
admin:database-delete-backup
|
This function deletes scheduled backup specifications for a
database from a configuration.
|
|
admin:database-delete-element-attribute-word-lexicon
|
This function deletes an element attribute word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-element-word-lexicon
|
This function deletes an element word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-element-word-query-through
|
This function deletes an element word query through for the
specified database from the configuration.
|
|
admin:database-delete-field
|
This function deletes the field specification in the specified
database from the configuration.
|
|
admin:database-delete-field-excluded-element
|
This function deletes the field excluded
element specification in the specified
database from the configuration.
|
|
admin:database-delete-field-included-element
|
This function deletes the field included
element specification in the specified
database from the configuration.
|
|
admin:database-delete-field-word-lexicon
|
This function deletes a word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-fragment-parent
|
This function deletes the specified fragment parent in the
specified database from the configuration.
|
|
admin:database-delete-fragment-root
|
This function deletes the specified fragment root in the
specified database from the configuration.
|
|
admin:database-delete-geospatial-element-attribute-pair-index
|
This function deletes a geospatial element attribute
pair index in the specified
database from the configuration.
|
|
admin:database-delete-geospatial-element-child-index
|
This function deletes a geospatial element child index for the
specified database in the configuration.
|
|
admin:database-delete-geospatial-element-index
|
This function deletes a geospatial element index for the
specified database in the configuration.
|
|
admin:database-delete-geospatial-element-pair-index
|
This function deletes a geospatial element pair index for
the specified database from the configuration.
|
|
admin:database-delete-merge-blackout
|
This function deletes a merge blackout specification for a
database from a configuration.
|
|
admin:database-delete-phrase-around
|
This function deletes a phrase around for the
specified database from the configuration.
|
|
admin:database-delete-phrase-through
|
This function deletes a phrase through for the
specified database from the configuration.
|
|
admin:database-delete-range-element-attribute-index
|
This function deletes a range element attribute index for
the specified database in the configuration.
|
|
admin:database-delete-range-element-index
|
This function deletes a range element index for the specified
database in the configuration.
|
|
admin:database-delete-word-lexicon
|
This function deletes a word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-word-query-excluded-element
|
This function deletes the word query excluded
element specification in the specified
database from the configuration.
|
|
admin:database-delete-word-query-included-element
|
This function deletes the word query included
element specification in the specified
database from the configuration.
|
|
admin:database-detach-forest
|
This function detaches the specified forest from the
specified database.
|
|
admin:database-element-attribute-word-lexicon
|
This function constructs an element attribute word
lexicon specification.
|
|
admin:database-element-word-lexicon
|
This function constructs an element word lexicon specification.
|
|
admin:database-element-word-query-through
|
This function constructs an element word query
through specification.
|
|
admin:database-excluded-element
|
This function constructs an excluded element specification.
|
|
admin:database-field
|
This function constructs a field specification.
|
|
admin:database-fragment-parent
|
This function constructs a fragment parent specification.
|
|
admin:database-fragment-root
|
This function constructs a fragment root specification.
|
|
admin:database-geospatial-element-attribute-pair-index
|
This function constructs a geospatial element attribute
pair index specification.
|
|
admin:database-geospatial-element-child-index
|
This function constructs a geospatial element child index
specification.
|
|
admin:database-geospatial-element-index
|
This function constructs a geospatial element index
specification.
|
|
admin:database-geospatial-element-pair-index
|
This function constructs a geospatial element pair index
specification.
|
|
admin:database-get-attached-forests
|
This function returns the attached forest IDs
for the specified database from the configuration.
|
|
admin:database-get-attribute-value-positions
|
This function returns the attribute value positions setting
for the specified database from the configuration.
|
|
admin:database-get-backups
|
This function returns the scheduled backups
for the specified database from the configuration.
|
|
admin:database-get-collection-lexicon
|
This function returns the collection lexicon setting
for the specified database from the configuration.
|
|
admin:database-get-directory-creation
|
This function returns the directory creation setting
for the specified database from the configuration.
|
|
admin:database-get-element-attribute-word-lexicons
|
This function returns the element attribute word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-element-value-positions
|
This function returns the element value positions setting
for the specified database from the configuration.
|
|
admin:database-get-element-word-lexicons
|
This function returns the element word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-element-word-positions
|
This function returns the element word positions setting
for the specified database from the configuration.
|
|
admin:database-get-element-word-query-throughs
|
This function returns the element word query throughs
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-enabled
|
This function returns the enabled value
for the specified database from the configuration.
|
|
admin:database-get-expunge-locks
|
This function returns the expunge locks setting
for the specified database from the configuration.
|
|
admin:database-get-fast-case-sensitive-searches
|
This function returns the fast case sensitive searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-diacritic-sensitive-searches
|
This function returns the fast diacritic sensitive
searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-character-searches
|
This function returns the fast element character
searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-phrase-searches
|
This function returns the fast element phrase searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-trailing-wildcard-searches
|
This function returns the trailing wildcard searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-word-searches
|
This function returns the fast element word searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-phrase-searches
|
This function returns the fast phrase searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-reverse-searches
|
This function returns the fast reverse searches setting
for the specified database from the configuration.
|
|
admin:database-get-field
|
This function returns the field specification
for the specified database from the configuration.
|
|
admin:database-get-field-excluded-elements
|
This function returns the field excluded elements
specification
for the specified database from the configuration.
|
|
admin:database-get-field-fast-case-sensitive-searches
|
This function returns true if the fast case sensitive searches setting
for the specified field is enabled.
|
|
admin:database-get-field-fast-diacritic-sensitive-searches
|
This function returns true if the fast diacritic sensitive searches setting
for the specified field is enabled.
|
|
admin:database-get-field-fast-phrase-searches
|
This function returns true if the fast phrase searches setting
for the specified field is enabled.
|
|
admin:database-get-field-include-document-root
|
This function returns the field include document root setting
for the specified field from the configuration.
|
|
admin:database-get-field-included-elements
|
This function returns the fields included elements
specification for the specified database from the
configuration.
|
|
admin:database-get-field-one-character-searches
|
This function returns true if the one character searches setting
for the specified field is enabled.
|
|
admin:database-get-field-stemmed-searches
|
This function returns stemmed searches setting
for the specified field if configured.
|
|
admin:database-get-field-three-character-searches
|
This function returns true if the three character searches setting
for the specified field is enabled.
|
|
admin:database-get-field-three-character-word-positions
|
This function returns true if the three character word positions setting
for the specified field is enabled.
|
|
admin:database-get-field-trailing-wildcard-searches
|
This function returns true if the trailing wildcard searches setting
for the specified field is enabled.
|
|
admin:database-get-field-trailing-wildcard-word-positions
|
This function returns true if the trailing wildcard word positions setting
for the specified field is enabled.
|
|
admin:database-get-field-two-character-searches
|
This function returns true if the two character searches setting
for the specified field is enabled.
|
|
admin:database-get-field-word-lexicons
|
This function returns the word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-field-word-searches
|
This function returns true if the word searches setting
for the specified field is enabled.
|
|
admin:database-get-fields
|
This function returns the fields specification(s)
for the specified database from the configuration.
|
|
admin:database-get-format-compatibility
|
This function returns the format compatibility setting
for the specified database from the configuration.
|
|
admin:database-get-fragment-parents
|
This function returns the fragment parents specification
for the specified database from the configuration.
|
|
admin:database-get-fragment-roots
|
This function returns the fragment roots specification
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-attribute-pair-indexes
|
This function returns the geospatial element attribute pair
indexes specification(s)
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-child-indexes
|
This function returns the geospatial element child indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-indexes
|
This function returns the geospatial element indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-pair-indexes
|
This function returns the geospatial element pair indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-id
|
This function returns the ID
for the specified database from the configuration.
|
|
admin:database-get-in-memory-limit
|
This function returns the in memory limit setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-list-size
|
This function returns the im memory list size setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-range-index-size
|
This function returns the in memory range index size setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-reverse-index-size
|
This function returns the in memory reverse index size setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-tree-size
|
This function returns the in memory tree size setting
for the specified database from the configuration.
|
|
admin:database-get-index-detection
|
This function returns the index detection setting
for the specified database from the configuration.
|
|
admin:database-get-inherit-collections
|
This function returns the inherit collections setting
for the specified database from the configuration.
|
|
admin:database-get-inherit-permissions
|
This function returns the inherit positions setting
for the specified database from the configuration.
|
|
admin:database-get-inherit-quality
|
This function returns the inherit quality setting
for the specified database from the configuration.
|
|
admin:database-get-journal-size
|
This function returns the journal size setting
for the specified database from the configuration.
|
|
admin:database-get-language
|
This function returns the language
for the specified database from the configuration.
|
|
admin:database-get-maintain-directory-last-modified
|
This function returns the maintain directory last
modified setting
for the specified database from the configuration.
|
|
admin:database-get-maintain-last-modified
|
This function returns the maintain last modified setting
for the specified database from the configuration.
|
|
admin:database-get-merge-blackouts
|
This function returns the merge blackouts specification
for the specified database from the configuration.
|
|
admin:database-get-merge-enable
|
This function returns the merge enable setting
for the specified database from the configuration.
|
|
admin:database-get-merge-max-size
|
This function returns the merge max size setting
for the specified database from the configuration.
|
|
admin:database-get-merge-min-ratio
|
This function returns the merge min ratio setting
for the specified database from the configuration.
|
|
admin:database-get-merge-min-size
|
This function returns the merge min size setting
for the specified database from the configuration.
|
|
admin:database-get-merge-timestamp
|
This function returns the merge timestamp setting
for the specified database from the configuration.
|
|
admin:database-get-name
|
This function returns the name
for the specified database from the configuration.
|
|
admin:database-get-one-character-searches
|
This function returns the one character searches setting
for the specified database from the configuration.
|
|
admin:database-get-phrase-arounds
|
This function returns the phrase arounds
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-phrase-throughs
|
This function returns the phrase throughs
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-positions-list-max-size
|
This function returns the positions list max size setting
for the specified database from the configuration.
|
|
admin:database-get-preallocate-journals
|
This function returns the preallocate journals setting
for the specified database from the configuration.
|
|
admin:database-get-preload-mapped-data
|
This function returns the preload mapped data setting
for the specified database from the configuration.
|
|
admin:database-get-range-element-attribute-indexes
|
This function returns the range element attribute
indexes specification(s)
for the specified database from the configuration.
|
|
admin:database-get-range-element-indexes
|
This function returns the range element indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-reindexer-enable
|
This function returns the reindexer enable setting
for the specified database from the configuration.
|
|
admin:database-get-reindexer-throttle
|
This function returns the reindexer throttle setting
for the specified database from the configuration.
|
|
admin:database-get-reindexer-timestamp
|
This function returns the reindexer timestamp setting
for the specified database from the configuration.
|
|
admin:database-get-schema-database
|
This function returns the ID of the schema database
for the specified database from the configuration.
|
|
admin:database-get-security-database
|
This function returns the ID of the security database
for the specified database from the configuration.
|
|
admin:database-get-stemmed-searches
|
This function returns the stemmed searches setting
for the specified database from the configuration.
|
|
admin:database-get-three-character-searches
|
This function returns the three character searches setting
for the specified database from the configuration.
|
|
admin:database-get-three-character-word-positions
|
This function returns the three character word positions
setting
for the specified database from the configuration.
|
|
admin:database-get-trailing-wildcard-searches
|
This function returns the trailing wildcard searches setting
for the specified database from the configuration.
|
|
admin:database-get-trailing-wildcard-word-positions
|
This function returns the trailing wildcard word
positions setting
for the specified database from the configuration.
|
|
admin:database-get-triggers-database
|
This function returns the ID of the triggers database
for the specified database from the configuration.
|
|
admin:database-get-two-character-searches
|
This function returns the two character searches setting
for the specified database from the configuration.
|
|
admin:database-get-uri-lexicon
|
This function returns the URI lexicon setting
for the specified database from the configuration.
|
|
admin:database-get-word-lexicons
|
This function returns the word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-word-positions
|
This function returns the word positions setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-excluded-elements
|
This function returns the word query excluded elements setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-fast-case-sensitive-searches
|
This function returns the word query fast case
sensitive searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-fast-diacritic-sensitive-searches
|
This function returns the word query fast diacritic
sensitive searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-fast-phrase-searches
|
This function returns the word query fast phrase
searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-include-document-root
|
This function returns the word query include
document root setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-included-elements
|
This function returns the word query included elements setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-one-character-searches
|
This function returns the word query one character
searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-stemmed-searches
|
This function returns the reindexer word query stemmed
searches setting for the specified database from the
configuration.
|
|
admin:database-get-word-query-three-character-searches
|
This function returns the word query three character
searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-three-character-word-positions
|
This function returns the word query three character
word positions setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-trailing-wildcard-searches
|
This function returns the word query trailing
wildcard searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-trailing-wildcard-word-positions
|
This function returns the word query trailing wildcard
word positions setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-two-character-searches
|
This function returns the word query two character
searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-word-searches
|
This function returns the word query searches setting
for the specified database from the configuration.
|
|
admin:database-get-word-searches
|
This function returns the word searches setting
for the specified database from the configuration.
|
|
admin:database-included-element
|
This function constructs an included element specification.
|
|
admin:database-monthly-backup
|
This function constructs a monthly scheduled backup.
|
|
admin:database-one-time-backup
|
This function constructs a one-time backup.
|
|
admin:database-one-time-merge-blackout
|
This function constructs a one-time merge-blackout
specification.
|
|
admin:database-phrase-around
|
This function constructs a phrase through specification.
|
|
admin:database-phrase-through
|
This function constructs a phrase through specification.
|
|
admin:database-range-element-attribute-index
|
This function constructs a range element attribute index
specification.
|
|
admin:database-range-element-index
|
This function constructs a range element index
specification.
|
|
admin:database-recurring-merge-blackout
|
This function constructs a merge-blackout specification.
|
|
admin:database-set-attribute-value-positions
|
This function sets the attribute value positions setting
for the specified database in the configuration.
|
|
admin:database-set-collection-lexicon
|
This function sets the collection lexicon setting
for the specified database in the configuration.
|
|
admin:database-set-directory-creation
|
This function sets the directory creation setting
for the specified database in the configuration.
|
|
admin:database-set-element-value-positions
|
This function sets the element value positions setting
for the specified database in the configuration.
|
|
admin:database-set-element-word-positions
|
This function sets the element word positions setting
for the specified database in the configuration.
|
|
admin:database-set-enabled
|
This function sets the enabled value
for the specified database in the configuration.
|
|
admin:database-set-expunge-locks
|
This function sets the expunge locks setting
for the specified database in the configuration.
|
|
admin:database-set-fast-case-sensitive-searches
|
This function sets the fast case sensitive searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-diacritic-sensitive-searches
|
This function sets the fast diacritic-sensitive searches
setting for the specified database in the configuration.
|
|
admin:database-set-fast-element-character-searches
|
This function sets the fast element character searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-element-phrase-searches
|
This function sets the fast element phrase searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-element-trailing-wildcard-searches
|
This function sets the fast element trailing wildcard searches
setting for the specified database in the configuration.
|
|
admin:database-set-fast-element-word-searches
|
This function sets the element word searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-phrase-searches
|
This function sets the fast phrase searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-reverse-searches
|
This function sets the fast reverse searches setting
for the specified database in the configuration.
|
|
admin:database-set-field-fast-case-sensitive-searches
|
This function sets the field fast case sensitive
searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-fast-diacritic-sensitive-searches
|
This function sets the field fast diacritic sensitive
searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-fast-phrase-searches
|
This function sets the field fast phrase searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-include-document-root
|
This function sets the field include document root setting
for the specified field in the configuration.
|
|
admin:database-set-field-name
|
This function sets the field name setting
for the specified field in the configuration.
|
|
admin:database-set-field-one-character-searches
|
This function sets the field one character searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-stemmed-searches
|
This function sets the field stemmed searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-three-character-searches
|
This function sets the field three character searches
setting
for the specified field in the configuration.
|
|
admin:database-set-field-three-character-word-positions
|
This function sets the field three character
word positions setting
for the specified field in the configuration.
|
|
admin:database-set-field-trailing-wildcard-searches
|
This function sets the field trailing wildcard
searches setting
for the specified database in the configuration.
|
|
admin:database-set-field-trailing-wildcard-word-positions
|
This function sets the field trailing wildcard word
positions setting
for the specified field in the configuration.
|
|
admin:database-set-field-two-character-searches
|
This function sets the field two character searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-word-searches
|
This function sets the field word searches setting
for the specified field in the configuration.
|
|
admin:database-set-format-compatibility
|
This function sets the format cpmpatibility setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-limit
|
This function sets the in-memory limit setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-list-size
|
This function sets the in-memory list size setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-range-index-size
|
This function sets the in-memory range index size setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-reverse-index-size
|
This function sets the in-memory range reverse index
size setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-tree-size
|
This function sets the in-memory tree size setting
for the specified database in the configuration.
|
|
admin:database-set-index-detection
|
This function sets the index detection setting
for the specified database in the configuration.
|
|
admin:database-set-inherit-collections
|
This function sets the inherit collections setting
for the specified database in the configuration.
|
|
admin:database-set-inherit-permissions
|
This function sets the inherit permissions setting
for the specified database in the configuration.
|
|
admin:database-set-inherit-quality
|
This function sets the inherit quality setting
for the specified database in the configuration.
|
|
admin:database-set-journal-size
|
This function sets the journal size setting
for the specified database in the configuration.
|
|
admin:database-set-language
|
This function sets the language
for the specified database in the configuration.
|
|
admin:database-set-maintain-directory-last-modified
|
This function sets the maintain directory last modified setting
for the specified database in the configuration.
|
|
admin:database-set-maintain-last-modified
|
This function sets the maintain last modified setting
for the specified database in the configuration.
|
|
admin:database-set-merge-enable
|
This function sets the merge enable setting
for the specified database in the configuration.
|
|
admin:database-set-merge-max-size
|
This function sets the merge max size setting
for the specified database in the configuration.
|
|
admin:database-set-merge-min-ratio
|
This function sets the merge min ratio setting
for the specified database in the configuration.
|
|
admin:database-set-merge-min-size
|
This function sets the merge minimum size setting
for the specified database in the configuration.
|
|
admin:database-set-merge-timestamp
|
This function sets the merge timestamp setting
for the specified database in the configuration.
|
|
admin:database-set-name
|
This function changes the name of the database with the
specified ID to the specified name.
|
|
admin:database-set-one-character-searches
|
This function sets the one character searches setting
for the specified database in the configuration.
|
|
admin:database-set-positions-list-max-size
|
This function sets the positions list max size setting
for the specified database in the configuration.
|
|
admin:database-set-preallocate-journals
|
This function sets the preallocate journals setting
for the specified database in the configuration.
|
|
admin:database-set-preload-mapped-data
|
This function sets the preload mapped data setting
for the specified database in the configuration.
|
|
admin:database-set-reindexer-enable
|
This function sets the reindexer enable setting
for the specified database in the configuration.
|
|
admin:database-set-reindexer-throttle
|
This function sets the reindexer throttle setting
for the specified database in the configuration.
|
|
admin:database-set-reindexer-timestamp
|
This function sets the reindexer timestamp setting
for the specified database in the configuration.
|
|
admin:database-set-schema-database
|
This function sets the schema database for a database
to the specified database in the configuration.
|
|
admin:database-set-security-database
|
This function sets the security database for a database
to the specified database in the configuration.
|
|
admin:database-set-stemmed-searches
|
This function sets the stemmed searches setting
for the specified database in the configuration.
|
|
admin:database-set-three-character-searches
|
This function sets the three character searches setting
for the specified database in the configuration.
|
|
admin:database-set-three-character-word-positions
|
This function sets the three character word positions setting
for the specified database in the configuration.
|
|
admin:database-set-trailing-wildcard-searches
|
This function sets the trailing wildcard searches setting
for the specified database in the configuration.
|
|
admin:database-set-trailing-wildcard-word-positions
|
This function sets the trailing wildcard word positions setting
for the specified database in the configuration.
|
|
admin:database-set-triggers-database
|
This function sets the triggers database to the specified
database ID for the specified database in the configuration.
|
|
admin:database-set-two-character-searches
|
This function sets the two character searches setting
for the specified database in the configuration.
|
|
admin:database-set-uri-lexicon
|
This function sets the URI lexicon setting
for the specified database in the configuration.
|
|
admin:database-set-word-positions
|
This function sets the word positions setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-fast-case-sensitive-searches
|
This function returns the word query fast case
sensitive searches setting
for the specified database from the configuration.
|
|
admin:database-set-word-query-fast-diacritic-sensitive-searches
|
This function sets the word query fast diacritic
sensitive searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-fast-phrase-searches
|
This function sets the word query fast phrase
searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-include-document-root
|
This function sets the word query include
document root setting
for the specified field in the configuration.
|
|
admin:database-set-word-query-one-character-searches
|
This function sets the word query one character
searches setting
for the specified field in the configuration.
|
|
admin:database-set-word-query-stemmed-searches
|
This function sets the word query stemmed searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-three-character-searches
|
This function sets the word query three character
searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-three-character-word-positions
|
This function sets the word query three character
word positions setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-trailing-wildcard-searches
|
This function sets the word query trailing
wildcard searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-trailing-wildcard-word-positions
|
This function sets the word query trailing wildcard
word positions setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-two-character-searches
|
This function sets the word query two character
searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-word-searches
|
This function sets the word query word searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-searches
|
This function sets the word searches setting
for the specified database in the configuration.
|
|
admin:database-weekly-backup
|
This function constructs a weekly scheduled backup.
|
|
admin:database-word-lexicon
|
This function constructs a word lexicon specification.
|
|
admin:forest-add-backup
|
This function adds scheduled backup specifications for a
forest to a configuration.
|
|
admin:forest-add-failover-host
|
This function adds a failover host to the list of failover
hosts for the specified forest in the specified
configuration.
|
|
admin:forest-copy
|
This function creates a new forest specification with the
same settings as the forest with the specified ID.
|
|
admin:forest-create
|
This function creates a new forest configuration.
|
|
admin:forest-delete
|
This function deletes the configuration for the specified
forest from the configuration.
|
|
admin:forest-delete-backup
|
This function deletes scheduled backup specifications for a
forest from a configuration.
|
|
admin:forest-delete-failover-host
|
This function deletes the specified failover host(s) from the
failover-host list in the specified configuration.
|
|
admin:forest-get-backups
|
This function returns the scheduled backups
for the specified forest from the configuration.
|
|
admin:forest-get-data-directory
|
This function returns the name of the data directory of the
specified forest.
|
|
admin:forest-get-enabled
|
This function returns the enabled state of the specified
forest.
|
|
admin:forest-get-failover-enable
|
This function returns the state of whether failover is
enabled for the specified forest.
|
|
admin:forest-get-failover-hosts
|
This function returns the forest IDs of the hosts defined
as failover hosts for this forest.
|
|
admin:forest-get-host
|
This function returns the ID of the host in which the
specified forest resides.
|
|
admin:forest-get-id
|
This function returns the ID of the forest with the specified
name, from the specified configuration.
|
|
admin:forest-get-name
|
This function returns the name(s) of the specified forest(s),
given the forest ID(s).
|
|
admin:forest-get-updates-allowed
|
This function returns the state of whether updates are allowed
for the specified forest.
|
|
admin:forest-monthly-backup
|
This function constructs a monthly scheduled backup.
|
|
admin:forest-one-time-backup
|
This function constructs a one-time backup.
|
|
admin:forest-set-enabled
|
This function sets the enabled state for a forest
configuration.
|
|
admin:forest-set-failover-enable
|
This function sets the forest failover enabled state for a
forest configuration.
|
|
admin:forest-set-host
|
This function sets a forest configuration to a new
host.
|
|
admin:forest-set-updates-allowed
|
This function sets whether updates are allowed for a
forest configuration.
|
|
admin:forest-weekly-backup
|
This function constructs a weekly scheduled backup.
|
|
admin:get-appserver-ids
|
This function returns all the appserver IDs from the configuration.
|
|
admin:get-configuration
|
Loads the admin configuration into memory for use
by other functions in the Admin module.
|
|
admin:get-database-ids
|
This function returns all the database IDs from the configuration.
|
|
admin:get-forest-ids
|
This function returns all the forest IDs from the configuration.
|
|
admin:get-group-ids
|
This function returns all the group IDs from the configuration.
|
|
admin:get-host-ids
|
This function returns all the host IDs from the configuration.
|
|
admin:group-add-namespace
|
Add one or more namespaces to a Group configuration,
which will predefine the namespace(s) for all requests
evaluated against any App Server in the Group.
|
|
admin:group-add-schema
|
This function adds a schema binding definition to the
existing schema binding definitions in the configuration
for the specified Group.
|
|
admin:group-add-trace-event
|
This function adds trace events to the configuration.
|
|
admin:group-copy
|
This function creates a new group specification with the
same settings as the group with the specified ID.
|
|
admin:group-create
|
This function creates a new group with the specified
name in the configuration.
|
|
admin:group-delete
|
This function deletes a group in the configuration.
|
|
admin:group-delete-namespace
|
This function deletes the specified namespaces from the
configuration for the specified group.
|
|
admin:group-delete-schema
|
This function deletes a schema binding definition to the
existing schema binding definitions in the configuration
for the specified Group.
|
|
admin:group-delete-trace-event
|
This function deletes the specified trace events from
the configuration.
|
|
admin:group-disable-audit-event-type
|
This function changes the audit event type(s) enabled setting
for the audit configuration.
|
|
admin:group-enable-audit-event-type
|
This function changes the audit event type(s) enabled setting
for the audit configuration.
|
|
admin:group-get-appserver-ids
|
This function returns the IDs of all appservers belonging to the group.
|
|
admin:group-get-audit-enabled
|
This function returns the value for the audit enabled
setting from the specified group.
|
|
admin:group-get-audit-event-type-enabled
|
This function returns the audit event type's enabled setting
for the audit configuration.
|
|
admin:group-get-audit-excluded-roles
|
This function returns the roles excluded from auditing.
|
|
admin:group-get-audit-excluded-uris
|
This function returns the uris excluded from auditing.
|
|
admin:group-get-audit-excluded-users
|
This function returns the users excluded from auditing.
|
|
admin:group-get-audit-included-roles
|
This function returns the roles included from auditing.
|
|
admin:group-get-audit-included-uris
|
This function returns the uris included from auditing.
|
|
admin:group-get-audit-included-users
|
This function returns the users included from auditing.
|
|
admin:group-get-audit-outcome-restriction
|
This function returns whether auditing events are restricted by a
success or failure outcome.
|
|
admin:group-get-compressed-tree-cache-partitions
|
This function returns the value for the compressed tree
cache partitions setting from the specified group.
|
|
admin:group-get-compressed-tree-cache-size
|
This function returns the value for the compressed tree
cache size setting from the specified group.
|
|
admin:group-get-expanded-tree-cache-partitions
|
This function returns the value for the expanded tree
cache partitions setting from the specified group.
|
|
admin:group-get-expanded-tree-cache-size
|
This function returns the value for the expanded tree
cache size setting from the specified group.
|
|
admin:group-get-failover-enable
|
This function returns the value for the failover enable
setting from the specified group.
|
|
admin:group-get-file-log-level
|
This function returns the value for the file log level
setting from the specified group.
|
|
admin:group-get-host-ids
|
This function returns the IDs of all hosts belonging to the group.
|
|
admin:group-get-host-initial-timeout
|
This function returns the value for the host initial timeout
setting from the specified group.
|
|
admin:group-get-host-timeout
|
This function returns the value for the host timeout
setting from the specified group.
|
|
admin:group-get-http-timeout
|
This function returns the value for the http timeout
setting from the specified group.
|
|
admin:group-get-http-user-agent
|
This function returns the value for the http user agent
setting from the specified group.
|
|
admin:group-get-httpserver-ids
|
This function returns the IDs of all httpservers belonging to the group.
|
|
admin:group-get-id
|
This function returns the ID of the group.
|
|
admin:group-get-keep-audit-files
|
This function returns the value for the keep audit files
setting from the specified group.
|
|
admin:group-get-keep-log-files
|
This function returns the value for the keep log files
setting from the specified group.
|
|
admin:group-get-list-cache-partitions
|
This function returns the value for the list cache partitions
setting from the specified group.
|
|
admin:group-get-list-cache-size
|
This function returns the value for the list cache size
setting from the specified group.
|
|
admin:group-get-name
|
This function returns the name of the specified group.
|
|
admin:group-get-namespaces
|
This function returns the value of any namespace definitions
predefined for the specified group.
|
|
admin:group-get-retry-timeout
|
This function returns the value for the number of seconds a request
will retry before timing out.
|
|
admin:group-get-rotate-audit-files
|
This function returns the value for the rotate audit files
setting from the specified group.
|
|
admin:group-get-rotate-log-files
|
This function returns the value for the rotate log files
setting from the specified group.
|
|
admin:group-get-schemas
|
This function returns the value of any schemas definitions
predefined for the specified group.
|
|
admin:group-get-smtp-relay
|
This function returns the value for the smtp relay
setting from the specified group.
|
|
admin:group-get-smtp-timeout
|
This function returns the value for the smtp timeout
setting from the specified group.
|
|
admin:group-get-system-log-level
|
This function returns the value for the system log level
setting from the specified group.
|
|
admin:group-get-taskserver-id
|
This function returns the ID of of the taskserver belonging to the group.
|
|
admin:group-get-trace-events
|
This function returns the value of any trace events
activated for the specified group.
|
|
admin:group-get-trace-events-activated
|
This function returns the value for the trace events
activated setting from the specified group.
|
|
admin:group-get-webdavserver-ids
|
This function returns the IDs of all webdavservers belonging to the group.
|
|
admin:group-get-xdbcserver-ids
|
This function returns the IDs of all xdbcservers belonging to the group.
|
|
admin:group-get-xdqp-timeout
|
This function returns the value for the xdqp timeout
setting from the specified group.
|
|
admin:group-namespace
|
This function constructs a namespace element with the
specified prefix and URI.
|
|
admin:group-schema
|
This function constructs a schema element with the
specified prefix and URI.
|
|
admin:group-set-audit-enabled
|
This function changes the audit enabled setting
for the group in the configuration.
|
|
admin:group-set-audit-outcome-restriction
|
This function restricts the audit configuration by auditing
events only if they are "success" or "failure" events.
|
|
admin:group-set-audit-role-restriction
|
This function restricts the audit configuration by excluding or
including by role.
|
|
admin:group-set-audit-uri-restriction
|
This function restricts the audit configuration by excluding or
including by document uri(s).
|
|
admin:group-set-audit-user-restriction
|
This function restricts the audit configuration by excluding or
including by user.
|
|
admin:group-set-compressed-tree-cache-partitions
|
This function changes the compressed tree cache partitions
setting of the group with the
specified ID to the specified value.
|
|
admin:group-set-compressed-tree-cache-size
|
This function changes the compressed tree cache size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-expanded-tree-cache-partitions
|
This function changes the expanded tree cache partitions
setting of the group with the
specified ID to the specified value.
|
|
admin:group-set-expanded-tree-cache-size
|
This function changes the expanded tree cache size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-failover-enable
|
This function changes the failover enable setting
for the group in the configuration.
|
|
admin:group-set-file-log-level
|
This function changes the host file log level setting
for the group in the configuration.
|
|
admin:group-set-host-initial-timeout
|
This function changes the host initial timeout setting
(the time the cluster will wait for a host to come online
during cluster startup) for the group
in the configuration.
|
|
admin:group-set-host-timeout
|
This function changes the host timeout setting (the timeout
for communication between hosts) for the group
in the configuration.
|
|
admin:group-set-http-timeout
|
This function changes the HTTP timeout setting for the group
in the configuration.
|
|
admin:group-set-http-user-agent
|
This function changes the HTTP User-Agent setting for
the group in the configuration.
|
|
admin:group-set-keep-audit-files
|
This function changes the keep audit files setting
for the group in the configuration.
|
|
admin:group-set-keep-log-files
|
This function changes the keep log files setting
for the group in the configuration.
|
|
admin:group-set-list-cache-partitions
|
This function changes the list cache partitions setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-list-cache-size
|
This function changes the list cache size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-name
|
This function changes the name of the group with the
specified ID to the specified name.
|
|
admin:group-set-retry-timeout
|
This function changes the the number of seconds a request
will retry before timing out.
|
|
admin:group-set-rotate-audit-files
|
This function changes the rotate audit files setting
for the group in the configuration.
|
|
admin:group-set-rotate-log-files
|
This function changes the rotate log files setting
for the group in the configuration.
|
|
admin:group-set-smtp-relay
|
This function changes the SMTP relay setting for the group
in the configuration.
|
|
admin:group-set-smtp-timeout
|
This function changes the SMTP timeout setting for the group
in the configuration.
|
|
admin:group-set-system-log-level
|
This function changes the host system log level setting
for the group in the configuration.
|
|
admin:group-set-trace-events-activated
|
This function changes the value for trace events in the
group configuration.
|
|
admin:group-set-xdqp-timeout
|
This function changes the XDQP timeout setting (the timeout
for communication between data nodes and evaluator nodes)
for the group in the configuration.
|
|
admin:group-trace-event
|
This function constructs an event element for the
specified event name.
|
|
admin:host-get-group
|
This function returns the group ID for the host with the
specified ID.
|
|
admin:host-get-id
|
This function return the ID for the specified host from
the configuration.
|
|
admin:host-get-name
|
This function returns the name for the host with the
specified ID.
|
|
admin:host-get-port
|
This function returns the bind port for the host with the
specified ID.
|
|
admin:host-set-group
|
This function changes the group to which an existing host
belongs to the newly specified value.
|
|
admin:host-set-name
|
This function changes the name of an existing host
to the newly specified value.
|
|
admin:host-set-port
|
This function changes the bind port value for the host
to the newly specified value.
|
|
admin:http-server-create
|
This function creates a new HTTP App Server with the
specified name, root, and port in the configuration.
|
|
admin:mimetype
|
This function constructs a mimetype specification.
|
|
admin:mimetypes-add
|
This function adds mimetypes to the configuration.
|
|
admin:mimetypes-delete
|
This function deletes mimetypes from the configuration.
|
|
admin:mimetypes-get
|
This function returns all the mimetypes from the configuration.
|
|
admin:restart-hosts
|
This function restarts MarkLogic Server for the
specified hosts.
|
|
admin:save-configuration
|
This function saves a configuration specification to
the cluster configuration files.
|
|
admin:save-configuration-without-restart
|
This function saves a configuration specification to
the cluster configuration files, without restarting MarkLogic
Server.
|
|
admin:taskserver-get-debug-allow
|
This function returns the value for the debug-allow setting
configured on the task server for the specified group.
|
|
admin:taskserver-get-debug-threads
|
This function returns the number of debug threads configured
on the task server for the specified group.
|
|
admin:taskserver-get-default-time-limit
|
This function returns the default time limit configured
on the task server for the specified group.
|
|
admin:taskserver-get-log-errors
|
This function returns the value for the log-errors setting
configured on the task server for the specified group.
|
|
admin:taskserver-get-max-time-limit
|
This function returns the maximum time limit configured
on the task server for the specified group.
|
|
admin:taskserver-get-name
|
This function returns the name of the task server for the
specified group from the configuration.
|
|
admin:taskserver-get-post-commit-trigger-depth
|
This function returns the maximum post-commit trigger
depth configured
on the task server for the specified group.
|
|
admin:taskserver-get-pre-commit-trigger-depth
|
This function returns the maximum pre-commit trigger
depth configured
on the task server for the specified group.
|
|
admin:taskserver-get-pre-commit-trigger-limit
|
This function returns the pre-commit trigger
limit configured
on the task server for the specified group.
|
|
admin:taskserver-get-profile-allow
|
This function returns the value for the profile-allow setting
configured on the task server for the specified group.
|
|
admin:taskserver-get-queue-size
|
This function returns the number queue size configured
on the task server for the specified group.
|
|
admin:taskserver-get-threads
|
This function returns the number of threads configured
on the task server for the specified group.
|
|
admin:taskserver-set-debug-allow
|
This function sets the value for the debug allow setting
for the task server in the configuration.
|
|
admin:taskserver-set-debug-threads
|
This function sets the value in the configuration of
the maximum number of debug threads for the specified
task server.
|
|
admin:taskserver-set-default-time-limit
|
This function sets the task server default time limit in the
configuration.
|
|
admin:taskserver-set-log-errors
|
This function sets the value for the log errors setting
for the task server in the configuration.
|
|
admin:taskserver-set-max-time-limit
|
This function sets the task server max time limit in the
configuration.
|
|
admin:taskserver-set-post-commit-trigger-depth
|
This function sets the value for the task server post-commit
trigger depth in the configuration.
|
|
admin:taskserver-set-pre-commit-trigger-depth
|
This function sets the value for the task server pre-commit
trigger depth in the configuration.
|
|
admin:taskserver-set-pre-commit-trigger-limit
|
This function sets the value for the task server pre-commit
trigger depth in the configuration.
|
|
admin:taskserver-set-profile-allow
|
This function sets the value for the profile allow setting
for the task server in the configuration.
|
|
admin:taskserver-set-queue-size
|
This function sets the value in the configuration of
the maximum queue size for the specified
task server.
|
|
admin:taskserver-set-threads
|
This function sets the value in the configuration of
the maximum number of threads for the specified task server.
|
|
admin:webdav-server-create
|
This function creates a new WebDAV App Server with the
specified name, library, and port in the configuration.
|
|
admin:xdbc-server-create
|
This function creates a new XDBC App Server with the
specified name, root, and port in the configuration.
|
|
alert:action-get-description
|
This function returns the description of
a given action.
|
|
alert:action-get-module
|
This function returns the module of a
given action.
|
|
alert:action-get-module-db
|
This function returns the module database
of a given action.
|
|
alert:action-get-module-root
|
This function returns the module root of a
given action.
|
|
alert:action-get-name
|
This function returns the name of a
given action.
|
|
alert:action-get-options
|
This function returns the options of a
given action.
|
|
alert:action-insert
|
This function inserts the xml representing the action
into the collection.
|
|
alert:action-remove
|
This function removes the named action from the
database or throws an exception if the action does
not exist.
|
|
alert:action-set-description
|
This function returns the action with the
description of the action updated.
|
|
alert:action-set-module
|
This function returns the action with the
module of the action updated.
|
|
alert:action-set-module-db
|
This function sets the module database of a given action.
|
|
alert:action-set-module-root
|
This function sets the module root of a
given action.
|
|
alert:action-set-name
|
This function returns the action with the name of
the action updated.
|
|
alert:action-set-options
|
This function returns the action with the
options of the action updated.
|
|
alert:config-delete
|
Remove an alerting configuration identified by the
specified URI.
|
|
alert:config-get
|
Gets the config associated with the specified URI.
|
|
alert:config-get-cpf-domain-ids
|
This function provides convenient access to
the specified sub-element within an alerting config.
|
|
alert:config-get-cpf-domain-names
|
This function provides convenient access
to the specified sub-element within an alerting config.
|
|
alert:config-get-description
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:config-get-id
|
This function provides convenient
access to the specified sub-element within an
alerting config.
|
|
alert:config-get-name
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:config-get-options
|
This function provides convenient access to
the specified sub-element within an alerting config.
|
|
alert:config-get-trigger-ids
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:config-get-uri
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:config-insert
|
Inserts a config into the database.
|
|
alert:config-set-cpf-domain-ids
|
This function provides convenient access
to the specified sub-element within an alerting config.
|
|
alert:config-set-cpf-domain-names
|
This function provides convenient access to the
specified sub-element within an alerting
config.
|
|
alert:config-set-description
|
This function provides convenient access to the
specified sub-element within an alerting config.
|
|
alert:config-set-name
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:config-set-options
|
This function provides convenient access to
the specified sub-element within an alerting config.
|
|
alert:config-set-trigger-ids
|
This function provides convenient access to
the specified sub-element within an alerting config.
|
|
alert:config-set-uri
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:config-set-uri
|
This function provides convenient access to the specified sub-element within an alerting config.
|
|
alert:create-triggers
|
Create triggers that invoke the standard alerting
trigger module.
|
|
alert:find-matching-rules
|
Returns a list of all rules associated with
the specified config that match the specified document.
|
|
alert:get-actions
|
This function retrieves all the named
actions in the specified config URI.
|
|
alert:get-all-rules
|
This function returns all rules visible to the
current user.
|
|
alert:get-my-rules
|
This function returns all rules associated with the
current user.
|
|
alert:invoke-matching-actions
|
Finds the rules that match the specified document
and invokes their associated actions.
|
|
alert:make-action
|
This function creates the xml representing an action.
|
|
alert:make-config
|
Create an alerting configuration associated with a
particular URI.
|
|
alert:make-log-action
|
Create a standard logging action named "log".
|
|
alert:make-rule
|
This function creates the XML representing a rule.
|
|
alert:remove-triggers
|
Remove triggers whose IDs are listed in the config.
|
|
alert:rule-action-query
|
This function creates a query to find rules
with any of the specified actions.
|
|
alert:rule-get-action
|
This function returns the action of a
given rule.
|
|
alert:rule-get-description
|
This function returns the description of a given rule.
|
|
alert:rule-get-id
|
This function returns the ID of a
given rule.
|
|
alert:rule-get-name
|
This function returns the name of a given rule.
|
|
alert:rule-get-options
|
This function returns the options of a
given rule.
|
|
alert:rule-get-query
|
Get the cts:query corresponding to
the rule's query expression.
|
|
alert:rule-get-user-id
|
This function returns the user ID
of a given rule.
|
|
alert:rule-id-query
|
This function creates a query to find rules
with any of the specified IDs.
|
|
alert:rule-insert
|
This function inserts rule into the database associated with the specified alerting configuration.
|
|
alert:rule-name-query
|
This function creates a query to find rules
with any of the specified names.
|
|
alert:rule-remove
|
This function removes the XML representing the
rule from the collection.
|
|
alert:rule-set-action
|
This function returns the rule with the action updated.
|
|
alert:rule-set-description
|
This function returns the rule with the
description of the rule updated.
|
|
alert:rule-set-name
|
This function returns the rule with the name of the rule updated.
|
|
alert:rule-set-options
|
This function returns the rule with the
options of the rule updated.
|
|
alert:rule-set-query
|
Set the cts:query corresponding to the rule's query expression.
|
|
alert:rule-set-user-id
|
This function returns the rule with the user ID
updated.
|
|
alert:rule-user-id-query
|
This function creates a query to find rules
with any of the specified user IDs.
|
|
alert:spawn-matching-actions
|
Finds the rules that match the specified
document and spawns their associated actions.
|
|
cpf:check-transition
|
Verify that the current transition is the correct one for the
document.
|
|
cpf:document-get-error
|
Fetch a trace of the error that caused the document's processing to fail, if
any.
|
|
cpf:document-get-last-updated
|
Determine the date and time of the last update to the document's content, if
any.
|
|
cpf:document-get-processing-status
|
Determine the document's current processing status, if any.
|
|
cpf:document-get-state
|
Determine the document's current state, if any.
|
|
cpf:document-set-error
|
Set the document's error trace to the given value.
|
|
cpf:document-set-last-updated
|
Set the date and time of the document's last update.
|
|
cpf:document-set-processing-status
|
Set the document's processing status to the given value.
|
|
cpf:document-set-state
|
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.
|
|
css:convert
|
Convert CSS text to an equivalent XML representation that is more suitable
for analysis.
|
|
css:get
|
Fetch the CSS for the given document, be it embedded or linked.
|
|
cts:and-not-query
|
Returns a query specifying the set difference of
the matches specified by two sub-queries.
|
|
|
Returns the negative (second parameter) query used to construct the
specified query.
|
|
|
Returns the positive (first parameter) query used to construct the
specified query.
|
|
cts:and-query
|
Returns a query specifying the intersection
of the matches specified by the sub-queries.
|
|
|
Returns the options for the specified query.
|
|
|
Returns a sequence of the queries that were used to construct the specified
query.
|
|
cts:box
|
Returns a geospatial box value.
|
|
cts:box-east
|
Returns a box's eastern boundary.
|
|
cts:box-north
|
Returns a box's northern boundary.
|
|
cts:box-south
|
Returns a box's southern boundary.
|
|
cts:box-west
|
Returns a box's western boundary.
|
|
cts:circle
|
Returns a geospatial circle value.
|
|
cts:circle-center
|
Returns a circle's center point.
|
|
cts:circle-radius
|
Returns a circle's radius.
|
|
cts:classify
|
Classifies a sequence of nodes based on training data.
|
|
cts:collection-match
|
Returns values from the collection lexicon
that match the specified wildcard pattern.
|
|
cts:collection-query
|
Returns a query matching documents in the collections with the given URIs.
|
|
|
Returns the URIs used to construct the specified query.
|
|
cts:collections
|
Returns values from the collection lexicon.
|
|
cts:confidence
|
Returns the confidence of a node,
or of the context node if no node is provided.
|
|
cts:contains
|
Returns true if any of a sequence of nodes matches a query.
|
|
cts:deregister
|
Deregister a registered query, explicitly releasing the associated
resources.
|
|
cts:directory-query
|
Returns a query matching documents in the directories with the given URIs.
|
|
|
Returns the depth used to construct the specified query.
|
|
|
Returns the URIs used to construct the specified query.
|
|
cts:distance
|
Returns the distance (in miles) between two points.
|
|
cts:document-query
|
Returns a query matching documents with the given URIs.
|
|
|
Returns the URIs used to construct the specified query.
|
|
cts:element-attribute-pair-geospatial-boxes
|
Returns boxes derived from the specified element point lexicon(s).
|
|
cts:element-attribute-pair-geospatial-query
|
Returns a cts: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.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the geographical regions with which the specified query was constructed.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-pair-geospatial-value-match
|
Returns values from the specified element attribute pair geospatial value
lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-attribute-pair-geospatial-values
|
Returns values from the specified element-attribute-pair geospatial value lexicon(s).
|
|
cts:element-attribute-range-query
|
Returns a cts:query matching elements by name with a
range-index entry equal a given value.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the operator used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the value used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-value-co-occurrences
|
Returns value co-occurrences from the specified element or element-attribute
value lexicon(s).
|
|
cts:element-attribute-value-geospatial-co-occurrences
|
Returns value co-occurrences from the specified element-attribute
value lexicon with the specified geospatial lexicon.
|
|
cts:element-attribute-value-match
|
Returns values from the specified element-attribute value lexicon(s)
that match the specified pattern.
|
|
cts:element-attribute-value-query
|
Returns a query matching elements by name with attributes by name
with text content equal a given phrase.
|
|
|
Returns the attribute QNames used to construct the specified query.
|
|
|
Returns the element QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-value-ranges
|
Returns value ranges from the specified element-attribute value lexicon(s).
|
|
cts:element-attribute-values
|
Returns values from the specified element-attribute value lexicon(s).
|
|
cts:element-attribute-word-match
|
Returns words from the specified element-attribute word lexicon(s) that
match a wildcard pattern.
|
|
cts:element-attribute-word-query
|
Returns a query matching elements by name
with attributes by name
with text content containing a given phrase.
|
|
|
Returns the attribute QNames used to construct the specified query.
|
|
|
Returns the element QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-attribute-words
|
Returns words from the specified element-attribute word lexicon(s).
|
|
cts:element-child-geospatial-boxes
|
Returns boxes derived from the specified element point lexicon(s).
|
|
cts:element-child-geospatial-query
|
Returns a cts: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.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the geographical regions with which the specified query was constructed.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-child-geospatial-value-match
|
Returns values from the specified element child geospatial value lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-child-geospatial-values
|
Returns values from the specified element-child geospatial value lexicon(s).
|
|
cts:element-geospatial-boxes
|
Returns boxes derived from the specified element point lexicon(s).
|
|
cts:element-geospatial-query
|
Returns a cts: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.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the geographical regions
with which the specified query was constructed.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-geospatial-value-match
|
Returns values from the specified element geospatial value lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-geospatial-values
|
Returns values from the specified element geospatial value lexicon(s).
|
|
cts:element-pair-geospatial-boxes
|
Returns boxes derived from the specified element point lexicon(s).
|
|
cts:element-pair-geospatial-query
|
Returns a cts: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.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the geographical regions with which the specified query was constructed.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-pair-geospatial-value-match
|
Returns values from the specified element pair geospatial value lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-pair-geospatial-values
|
Returns values from the specified element-pair geospatial value lexicon(s).
|
|
cts:element-query
|
Returns a cts:query matching elements by name
with the content constrained by the given cts:query in the
second parameter.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the query used to construct the element query.
|
|
cts:element-range-query
|
Returns a cts:query matching elements by name with a
range-index entry equal a given value.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the operator used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the value used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-value-co-occurrences
|
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:element-value-geospatial-co-occurrences
|
Returns value co-occurrences from the specified element
value lexicon with the specified geospatial lexicon.
|
|
cts:element-value-match
|
Returns values from the specified element value lexicon(s)
that match the specified wildcard pattern.
|
|
cts:element-value-query
|
Returns a query matching elements by name with text content equal a
given phrase.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-value-ranges
|
Returns value ranges from the specified element value lexicon(s).
|
|
cts:element-values
|
Returns values from the specified element value lexicon(s).
|
|
cts:element-word-match
|
Returns words from the specified element word lexicon(s) that match
a wildcard pattern.
|
|
cts:element-word-query
|
Returns a query matching elements by name with text content containing
a given phrase.
|
|
|
Returns the QNames used to construct the specified query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:element-words
|
Returns words from the specified element word lexicon.
|
|
cts:entity-highlight
|
Returns a copy of the node, replacing any entities found
with the specified expression.
|
|
cts:field-word-match
|
Returns words from the specified field word lexicon(s) that match
a wildcard pattern.
|
|
cts:field-word-query
|
Returns a query matching text content containing a given phrase in the
specified field.
|
|
|
Returns the names used to construct the specified
cts:field-word-query.
|
|
|
Returns the options for the specified
cts:field-word-query.
|
|
|
Returns the text used to construct the specified
cts:field-word-query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:field-words
|
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:frequency
|
Returns an integer representing the number of times in which a particular
value occurs in a value lexicon lookup (for example,
cts:element-values).
|
|
cts:geospatial-co-occurrences
|
Returns value co-occurrences from the geospatial lexicons.
|
|
cts:highlight
|
Returns a copy of the node, replacing any text matching the query
with the specified expression.
|
|
cts:near-query
|
Returns a query matching all of the specified queries, where
the matches occur within the specified distance from each other.
|
|
|
Returns the distance used to construct the near query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the query sequence used to construct the near query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:not-query
|
Returns a query specifying the matches not specified by its sub-query.
|
|
|
Returns the query used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:or-query
|
Returns a query specifying the union
of the matches specified by the sub-queries.
|
|
|
Returns a sequence of the queries that were used to construct the specified
query.
|
|
cts:point
|
Returns a point value.
|
|
cts:point-latitude
|
Returns a point's latitude value.
|
|
cts:point-longitude
|
Returns a point's longitude value.
|
|
cts:polygon
|
Returns a geospatial polygon value.
|
|
cts:polygon-vertices
|
Returns a polygon's vertices.
|
|
cts:quality
|
Returns the quality of a node,
or of the context node if no node is provided.
|
|
cts:query
|
Creates a query.
|
|
cts:register
|
Register a query for later use.
|
|
cts:registered-query
|
Returns a query matching fragments specified by previously registered
queries (see cts:register).
|
|
|
Returns the registered query identifiers used to construct the specified
query.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:remainder
|
Returns an estimated search result size for a node,
or of the context node if no node is provided.
|
|
cts:reverse-query
|
Returns a query matching the model nodes.
|
|
|
Returns the nodes used to construct the specified query.
|
|
|
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:search
|
Returns a relevance-ordered sequence of nodes specified by a given query.
|
|
cts:similar-query
|
Returns a query matching nodes similar to the model nodes.
|
|
|
Returns the nodes used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:stem
|
Returns the stem(s) for a word.
|
|
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:train
|
Produces a set of classifiers from a list of
labeled training documents.
|
|
cts:uri-match
|
Returns values from the URI lexicon
that match the specified wildcard pattern.
|
|
cts:uris
|
Returns values from the URI lexicon.
|
|
cts:word-match
|
Returns words from the word lexicon that match the wildcard pattern.
|
|
cts:word-query
|
Returns a query matching text content containing a given phrase.
|
|
|
Returns the options for the specified query.
|
|
|
Returns the text used to construct the specified query.
|
|
|
Returns the weight with which the specified query was constructed.
|
|
cts:words
|
Returns words from the word lexicon.
|
|
cvt:basename
|
Return the filename part of the URI, cutting off any query strings or
fragments.
|
|
cvt:basepath
|
Return the base path of the URI, cutting off the filename.
|
|
cvt:destination-uri
|
Construct the destination URI from the source URI using the following
rules:
The path prefix of the destination URI is the same as the source URI's.
|
|
cvt:part-uri
|
Construct the URI for the part using the following rules:
The path prefix of the part URI is the same source URI's, followed by
a subdirectory name.
|
|
cvt:save-converted-documents
|
Save a set of converted documents, with appropriate links.
|
|
dbg:attach
|
Attach to a request and stop it for debugging.
|
|
dbg:attached
|
Return the request ID's of attached requests in a given server.
|
|
dbg:break
|
Set a breakpoint at the given expression ID.
|
|
dbg:breakpoints
|
Returns a sequence of expression ID's representing existing
breakpoints for the given request.
|
|
dbg:clear
|
Clear a breakpoint at the given expression ID.
|
|
dbg:connect
|
Connect to a Server (http, xdbc, or task) for debugging.
|
|
dbg:continue
|
Continue evaluation of the request.
|
|
dbg:detach
|
Detach from a stopped request.
|
|
dbg:disconnect
|
End the debugging of a server.
|
|
dbg:eval
|
Evaluate a string as an XQuery for debugging.
|
|
dbg:expr
|
Returns a description/representation of a given expression.
|
|
dbg:finish
|
Continue evaluation of the request until the end of the
current function.
|
|
dbg:function
|
Returns the expression ID representing the function
defined in a module with a given name.
|
|
dbg:invoke
|
Invoke a module for debugging.
|
|
dbg:line
|
Returns a sequence of expression ID's found on a given line of a
stopped request.
|
|
dbg:next
|
Continue evaluation of the request until the beginning or end
of an expression that is not a descendant of the current expression.
|
|
dbg:out
|
Continue evaluation of the request until the end of the
current expression.
|
|
dbg:stack
|
Return the stack trace for a given request.
|
|
dbg:status
|
Return the debugging status of given requests.
|
|
dbg:step
|
Continue evaluation of the request until the beginning or end
of an expression.
|
|
dbg:stop
|
Placing this call in XQuery will instruct the evaluator to stop
a request for debugging.
|
|
dbg:stopped
|
Return the request ID's of stopped requests in a given server.
|
|
dbg:value
|
Evaluate an expression in the context of the identified stopped request.
|
|
dbg:wait
|
Wait until at least one of the given requests stops or all
complete evaluating.
|
|
dbk:convert
|
Convert XHTML to DocBook lite vocabulary, if possible.
|
|
dom:add-permissions
|
Add permissions to the domain.
|
|
dom:add-pipeline
|
Add another pipeline to the set of pipelines bound to the domain.
|
|
dom:collection
|
Return the name of the collection in which domains are stored.
|
|
dom:configuration-create
|
Create a new CPF configuration.
|
|
dom:configuration-get
|
Returns the CPF configuration.
|
|
dom:configuration-set-default-domain
|
Set a new default domain for the CPF configuration.
|
|
dom:configuration-set-evaluation-context
|
Set a new context for the CPF configuration.
|
|
dom:configuration-set-permissions
|
Set new permissions for the CPF configuration.
|
|
dom:configuration-set-restart-user
|
Set a new restart user for the CPF configuration.
|
|
dom:create
|
Create a new content processing domain, along with the
triggers that perform work in that domain.
|
|
dom:domain-scope
|
Create a domain scope element.
|
|
dom:domains
|
Return all the domains.
|
|
dom:evaluation-context
|
Create an evaluation context element.
|
|
dom:get
|
Find a particular domain.
|
|
dom:remove
|
Remove the domain and any associated triggers.
|
|
dom:remove-permissions
|
Remove permissions to the domain.
|
|
dom:remove-pipeline
|
Remove the association between a pipeline and the domain.
|
|
dom:set-description
|
Set the description of the domain.
|
|
dom:set-domain-scope
|
Set the scope of the domain.
|
|
dom:set-evaluation-context
|
Set the evaluation context of the domain.
|
|
dom:set-name
|
Set the name of the domain to something else.
|
|
dom:set-permissions
|
Set the permissions of the domain.
|
|
dom:set-pipelines
|
Bind a new set of pipelines to the domain.
|
|
entity:enrich
|
Returns the entity-enriched XML for the given XML node.
|
|
excel:clean
|
Clean up any conversion artifacts or other infelicities, putting each
sheet into its own div element.
|
|
fn:abs
|
Returns the absolute value of $arg.
|
|
fn:adjust-date-to-timezone
|
Adjusts an xs:date value to a specific timezone, or to no timezone at
all.
|
|
fn:adjust-dateTime-to-timezone
|
Adjusts an xs:dateTime value to a specific timezone, or to no
timezone at all.
|
|
fn:adjust-time-to-timezone
|
Adjusts an xs:time value to a specific timezone, or to no timezone at
all.
|
|
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:base-uri
|
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:codepoint-equal
|
Returns true if the specified parameters are the same Unicode
code point, otherwise returns false.
|
|
fn:codepoints-to-string
|
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:current-date
|
Returns xs:date(fn:current-dateTime()).
|
|
fn:current-dateTime
|
Returns the current dateTime value (with timezone) from the dynamic context.
|
|
fn:current-time
|
Returns xs:time(fn:current-dateTime()).
|
|
fn:data
|
Takes a sequence of items and returns a sequence of atomic values.
|
|
fn:day-from-date
|
Returns an xs:integer between 1 and 31, both inclusive, representing the day
component in the localized value of $arg.
|
|
fn:day-from-dateTime
|
Returns an xs:integer between 1 and 31, both inclusive, representing the day
component in the localized value of $arg.
|
|
fn:days-from-duration
|
Returns an xs:integer representing the days component in the canonical
lexical representation of the value of $arg.
|
|
fn:deep-equal
|
This function assesses whether two sequences are deep-equal to each other.
|
|
fn:default-collation
|
Returns the value of the default collation property from the static context.
|
|
fn:distinct-nodes
|
[0.9-ml only] Returns the sequence resulting from removing from the input
sequence all but one of a set of nodes that have the same identity as one
another.
|
|
fn:distinct-values
|
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:doc-available
|
If fn:doc($uri) returns a document node, this function returns true.
|
|
fn:document-uri
|
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:encode-for-uri
|
Invertible function that escapes characters required to be escaped
inside path segments of URIs.
|
|
fn:ends-with
|
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:escape-html-uri
|
%-escapes everything except printable ASCII characters.
|
|
fn:escape-uri
|
This is a May 2003 function, and is only available in compatibility mode
(XQuery 0.9-ML)--it has been replaced with fn:encode-for-uri,
fn:iri-to-uri, and fn:escape-html-uri.
|
|
fn:exactly-one
|
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:expanded-QName
|
[0.9-ml only, use fn:QName instead]
Returns an
xs:QName with the namespace URI given in $paramURI and
the local name in $paramLocal.
|
|
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:hours-from-dateTime
|
Returns an xs:integer between 0 and 23, both inclusive, representing the
hours component in the localized value of $arg.
|
|
fn:hours-from-duration
|
Returns an xs:integer representing the hours component in the canonical
lexical representation of the value of $arg.
|
|
fn:hours-from-time
|
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:implicit-timezone
|
Returns the value of the implicit timezone property from the dynamic context.
|
|
fn:in-scope-prefixes
|
Returns the prefixes of the in-scope namespaces for $element.
|
|
fn:index-of
|
Returns a sequence of positive integers giving the positions within the
sequence $seqParam of items that are equal to $srchParam.
|
|
fn:insert-before
|
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:iri-to-uri
|
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:last
|
Returns the context size from the dynamic context.
|
|
fn:local-name
|
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:local-name-from-QName
|
Returns an xs:NCName representing the local part of
$arg.
|
|
fn:lower-case
|
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:minutes-from-dateTime
|
Returns an xs:integer value between 0 and 59, both inclusive,
representing the minute component in the localized value of $arg.
|
|
fn:minutes-from-duration
|
Returns an xs:integer representing the minutes component in the canonical
lexical representation of the value of $arg.
|
|
fn:minutes-from-time
|
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:month-from-date
|
Returns an xs:integer between 1 and 12, both inclusive, representing the
month component in the localized value of $arg.
|
|
fn:month-from-dateTime
|
Returns an xs:integer between 1 and 12, both inclusive, representing the
month component in the localized value of $arg.
|
|
fn:months-from-duration
|
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:namespace-uri
|
Returns the namespace URI of the xs:QName of $arg.
|
|
fn:namespace-uri-for-prefix
|
Returns the namespace URI of one of the in-scope namespaces for $element,
identified by its namespace prefix.
|
|
fn:namespace-uri-from-QName
|
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:node-kind
|
[0.9-ml only, use xdmp:node-kind in 1.0 and 1.0-ml]
Returns an xs:string representing the node's kind: either
"document", "element", "attribute", "text", "namespace",
"processing-instruction", "binary", or "comment".
|
|
fn:node-name
|
Returns an expanded-QName for node kinds that can have names.
|
|
fn:normalize-space
|
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:normalize-unicode
|
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:one-or-more
|
Returns $arg if it contains one or more items.
|
|
fn:position
|
Returns the context position from the dynamic context.
|
|
fn:prefix-from-QName
|
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:resolve-QName
|
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:resolve-uri
|
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:round-half-to-even
|
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:seconds-from-dateTime
|
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:seconds-from-duration
|
Returns an xs:decimal representing the seconds component in the canonical
lexical representation of the value of $arg.
|
|
fn:seconds-from-time
|
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:starts-with
|
Returns true if the first parameter starts with the string
from the second parameter, otherwise returns false.
|
|
fn:static-base-uri
|
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:string-join
|
Returns an xs:string created by concatenating the members of
the $parameter1 sequence using $parameter2 as a separator.
|
|
fn:string-length
|
Returns an integer representing the length of the specified string.
|
|
fn:string-pad
|
[0.9-ml only] Returns a string representing the $padString
concatenated with itself the number of times specifed in $padCount.
|
|
fn:string-to-codepoints
|
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:substring-after
|
Returns the substring created by taking all of the input characters
that occur after the specified $after characters.
|
|
fn:substring-before
|
Returns the substring created by taking all of the input characters
that occur before the specified $before characters.
|
|
fn:subtract-dateTimes-yielding-dayTimeDuration
|
[0.9-ml only, use the minus operator ( - ) instead] Returns the
xdt:dayTimeDuration that corresponds to the difference between
the normalized value of $srcval1 and the normalized value of $srcval2.
|
|
fn:subtract-dateTimes-yielding-yearMonthDuration
|
[0.9-ml only, use the minus operator ( - ) instead] Returns the
xdt:yearMonthDuration hat corresponds to the difference between
the normalized value of $srcval1 and the normalized value of $srcval2.
|
|
fn:sum
|
Returns a value obtained by adding together the values in $arg.
|
|
fn:timezone-from-date
|
Returns the timezone component of $arg if any.
|
|
fn:timezone-from-dateTime
|
Returns the timezone component of $arg if any.
|
|
fn:timezone-from-time
|
Returns the timezone component of $arg if any.
|
|
fn:tokenize
|
Returns a sequence of strings contructed 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, emit that server event to the server log
file (ErrorLog.txt) with $value as its data.
|
|
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:unordered
|
Returns the items of $sourceSeq in an implementation dependent order.
|
|
fn:upper-case
|
Returns the specified string converting all of the characters to upper-case
characters.
|
|
fn:year-from-date
|
Returns an xs:integer representing the year component in the localized value
of $arg.
|
|
fn:year-from-dateTime
|
Returns an xs:integer representing the year component in the localized value
of $arg.
|
|
fn:years-from-duration
|
Returns an xs:integer representing the years component in the
canonical lexical representation of the value of $arg.
|
|
fn:zero-or-one
|
Returns $arg if it contains zero or one items.
|
|
geo:box
|
Create a cts:point value from an element representing a box in one of the
supported markup vocabularies.
|
|
geo:circle
|
Create a cts:circle value from a radius and an element representing a point
in one of the supported markup vocabularies.
|
|
geo:geospatial-query
|
Returns a cts:query matching points within given regions.
|
|
geo:geospatial-query-from-elements
|
Returns a cts:query matching points within given regions.
|
|
geo:interior-polygon
|
Create a sequence of cts:polygon values from a polygon element
in one of the supported markup vocabularies.
|
|
geo:point
|
Create a cts:point value from an element representing a point in one of
the supported markup vocabularies.
|
|
geo:polygon
|
Create a cts:polygon value from a sequence of point elements
in one of the supported markup vocabularies.
|
|
geo:polygon
|
Create a cts:polygon value from a polygon element
in one of the supported markup vocabularies.
|
|
georss:circle
|
Create a cts:circle value from a radius and GeoRSS point element.
|
|
georss:geospatial-query
|
Returns a cts:query matching points within given regions.
|
|
georss:point
|
Create a cts:point value from a GeoRSS point element.
|
|
gml:box
|
Create a cts:box value from a GML Envelope element.
|
|
gml:circle
|
Create a cts:circle value from a radius and GML Point
element.
|
|
gml:geospatial-query
|
Returns a cts:query matching points within given regions.
|
|
gml:geospatial-query-from-elements
|
Returns a cts:query matching points within given
regions.
|
|
gml:interior-polygon
|
Create a sequence of cts:polygon values from a
GML Polygon element.
|
|
gml:point
|
Create a cts:point value from a GML Point element.
|
|
gml:polygon
|
Create a cts:polygon value from a sequence of GML
Point elements.
|
|
gml:polygon
|
Create a cts:polygon value from a GML Polygon
element.
|
|
kml:box
|
Create a cts:point value from a KML LatLongBox element.
|
|
kml:circle
|
Create a cts:circle value from a radius and KML Point or Location element.
|
|
kml:geospatial-query
|
Returns a cts:query matching points within given regions.
|
|
kml:geospatial-query-from-elements
|
Returns a cts:query matching points within given regions.
|
|
kml:interior-polygon
|
Create a sequence of cts:polygon values from a KML Polygon element.
|
|
kml:point
|
Create a cts:point value from a KML Point or Location element.
|
|
kml:polygon
|
Create a cts:polygon value from a sequence of KML Point or Location elements.
|
|
kml:polygon
|
Create a cts:polygon value from a KML Polygon element.
|
|
lnk:create
|
Create a link between the two given documents with the given role labels
and strength.
|
|
lnk:from
|
Find and return all the links from the given document to some other.
|
|
lnk:get
|
Find and return the link between the two documents, if any.
|
|
lnk:insert
|
Insert the given link.
|
|
lnk:remove
|
Remove the link between the two given documents and return the removed link.
|
|
lnk:to
|
Find and return all the links to the given document from some other.
|
|
map:clear
|
Clear a map.
|
|
map:count
|
Returns the number of entries used in the map.
|
|
map:delete
|
Delete a value from a map.
|
|
map:get
|
Get a value from a map.
|
|
map:keys
|
Get the keys used in the map.
|
|
map:map
|
Creates a map.
|
|
map:put
|
Put a value into a map at the given key.
|
|
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 apropriate quadrant.
|
|
math:ceil
|
Returns the smallest integer greater than or equal to x.
|
|
math:cos
|
Returns the cosine of x,
in the range from -1 to +1 (inclusive).
|
|
math:cosh
|
Returns the hyperbolic cosine of x.
|
|
math:exp
|
Returns e 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:log
|
Returns the base-e logarithm of x.
|
|
math:log10
|
Returns the base-10 logarithm of x.
|
|
math:modf
|
Returns x broken up into fraction and integer.
|
|
math:pow
|
Returns x^y.
|
|
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:tan
|
Returns the tangent of x.
|
|
math:tanh
|
Returns the hyperbolic tangent of x,
in the range from -1 to +1 (inclusive).
|
|
mcgm:circle
|
Create a cts:circle value from a radius and MCGM Dot element.
|
|
mcgm:geospatial-query
|
Returns a cts:query matching points within given regions.
|
|
mcgm:geospatial-query-from-elements
|
Returns a cts:query matching points within given regions.
|
|
mcgm:point
|
Create a cts:point value from a MCGM Dot element.
|
|
mcgm:polygon
|
Create a cts:polygon value from a sequence of MCGM Dot elements.
|
|
msword:clean
|
Clean up any conversion artifacts or other infelicities.
|
|
ooxml:package-parts
|
This function returns the documents within the
zip package.
|
|
ooxml:package-parts-insert
|
This function inserts one document in the database
for each part at the specified URI.
|
|
ooxml:package-uris
|
This function returns the list of files in the
zip package.
|
|
ooxml:runs-merge
|
This function updates document or paragraph node(s)
(from a Word 2007 document) so that all similar runs are
merged, retaining formatting, and removing text split
across elements.
|
|
p:action
|
Construct an action element.
|
|
p:collection
|
Return the name of the collection in which pipelines are stored.
|
|
p:condition
|
Construct a condition element.
|
|
p:create
|
Create a new content processing pipeline.
|
|
p:execute
|
Construct a execute element.
|
|
p:get
|
Find a particular pipeline.
|
|
p:get-by-id
|
Find a particular pipeline.
|
|
p:insert
|
Insert a fully constructed content processing pipeline,
returning its unique id.
|
|
p:pipelines
|
Return all the pipelines.
|
|
p:remove
|
Remove the named pipeline.
|
|
p:state-transition
|
Construct a new state transition element.
|
|
p:status-transition
|
Construct a new status transition element.
|
|
pdf:clean
|
Clean up any conversion artifacts or other infelicities.
|
|
pdf:get-toc
|
Fetch the linked TOC, if any.
|
|
pdf:insert-toc-headers
|
Locate TOC anchors and make them properly refer to headers at the appropriate
level.
|
|
pdf:make-toc
|
Clean and normalize the TOC produced by raw conversion.
|
|
ppt:clean
|
Clean up any conversion artifacts or other infelicities, putting each
slide into its own div element.
|
|
prof:allowed
|
Returns the value of the Profile Allow setting for the
App Server or Task Server upon which the target request
is running.
|
|
prof:disable
|
Disable profiling for this request.
|
|
prof:enable
|
Enable profiling for this request.
|
|
prof:eval
|
Evaluate a string as an XQuery for profiling.
|
|
prof:invoke
|
Profiles and returns the result of evaluating a module at the given path.
|
|
prof:report
|
Return a prof:report node containing the current state of
profiling statistics for the given request.
|
|
prof:reset
|
Clear any accumulated profiling statistics for the requests.
|
|
prof:value
|
Evaluate an expression in the context of the current evaluating
statement and return the profiling report for its evaluation.
|
|
sec:amp-add-roles
|
Adds the roles ($role-names) to the list of roles granted to the amp
($namespace, $local-name, $document-uri).
|
|
sec:amp-doc-collections
|
Returns a sequence of strings corresponding to the collection uri's that
amps belong to.
|
|
sec:amp-doc-permissions
|
Returns a sequence of permission elements that all newly created amp
documents receive.
|
|
sec:amp-get-roles
|
Returns a sequence of role names for the roles directly assigned to the
amp ($namespace, $local-name, $document-uri).
|
|
sec:amp-remove-roles
|
Removes a role ($role-name) from the set of roles included by the amp
($namespace, $local-name, $document-uri).
|
|
sec:amp-set-roles
|
Assigns the amp identified by $namespace, $local-name and $document-uri
to have the roles identified by $roles-names.
|
|
sec:amps-collection
|
Returns a string corresponding to the uri for the amps collection.
|
|
sec:check-admin
|
Throws an error if the current user does not have the admin role.
|
|
sec:collection-add-permissions
|
Add the permissions $permissions to the protected collection identified
by $uri.
|
|
sec:collection-get-permissions
|
Returns a sequence of permission elements corresponding to the
current permissions granted to the protected collection identified
by $uri.
|
|
sec:collection-remove-permissions
|
Removes the permissions $permissions from the protected collection
identified by $uri.
|
|
sec:collection-set-permissions
|
Sets the permissions of a protected collection identified by $uri to
$permissions.
|
|
sec:collections-collection
|
Returns a string corresponding to the uri for the protected
collections collection.
|
|
sec:create-amp
|
Creates a new amp in the system database for the context
database.
|
|
sec:create-privilege
|
Creates a new privilege and returns the new privilege-id.
|
|
sec:create-role
|
Creates a new role in the system database for the context
database.
|
|
sec:create-user
|
Creates a new user in the system database for the context database.
|
|
sec:create-user-with-role
|
Creates a new user in the system database for the context database.
|
|
sec:get-amp
|
Returns an sec:amp element corresponding to an amp identified by
($namespace, $local-name, $document-uri).
|
|
sec:get-collection
|
Gets the security document corresponding to a protected collection with
uri equal to $uri.
|
|
sec:get-distinct-permissions
|
Returns a sequence of permission elements made up of a concatenation of
$output-perms and the distinct permission elements of $input-perms.
|
|
sec:get-privilege
|
Returns a sec:privilege element corresponding to a privilege identified
by ($action,$kind).
|
|
sec:get-role-ids
|
Returns sequence of unique sec:role-id's that corresponds to the
sequence of role names $role-names.
|
|
sec:get-role-names
|
Returns sequence of unique sec:role-name's that corresponds to the
sequence of role IDs $role-ids.
|
|
sec:get-unique-elem-id
|
Returns a unique id for a given security element, $elem.
|
|
sec:get-user-names
|
Returns sequence of unique sec:user-name's that corresponds to the
sequence of user IDs $user-ids.
|
|
sec:priv-doc-collections
|
Returns a sequence of strings corresponding to the collection uri's that
privileges belong to.
|
|
sec:priv-doc-permissions
|
Returns a sequence of permission elements that all newly created privilege
documents receive.
|
|
sec:privilege-add-roles
|
Adds the roles ($role-names) to the list of roles assigned to the
privilege ($action,$kind).
|
|
sec:privilege-get-roles
|
Returns a sequence of role names for the roles assigned to the
privilege ($action,$kind).
|
|
sec:privilege-remove-roles
|
Removes roles ($role-names) from the roles assigned to the privilege
($action,$kind).
|
|
sec:privilege-set-name
|
Changes the sec:privilege-name of a sec:privilege to
$new-privilege-name.
|
|
sec:privilege-set-roles
|
Assigns the privilege ($action,$kind) to have the roles identified by
$role-names.
|
|
sec:privileges-collection
|
Returns a string corresponding to the uri for the privileges collection.
|
|
sec:protect-collection
|
Protects a collection $uri with the given permissions
($permissions).
|
|
sec:remove-amp
|
Removes the amp ($namespace, $local-name, $document-uri, $database) and returns
true after completion.
|
|
sec:remove-privilege
|
Removes the privilege identified by ($action,$kind).
|
|
sec:remove-role
|
Removes the role ($role-name).
|
|
sec:remove-role-from-amps
|
Removes references to the role ($role-name) from all amps.
|
|
sec:remove-role-from-privileges
|
Removes references to the role ($role-name) from all privileges.
|
|
sec:remove-role-from-role
|
Removes references to the role ($role-name) from other roles.
|
|
sec:remove-role-from-users
|
Removes references to the role ($role-name) from all users.
|
|
sec:remove-user
|
Removes the user with name $user-name.
|
|
sec:role-add-roles
|
Adds the roles ($new-roles) to the set of roles included by the role
($role-name).
|
|
sec:role-doc-collections
|
Returns a sequence of strings corresponding to the collection uri's that
roles belong to.
|
|
sec:role-doc-permissions
|
Returns a sequence of permission elements that all newly created role
documents receive.
|
|
sec:role-get-default-collections
|
Returns a sequence of strings correspondinig to the uri's of the role's
default collections.
|
|
sec:role-get-default-permissions
|
Returns a sequence of permission elements correspondinig to the role's
default permissions.
|
|
sec:role-get-description
|
Returns the description for the specified role.
|
|
sec:role-get-roles
|
Returns a sequence of role names for the roles directly assigned to
the given role ($role-name).
|
|
sec:role-privileges
|
Returns a set of privilege elements corresponding to all privileges
that a role has.
|
|
sec:role-remove-roles
|
Removes the roles ($role-names) from the set of roles included by the
role ($role-name).
|
|
sec:role-set-default-collections
|
Sets the default collections of a role with name $role-name to
$collections.
|
|
sec:role-set-default-permissions
|
Sets the default permissions for a role with name $role-name.
|
|
sec:role-set-description
|
Changes the description of the role identified by $role-name to $description.
|
|
sec:role-set-name
|
Changes the sec:role-name of a role from $role-name to
$new-role-name.
|
|
sec:role-set-roles
|
Assigns roles (named $role-names) to be the set of included roles for the
role ($role-name).
|
|
sec:roles-collection
|
Returns a string corresponding to the uri for the roles collection.
|
|
sec:security-collection
|
Returns a string corresponding to the uri for the Security collection.
|
|
sec:security-installed
|
Returns fn:true() if security has been installed on the
current database.
|
|
sec:security-namespace
|
Returns a string corresponding to the uri of the security namespace.
|
|
sec:security-version
|
Returns the current version of the security database.
|
|
sec:set-realm
|
Changes the realm of this security database to $realm.
|
|
sec:uid-for-name
|
Returns the uids for the named user or () if no such user exists.
|
|
sec:unprotect-collection
|
Removes the protection of a collection $uri.
|
|
sec:user-add-roles
|
Adds the roles ($role-names) to the list of roles granted to the
user ($user-name).
|
|
sec:user-doc-collections
|
Returns a sequence of strings corresponding to the collection uri's that
users belong to.
|
|
sec:user-doc-permissions
|
Returns a sequence of permission elements that all newly created user
documents receive.
|
|
sec:user-get-default-collections
|
Returns a sequence of strings correspondinig to the uri's of the user's
default collections.
|
|
sec:user-get-default-permissions
|
Returns a sequence of permission elements correspondinig to the user's
default permissions.
|
|
sec:user-get-description
|
Returns the user's description.
|
|
sec:user-get-roles
|
Returns a sequence of role names for the roles directly assigned to the
user ($user-name).
|
|
sec:user-privileges
|
Returns a set of privilege elements corresponding to all privileges
that a user has.
|
|
sec:user-remove-roles
|
Removes the roles ($role-names) from the list of roles granted to the
user ($user-name).
|
|
sec:user-set-default-collections
|
Sets the default collections of a user with name $user-name to
$collections.
|
|
sec:user-set-default-permissions
|
Sets the default permissions for a user with name $user-name.
|
|
sec:user-set-description
|
Changes the description of the user identified by $user-name to
$description.
|
|
sec:user-set-name
|
Changes the name of the user from $user-name to $new-user-name.
|
|
sec:user-set-password
|
Changes the password for the user identified by $user-name to $password.
|
|
sec:user-set-roles
|
Assigns the user with name $user-name to have the roles identified by
$role-names.
|
|
sec:users-collection
|
Returns a string corresponding to the uri for the users collection.
|
|
spell:add-word
|
Add the word $word to the dictionary at $uri.
|
|
spell:insert
|
Load the words in $dict into the dictionary at $uri.
|
|
spell:is-correct
|
Returns true() if the specified word is spelled correctly,
otherwise returns false().
|
|
spell:load
|
Add the words from the file specified in $path to the dictionary at $uri.
|
|
spell:remove-word
|
Remove the word $word from the dictionary at $uri.
|
|
spell:suggest
|
Suggests a list of spellings for a word.
|
|
thsr:add-synonym
|
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:query-lookup
|
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:remove-entry
|
Removes all entries that exactly match $entry from the thesaurus
documents(s) at $uri.
|
|
thsr:remove-synonym
|
Removes synonym $synonym from thesaurus entry $entry.
|
|
thsr:remove-term
|
Removes all entries with term $term from the thesaurus document(s) at $uri.
|
|
thsr:set-entry
|
Adds the entry $entry to the thesaurus at $uri.
|
|
trgr:any-property-content
|
Returns the representation of an all-properties part to a triggering event.
|
|
trgr:collection-scope
|
Returns the representation of a collection scope.
|
|
trgr:create-trigger
|
Creates a new trigger in the context database.
|
|
trgr:directory-scope
|
Returns the representation of a directory scope.
|
|
trgr:document-content
|
Returns the representation of a document part to a triggering event.
|
|
trgr:document-scope
|
Returns the representation of a document scope.
|
|
trgr:get-trigger
|
Returns the xml representation of the trigger named $trigger-name.
|
|
trgr:get-trigger-by-id
|
Returns the xml representation of the trigger that has a trigger-id of $trigger-id.
|
|
trgr:post-commit
|
Returns the representation of a post-commit trigger timing.
|
|
trgr:pre-commit
|
Returns the representation of a pre-commit trigger timing.
|
|
trgr:property-content
|
Returns the representation of a property part to a triggering event.
|
|
trgr:remove-trigger
|
Remove the trigger named $trigger-name.
|
|
trgr:trigger-add-permissions
|
Add $permissions to the set of permissions on the trigger named $trigger.
|
|
trgr:trigger-data-event
|
Returns the representation of a triggering event.
|
|
trgr:trigger-database-online-event
|
Returns the representation of a database coming online event.
|
|
trgr:trigger-disable
|
Disable the trigger named $trigger-name.
|
|
trgr:trigger-enable
|
Enable the trigger named $trigger-name.
|
|
trgr:trigger-get-permissions
|
Get the set of permissions of the trigger named $trigger-name.
|
|
trgr:trigger-module
|
Returns the representation of a trigger module invocation.
|
|
trgr:trigger-remove-permissions
|
Remove $permissions from the set of permissions on the trigger named
$trigger-name.
|
|
trgr:trigger-set-description
|
Sets the description of the trigger nameds $trigger-name to $description.
|
|
trgr:trigger-set-event
|
Assigned the trigger named $trigger-name the new triggering event defined in $event.
|
|
trgr:trigger-set-module
|
Assigned the trigger named $trigger-name the new execution module defined in $module.
|
|
trgr:trigger-set-name
|
Changes the name of the trigger from $user-name to $new-user-name.
|
|
trgr:trigger-set-permissions
|
Set the permissions on the trigger to the new set of permissions in $permissions.
|
|
trgr:trigger-set-recursive
|
Sets the recursive setting of the identified trigger.
|
|
xdmp:access
|
Returns whether a given action on the specified document URI would succeed.
|
|
xdmp:add-response-header
|
Adds an HTTP response header field.
|
|
xdmp:add64
|
Add two 64-bit integer values, discarding overflow.
|
|
xdmp:amp
|
Returns the amp ID for the specified amp.
|
|
xdmp:amp-roles
|
Returns the set of all roles assigned to an amp, including roles directly
assigned to the amp and roles inherited by other roles.
|
|
xdmp:architecture
|
Returns the hardware architecture upon which MarkLogic Server is running.
|
|
xdmp:base64-decode
|
Converts base64-encoded string to plaintext.
|
|
xdmp:base64-encode
|
Converts plaintext into base64-encoded string.
|
|
xdmp:can-grant-roles
|
Tests whether a user can grant or revoke a set of roles.
|
|
xdmp:castable-as
|
Returns true if a value is castable.
|
|
xdmp:collation-canonical-uri
|
Returns the canonical URI for the given URI, if it represents a
valid collation.
|
|
xdmp:collection-delete
|
Deletes from the database every document in a collection.
|
|
xdmp:collection-locks
|
Returns locks of documents in a collection.
|
|
xdmp:collection-properties
|
Returns a sequence of properties documents, one for each document in the
specified collection(s) that has a corresponding properties document.
|
|
xdmp:database
|
Returns the the ID of the database named in the the parameter.
|
|
xdmp:database-backup
|
Starts an asynchronous backup of the specified list of forests to the
backup data directory.
|
|
xdmp:database-backup-cancel
|
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:database-backup-purge
|
Purge old backups from a directory.
|
|
xdmp:database-backup-status
|
Checks the status of the outstanding backup job with the specified
job ID.
|
|
xdmp:database-backup-validate
|
Validates that the specified list of forests can be backed up to the
backup data directory.
|
|
xdmp:database-forests
|
Returns a sequence of forest IDs in the specified database.
|
|
xdmp:database-name
|
Return the name of the database with the given ID.
|
|
xdmp:database-restore
|
Starts an asynchronous restore of the specified list of forests from the
backup data directory.
|
|
xdmp:database-restore-cancel
|
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:database-restore-status
|
Checks the status of the outstanding restore job with the specified
job ID.
|
|
xdmp:database-restore-validate
|
Validates that the specified list of 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:default-collections
|
Returns the collections any new document would get if the current user
were to insert a document without specifying the collections.
|
|
xdmp:default-permissions
|
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:diacritic-less
|
Returns the specified string, converting all of the characters with diacritics
to characters without diacritics.
|
|
xdmp:directory
|
Returns the documents in a directory.
|
|
xdmp:directory-create
|
Creates a directory.
|
|
xdmp:directory-delete
|
Deletes a directory and its children from the database.
|
|
xdmp:directory-locks
|
Returns locks of documents in a directory.
|
|
xdmp:directory-properties
|
Returns a sequence of properties documents, one for each document in
the specified directory that has a corresponding properties document.
|
|
xdmp:document-add-collections
|
Adds the named document to the given collections.
|
|
xdmp:document-add-permissions
|
Adds the given permissions to the given document or directory.
|
|
xdmp:document-add-properties
|
Adds a sequence of properties to the properties of a document.
|
|
xdmp:document-delete
|
Deletes a document from the database.
|
|
xdmp:document-forest
|
Returns the forest ID of the forest in which a document (or a lock or a
property) with the specified URI is stored.
|
|
xdmp:document-get
|
Returns the document in the file specified by $location.
|
|
xdmp:document-get-collections
|
Returns the collections to which a given document belongs.
|
|
xdmp:document-get-permissions
|
Returns the permissions to a given document.
|
|
xdmp:document-get-properties
|
Returns the property values for a document's property.
|
|
xdmp:document-get-quality
|
Returns the quality of the specified document if the document exists.
|
|
xdmp:document-insert
|
Inserts a new document into the database if a document with the
specified URI does not already exist.
|
|
xdmp:document-load
|
Inserts a new document with the specified URI.
|
|
xdmp:document-locks
|
Returns the locks for one or more documents or directories.
|
|
xdmp:document-properties
|
Returns a sequence of properties documents, one for each of the specified
documents that has a corresponding properties document.
|
|
xdmp:document-remove-collections
|
Removes the named document from the given collections.
|
|
xdmp:document-remove-permissions
|
Removes the given permissions from the named document or directory.
|
|
xdmp:document-remove-properties
|
Removes a sequence of properties from the properties of a document.
|
|
xdmp:document-set-collections
|
Sets the named document to belong to the given collections, replacing any
previously set collections on the named document.
|
|
xdmp:document-set-permissions
|
Sets the permissions on the named document (or directory) to the given
permissions, replacing any permissions previously set on the
document (or directory).
|
|
xdmp:document-set-properties
|
Sets the properties of a document to the given sequence of elements,
replacing any properties that already exist on the document.
|
|
xdmp:document-set-property
|
Sets a property on a document.
|
|
xdmp:document-set-quality
|
Sets the quality of the document with the given URI.
|
|
xdmp:email
|
Send an email in an XQuery program.
|
|
xdmp:estimate
|
Returns the number of fragments selected by an expression.
|
|
xdmp:eval
|
Returns the result of evaluating a string
as an XQuery module.
|
|
xdmp:eval-in
|
[DEPRECATED: use xdmp:eval with the
database option instead] Returns the result of evaluating a string as
an XQuery module in a given database.
|
|
xdmp:excel-convert
|
Converts a Microsoft Excel document to XHTML.
|
|
xdmp:exists
|
Returns true if any fragment is selected by an expression, false if no
fragments are selected.
|
|
xdmp:filesystem-directory
|
Performs a directory listing of the given file pathname.
|
|
xdmp:filesystem-file
|
Reads a file from the filesystem.
|
|
xdmp:forest
|
Returns the the ID of the forest specified as the parameter.
|
|
xdmp:forest-backup
|
Backs up forest data files.
|
|
xdmp:forest-clear
|
Clears forest data files.
|
|
xdmp:forest-counts
|
Returns detailed forest statistics for a given forest.
|
|
xdmp:forest-databases
|
Returns the database ID corresponding to the database to which
the specified forest belongs.
|
|
xdmp:forest-name
|
Return the name of the forest with the given id.
|
|
xdmp:forest-restart
|
Restarts a forest.
|
|
xdmp:forest-restore
|
Restores forest data files.
|
|
xdmp:forest-status
|
Returns the status of a forest.
|
|
xdmp:forests
|
Returns a sequence of the IDs of all the forests in the system.
|
|
xdmp:get
|
[DEPRECATED: use xdmp:document-get
instead] Returns the document in the XML file specified by $path.
|
|
xdmp:get-current-roles
|
Returns all the current roles, both assigned and inherited by the
current user and any received from amps.
|
|
xdmp:get-current-user
|
Returns the name of the current user.
|
|
xdmp:get-request-body
|
Returns the POST or PUT body of this request, if it is not
application/x-www-form-urlencoded.
|
|
xdmp:get-request-client-address
|
Returns as a string the internet address of the
client from which the HTTP server request is issued.
|
|
xdmp:get-request-field
|
Returns the value of a named request field.
|
|
xdmp:get-request-field-content-type
|
This function is used to extract the content type from the request field.
|
|
xdmp:get-request-field-filename
|
Returns a list of filenames from a multipart request for the field name
specified.
|
|
xdmp:get-request-field-names
|
Returns a sequence of the request field names.
|
|
xdmp:get-request-header
|
Returns the value of a named request header.
|
|
xdmp:get-request-header-names
|
Returns a sequence of request header names.
|
|
xdmp:get-request-method
|
Returns the HTTP request method.
|
|
xdmp:get-request-path
|
Returns the HTTP request path.
|
|
xdmp:get-request-user
|
Returns the id of the current user.
|
|
xdmp:get-request-username
|
Returns the username from the Authorization header of
this App Server request.
|
|
xdmp:get-response-code
|
Returns two nodes, the first containing the HTTP response code and the
second containing the HTTP response message.
|
|
xdmp:get-response-encoding
|
Returns the encoding that the response from this server is in.
|
|
xdmp:get-session-field
|
Returns the value of a named HTTP session field.
|
|
xdmp:get-session-field-names
|
Returns a sequence of the HTTP session field names.
|
|
xdmp:group
|
Returns the the ID of the group specified in the parameter.
|
|
xdmp:group-hosts
|
Returns the IDs of all hosts belonging to the group with the given ID.
|
|
xdmp:group-name
|
Returns the the name of the group with the given ID.
|
|
xdmp:group-servers
|
Returns the the IDs of all 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:has-privilege
|
Tests whether the current user has at least one of a given set of privileges.
|
|
xdmp:hash32
|
Returns the 32-bit hash of a string.
|
|
xdmp:hash64
|
Returns the 64-bit hash of a string.
|
|
xdmp:hex-to-integer
|
Parses a hexadecimal string, returning an integer.
|
|
xdmp:host
|
Returns the the ID of the host named in the parameter.
|
|
xdmp:host-name
|
Returns the the name of the host ID specified as the parameter.
|
|
xdmp:host-status
|
Returns the status of a host.
|
|
xdmp:hosts
|
Returns a sequence of the IDs of all the hosts in the system.
|
|
xdmp:http-delete
|
Sends an http DELETE request to the http server specified in the URI
to delete the specified resource.
|
|
xdmp:http-get
|
Sends the http GET method to the specified URI.
|
|
xdmp:http-head
|
Sends the http HEAD method to the specified URI.
|
|
xdmp:http-options
|
Sends the http OPTIONS method to the specified URI.
|
|
xdmp:http-post
|
Sends the http POST request to the server.
|
|
xdmp:http-put
|
Sends an HTTP PUT request to an HTTP server.
|
|
xdmp:integer-to-hex
|
Returns a hexadecimal representation of an integer.
|
|
xdmp:integer-to-octal
|
Returns an octal representation of an integer.
|
|
xdmp:invoke
|
Returns the result of evaluating a module at the given path.
|
|
xdmp:invoke-in
|
[DEPRECATED: use xdmp:invoke with the
database option instead] Returns the result of evaluating a module
at the given path.
|
|
xdmp:load
|
[DEPRECATED: use xdmp:document-load
instead]
Inserts a new document from the XML file at $path if a document
with the specified URI does not already exist.
|
|
xdmp:lock-acquire
|
Acquire a lock on a document or directory for an extended amount of time.
|
|
xdmp:lock-release
|
Unlock a document or directory.
|
|
xdmp:log
|
Logs a debug message to the log file
<install_dir>/Logs/ErrorLog.txt.
|
|
xdmp:log-level
|
Retrieves the current server log level.
|
|
xdmp:login
|
Logs in a user on an application server that is using
application-level authentication and deposits a session cookie.
|
|
xdmp:logout
|
Sets the current user to the default user defined in
application-level authentication.
|
|
xdmp:md5
|
Calculates the md5 hash of the given argument.
|
|
xdmp:merge
|
Starts merging the forests of the database, subject to specified
options.
|
|
xdmp:merge-cancel
|
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:modules-database
|
Returns the database ID of the modules database.
|
|
xdmp:modules-root
|
Returns the current root path for modules.
|
|
xdmp:mul64
|
Muliply two 64-bit integer values, discarding overflow.
|
|
xdmp:node-database
|
Returns the database id where the parameter is stored.
|
|
xdmp:node-delete
|
Deletes a node from the database.
|
|
xdmp:node-insert-after
|
Adds an immediately following sibling to a node.
|
|
xdmp:node-insert-before
|
Adds an immediately preceding sibling to a node.
|
|
xdmp:node-insert-child
|
Adds a new last child to a node.
|
|
xdmp:node-kind
|
Returns an xs:string representing the node's kind: either
"document", "element", "attribute", "text", "namespace",
"processing-instruction", "binary", or "comment".
|
|
xdmp:node-replace
|
Replaces a node.
|
|
xdmp:node-uri
|
Returns the document-uri property of the parameter or its ancestor.
|
|
xdmp:octal-to-integer
|
Parses an octal string, returning an integer.
|
|
xdmp:path
|
Returns a string whose value corresponds to the
path of the node.
|
|
xdmp:pdf-convert
|
Converts a PDF file to XHTML.
|
|
xdmp:permission
|
Returns a permission element in the security namespace corresponding
to the named role and capability given.
|
|
xdmp:platform
|
Returns the operating-system platform upon which MarkLogic Server is running
("solaris", "winnt", or "linux").
|
|
xdmp:powerpoint-convert
|
Converts a Microsoft Powerpoint document to XHTML.
|
|
xdmp:privilege
|
Returns the privilege ID for the specified privilege name.
|
|
xdmp:privilege-roles
|
Returns the set of all roles that have a given privilege.
|
|
xdmp:product-edition
|
Returns the current Mark Logic product edition.
|
|
xdmp:query-meters
|
Returns the current value of the resource meters for this
query sequence.
|
|
xdmp:query-trace
|
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:redirect-response
|
Redirects the App Server response to a given location.
|
|
xdmp:request
|
Returns the unique key of the current request.
|
|
xdmp:request-cancel
|
Cancel the request with the given host, server, and request IDs.
|
|
xdmp:request-status
|
Returns the status of a running request.
|
|
xdmp:request-timestamp
|
Returns the system timestamp for this request if the request is a query
statement.
|
|
xdmp:restart
|
Restart servers on hosts.
|
|
xdmp:rethrow
|
Rethrow the currently caught error.
|
|
xdmp:role
|
Returns the role ID for the specified role name.
|
|
xdmp:role-roles
|
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:save
|
Serializes a node as text and saves it to a file.
|
|
xdmp:schema-database
|
Returns the database ID of the schema database
associated with the current database.
|
|
xdmp:security-assert
|
Tests whether the current user has at least one of a given set of privileges.
|
|
xdmp:security-database
|
Returns the database ID of the security database
associated with the current database.
|
|
xdmp:server
|
Returns the the ID(s) of the App Server specified in the parameter.
|
|
xdmp:server-name
|
Return the name of the App Server with the given ID.
|
|
xdmp:server-status
|
Returns the status of an app-server on a host.
|
|
xdmp:servers
|
Returns a sequence of the IDs of all the App Servers in the system.
|
|
xdmp:set
|
Set the value of a variable to the specified expression.
|
|
xdmp:set-request-time-limit
|
Changes the time limit for an actively running request to the specified
value.
|
|
xdmp:set-response-code
|
Sets the response code and message.
|
|
xdmp:set-response-content-type
|
Sets the response content-type.
|
|
xdmp:set-response-encoding
|
Sets the response encoding.
|
|
xdmp:set-session-field
|
Sets the value of a named HTTP session field.
|
|
xdmp:shutdown
|
Shutdown servers on hosts.
|
|
xdmp:sleep
|
Delays for a specific amount of time.
|
|
xdmp:spawn
|
Place the specified module on the task queue for evaluation.
|
|
xdmp:spawn-in
|
[DEPRECATED: use xdmp:spawn with the
database option instead] Place the specified module on the task
queue for evaluation.
|
|
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:trace
|
Signal a trace event.
|
|
xdmp:triggers-database
|
Returns the database ID of the triggers database
associated with the current database.
|
|
xdmp:unpath
|
Evaluate a string as an XPath and return the corresponding node(s).
|
|
xdmp:unquote
|
Parses a string as XML, returning one or more document nodes.
|
|
xdmp:uri-content-type
|
Returns the content type of the given URI as matched in the mimetypes
configuration.
|
|
xdmp:uri-format
|
Returns the format of the given URI as matched in the mimetypes
configuration.
|
|
xdmp:uri-is-file
|
Returns true if a given URI refers to a
file which exists on the current application server.
|
|
xdmp:url-decode
|
Converts URL-encoded string to plaintext.
|
|
xdmp:url-encode
|
Converts plaintext into URL-encoded string.
|
|
xdmp:user
|
Returns the user ID for the specified user name.
|
|
xdmp:user-last-login
|
Returns the last-login node for the specified user ID.
|
|
xdmp:user-roles
|
Returns all roles assigned to a user, including roles directly assigned
to the user and roles inherited by other roles.
|
|
xdmp:value
|
Evaluate an expression in the context of the current evaluating statement.
|
|
xdmp:version
|
Returns the current MarkLogic Server version.
|
|
xdmp:with-namespaces
|
Evaluates the expression in the context of a specific set of namespace
bindings.
|
|
xdmp:word-convert
|
Converts a Microsoft Word document to XHTML.
|
|
xdmp:xquery-version
|
Returns the XQuery language version of the calling module.
|
|
xdmp:zip-create
|
Create a zip file from a list of nodes.
|
|
xdmp:zip-get
|
Get a named file from a zip document.
|
|
xdmp:zip-manifest
|
Return a manifest for this zip file.
|
|
xhtml:add-lists
|
Infer numbered or bulleted lists and insert appropriate markup.
|
|
xhtml:clean
|
Clean up the XHTML: pruning empty spans, consolidating adjacent spans, etc.
|
|
xhtml:restructure
|
Turn an XHTML with flat structure into one with div structure based on
the header elements.
|
|
xinc:link-expand
|
This function performs a single level expansion of a single XInclude reference.
|
|
xinc:link-references
|
This function returns a list of all the distinct URIs of documents referenced (either directly or indirectly) in the expansion of the node.
|
|
xinc:node-expand
|
This function recursively examines the node for XInclude references and expands them, following the rules of the XInclude specification.
|
|
xp:dereference
|
This function resolves an XPointer in the context of a particular node.
|