|
Function Summary
|
|
admin:appserver-add-namespace
|
Add one or more namespaces to an App Server configuration,
which will predefine the namespace(s) for all requests
evaluated against the App Server.
|
|
admin:appserver-add-request-blackout
|
This function adds a request blackout specification for a
appserver to a configuration.
|
|
admin:appserver-add-schema
|
This function adds a schema binding definition to the
existing schema binding definitions in the configuration
for the specified App Server.
|
|
admin:appserver-copy
|
This function creates a new App Server specification with the
same settings as the App Server with the specified ID.
|
|
admin:appserver-delete
|
This function deletes one or more App Servers in the configuration.
|
|
admin:appserver-delete-namespace
|
This function deletes a namespace configuration from the
configuration for the specified App Server.
|
|
admin:appserver-delete-request-blackout
|
This function deletes a request blackout specification for a
appserver from a configuration.
|
|
admin:appserver-delete-schema
|
This function deletes a schema definition in the
configuration for the specified App Server.
|
|
admin:appserver-get-address
|
This function returns the IP address of the App Server
configuration.
|
|
admin:appserver-get-authentication
|
This function returns the authentication scheme
(basic, digest, digestbasic, or application-level)
configured for the specified App Server.
|
|
admin:appserver-get-backlog
|
This function returns the socket listen backlog setting
for the specified App Server.
|
|
admin:appserver-get-collation
|
This function returns the collation URI set in the
configuration for the specified App Server.
|
|
admin:appserver-get-compute-content-length
|
This function returns the value of whether the WebDAV server
computes content length.
|
|
admin:appserver-get-concurrent-request-limit
|
This function returns the concurrent request limit for
any user for the specified App Server.
|
|
admin:appserver-get-database
|
This function returns the ID of the database to which the
App Server is set to execute queries against for the
specified database.
|
|
admin:appserver-get-debug-allow
|
This function returns the value of debug allow setting
configured for this App Server, where true indicates that
the App Server will allow queries to be debugged, and false
indicates that it will not.
|
|
admin:appserver-get-default-time-limit
|
This function returns the default time limit value configured
for the specified App Server.
|
|
admin:appserver-get-default-user
|
This function returns the default user value configured
for the specified App Server.
|
|
admin:appserver-get-default-xquery-version
|
This function returns the value of the default xquery
version configured for the specified App Server.
|
|
admin:appserver-get-display-last-login
|
This function returns the value of the whether or not the
appserver should display users' last login information.
|
|
admin:appserver-get-enabled
|
This function returns the enabled state for the specified
App Server.
|
|
admin:appserver-get-error-handler
|
This function returns the path to the error handler
configured for this App Server.
|
|
admin:appserver-get-group-id
|
This function returns the ID of the specified
App Server's group.
|
|
admin:appserver-get-host-ids
|
This function returns the ID(s) of the hosts the specified
App Server's is currently running on.
|
|
admin:appserver-get-id
|
This function returns the ID of the specified App Server.
|
|
admin:appserver-get-keep-alive-timeout
|
This function returns the keep alive timeout value
configured for the specified App Server.
|
|
admin:appserver-get-last-login
|
This function returns the ID of the database to which the
App Server stores users' last login information.
|
|
admin:appserver-get-log-errors
|
This function returns the value of the log errors setting
configured for this App Server, where true indicates that
the App Server will send uncaught exceptions to the
ErrorLog.txt file, and false indicates that
it will not.
|
|
admin:appserver-get-max-time-limit
|
This function returns the max time limit value configured
for the specified App Server.
|
|
admin:appserver-get-modules-database
|
This function returns the ID of the database set as the
modules database for the specified database.
|
|
admin:appserver-get-name
|
This function returns the name of the appserver with the
specified ID.
|
|
admin:appserver-get-namespaces
|
This function returns the value of any namespace definitions
predefined for the specified App Server.
|
|
admin:appserver-get-output-encoding
|
This function returns the value for the output encoding
setting for the specified App Server.
|
|
admin:appserver-get-output-sgml-character-entities
|
This function returns the value for the
output sgml character entities setting for the
specified App Server.
|
|
admin:appserver-get-port
|
This function returns the port for the specified App Server.
|
|
admin:appserver-get-pre-commit-trigger-depth
|
This function returns the pre commit trigger depth value
configured for the specified App Server.
|
|
admin:appserver-get-pre-commit-trigger-limit
|
This function returns the pre commit trigger limit value
configured for the specified App Server.
|
|
admin:appserver-get-privilege
|
This function returns the privilege ID for the
specified App Server.
|
|
admin:appserver-get-profile-allow
|
This function returns the value of the profile allow setting
configured for this App Server, where true indicates that
the App Server will allow queries to be profiled, and false
indicates that it will not.
|
|
admin:appserver-get-request-blackouts
|
This function returns the request blackouts specification
for the specified appserver from the configuration.
|
|
admin:appserver-get-request-timeout
|
This function returns the request timeout value configured
for the specified App Server.
|
|
admin:appserver-get-root
|
This function returns the root for the specified App Server.
|
|
admin:appserver-get-schemas
|
This function returns the value of any schemas definitions
predefined for the specified App Server.
|
|
admin:appserver-get-session-timeout
|
This function returns the session timeout value
configured for the specified App Server.
|
|
admin:appserver-get-ssl-allow-sslv3
|
This function returns true if the SSL v3 protocol is enabled for the specified App
Server, or false if SSL v3 is disabled.
|
|
admin:appserver-get-ssl-allow-tls
|
This function returns true if the TLS protocol is enabled for the specified App
Server, or false if TLS is disabled.
|
|
admin:appserver-get-ssl-certificate-template
|
This function returns the id of the SSL certificate template used
by the specified App Server.
|
|
admin:appserver-get-ssl-ciphers
|
This function returns the SSL ciphers set for the App Server.
|
|
admin:appserver-get-ssl-client-certificate-authorities
|
This function returns the id(s) of the client certificate authority for the
specified App Server.
|
|
admin:appserver-get-ssl-hostname
|
This function returns the SSL hostname for the specified App
Server.
|
|
admin:appserver-get-ssl-require-client-certificate
|
This function returns true if a client certificate is required for the specified
App Server.
|
|
admin:appserver-get-static-expires
|
This function returns the value of the "expires" HTTP header for static content
to expire after this many seconds port for the specified App Server.
|
|
admin:appserver-get-threads
|
This function returns the maximum number of threads
configured for the specified App Server.
|
|
admin:appserver-get-type
|
This function returns the type of appserver with the
specified ID.
|
|
admin:appserver-get-url-rewriter
|
This function returns the path to the URL rewriter
configured for this App Server.
|
|
admin:appserver-one-time-request-blackout
|
This function constructs a one-time request-blackout
specification.
|
|
admin:appserver-recurring-request-blackout
|
This function constructs a request-blackout specification.
|
|
admin:appserver-set-address
|
This function changes the IP Address in the configuration for
the specified App Server to the specified address.
|
|
admin:appserver-set-authentication
|
This function sets the authentication scheme in the
configuration for the specified App Server.
|
|
admin:appserver-set-backlog
|
This function sets the value in the configuration of
the backlog (the maximum number of pending connections
allowed on the HTTP socket) for the specified App Server.
|
|
admin:appserver-set-collation
|
This function sets the default collation in the
configuration for the specified App Server.
|
|
admin:appserver-set-compute-content-length
|
This function changes the value whether a WebDAV server computes
content length.
|
|
admin:appserver-set-concurrent-request-limit
|
This function sets the limit on concurrent requests that
any user may have on a particular appserver.
|
|
admin:appserver-set-database
|
This function sets the value in the configuration of
the database for the specified App Server.
|
|
admin:appserver-set-debug-allow
|
This function sets the debug allow setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-default-time-limit
|
This function sets the default time limit (the maximum total amount
of time to service a request before the App Server throws a
timeout exception) in the configuration for the specified
App Server.
|
|
admin:appserver-set-default-user
|
This function sets the default user (for use with
application-level authentication) in the configuration
for the specified App Server.
|
|
admin:appserver-set-default-xquery-version
|
This function sets the default XQuery version setting
in the configuration for this App Server.
|
|
admin:appserver-set-display-last-login
|
This function sets the display last login setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-enabled
|
This function sets the enabled state in the configuration
for the specified App Server.
|
|
admin:appserver-set-error-handler
|
This function sets the value of the path to the error
handler in the configuration for the specified App Server.
|
|
admin:appserver-set-keep-alive-timeout
|
This function sets the keep-alive timeout (the maximum
number of second for subsequent socket requests to time
out) in the configuration for the specified App Server.
|
|
admin:appserver-set-last-login
|
This function sets the value in the configuration of
the last login database for the specified App Server.
|
|
admin:appserver-set-log-errors
|
This function sets the log errors setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-max-time-limit
|
This function sets the max time limit (the maximum total amount
of time to service a request before the App Server throws a
timeout exception) in the configuration for the specified
App Server.
|
|
admin:appserver-set-modules-database
|
This function sets the value in the configuration of
modules database for the specified App Server to the
specified database ID.
|
|
admin:appserver-set-name
|
This function changes the name of an existing App Server
to the newly specified value.
|
|
admin:appserver-set-output-encoding
|
This function sets the value for the default output encoding
in the configuration for the specified App Server.
|
|
admin:appserver-set-output-sgml-character-entities
|
This function sets the SGML character entity output
setting in the configuration for the specified App Server.
|
|
admin:appserver-set-port
|
This function changes the port in the configuration for
the specified App Server to the specified number.
|
|
admin:appserver-set-pre-commit-trigger-depth
|
This function sets the maximum depth (how many triggers can
cause other triggers to fire, which in turn cause others
to fire, and so on) in the configuration for the specifed
App Server.
|
|
admin:appserver-set-pre-commit-trigger-limit
|
This function sets the value in the configuration
for the maximum number of
pre-commit triggers a single statement can invoke
for the specified App Server.
|
|
admin:appserver-set-privilege
|
This function sets an execute privilege in the configuration
for the specified App Server.
|
|
admin:appserver-set-profile-allow
|
This function sets the profile allow setting in the
configuration for the specified App Server.
|
|
admin:appserver-set-request-timeout
|
This function sets the value of the socket request
timeout (the number of seconds before the socket times
out) in the configuration for the specified App Server.
|
|
admin:appserver-set-root
|
This function changes the root for a specified App Server
to the newly specified value.
|
|
admin:appserver-set-session-timeout
|
This function sets the session timeout value (in seconds)
in the configuration for the specified App Server.
|
|
admin:appserver-set-ssl-allow-sslv3
|
This function enables or disables the SSL v3 protocol for the specified App
Server.
|
|
admin:appserver-set-ssl-allow-tls
|
This function enables or disables the TLS protocol for the specified App
Server.
|
|
admin:appserver-set-ssl-certificate-template
|
This function sets an SSL certificate template for the
specified App Server.
|
|
admin:appserver-set-ssl-ciphers
|
This function sets SSL ciphers for the specified App Server.
|
|
admin:appserver-set-ssl-client-certificate-authorities
|
This function sets one or more client certificate authorities that sign
client certificates for the specified App Server.
|
|
admin:appserver-set-ssl-hostname
|
This function sets an SSL hostname for the specified App Server.
|
|
admin:appserver-set-ssl-require-client-certificate
|
This function determines whether or not a client certificate is required for the
specified App Server.
|
|
admin:appserver-set-static-expires
|
This function changes the value of the "expires" HTTP header for a specified App Server
to the newly specified value.
|
|
admin:appserver-set-threads
|
This function sets the value in the configuration of
the maximum number of threads for the specified App Server.
|
|
admin:appserver-set-url-rewriter
|
This function sets the value of the path to the URL
rewriter in the configuration for the specified App Server.
|
|
admin:database-add-backup
|
This function adds scheduled backup specifications for a
database to a configuration.
|
|
admin:database-add-element-attribute-word-lexicon
|
This function adds an element attribute word lexicon to the
specified database in the configuration.
|
|
admin:database-add-element-word-lexicon
|
This function adds an element word lexicon to the
specified database in the configuration.
|
|
admin:database-add-element-word-query-through
|
This function adds an element word query through to the
specified database in the configuration.
|
|
admin:database-add-field
|
This function adds the field specification to the specified
database in the configuration.
|
|
admin:database-add-field-excluded-element
|
This function adds the field excluded
element specification in the specified
database in the configuration.
|
|
admin:database-add-field-included-element
|
This function adds the field included
element specification tn the specified
database in the configuration.
|
|
admin:database-add-field-word-lexicon
|
This function adds a word lexicon to the
specified database in the configuration.
|
|
admin:database-add-fragment-parent
|
This function adds the specified fragment parent to the
specified database in the configuration.
|
|
admin:database-add-fragment-root
|
This function adds the specified fragment root to the specified
database in the configuration.
|
|
admin:database-add-geospatial-element-attribute-pair-index
|
This function adds a geospatial element attribute
pair index to the specified
database in the configuration.
|
|
admin:database-add-geospatial-element-child-index
|
This function adds a geospatial element child index to
the specified database in the configuration.
|
|
admin:database-add-geospatial-element-index
|
This function adds a range element index to the specified
database in the configuration.
|
|
admin:database-add-geospatial-element-pair-index
|
This function adds a geospatial element pair index to
the specified database in the configuration.
|
|
admin:database-add-merge-blackout
|
This function adds a merge blackout specification for a
database to a configuration.
|
|
admin:database-add-phrase-around
|
This function adds a phrase around to the
specified database in the configuration.
|
|
admin:database-add-phrase-through
|
This function adds a phrase through to the
specified database in the configuration.
|
|
admin:database-add-range-element-attribute-index
|
This function adds a range element attribute index to the
specified database in the configuration.
|
|
admin:database-add-range-element-index
|
This function adds a range element index to the specified
database in the configuration.
|
|
admin:database-add-word-lexicon
|
This function adds a word lexicon to the
specified database in the configuration.
|
|
admin:database-add-word-query-excluded-element
|
This function adds the word query excluded
element specification for the specified
database to the configuration.
|
|
admin:database-add-word-query-included-element
|
This function adds the word query included
element specification to the specified
database in the configuration.
|
|
admin:database-attach-forest
|
This function attaches the specified forest to the
specified database.
|
|
admin:database-copy
|
This function creates a new database specification with the
same settings as the database with the specified ID.
|
|
admin:database-create
|
This function creates a new database specification.
|
|
admin:database-daily-backup
|
This function constructs a daily scheduled database backup.
|
|
admin:database-delete
|
This function deletes the configuration from the
specified database(s).
|
|
admin:database-delete-backup
|
This function deletes scheduled backup specifications for a
database from a configuration.
|
|
admin:database-delete-element-attribute-word-lexicon
|
This function deletes an element attribute word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-element-word-lexicon
|
This function deletes an element word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-element-word-query-through
|
This function deletes an element word query through for the
specified database from the configuration.
|
|
admin:database-delete-field
|
This function deletes the field specification in the specified
database from the configuration.
|
|
admin:database-delete-field-excluded-element
|
This function deletes the field excluded
element specification in the specified
database from the configuration.
|
|
admin:database-delete-field-included-element
|
This function deletes the field included
element specification in the specified
database from the configuration.
|
|
admin:database-delete-field-word-lexicon
|
This function deletes a word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-fragment-parent
|
This function deletes the specified fragment parent in the
specified database from the configuration.
|
|
admin:database-delete-fragment-root
|
This function deletes the specified fragment root in the
specified database from the configuration.
|
|
admin:database-delete-geospatial-element-attribute-pair-index
|
This function deletes a geospatial element attribute
pair index in the specified
database from the configuration.
|
|
admin:database-delete-geospatial-element-child-index
|
This function deletes a geospatial element child index for the
specified database in the configuration.
|
|
admin:database-delete-geospatial-element-index
|
This function deletes a geospatial element index for the
specified database in the configuration.
|
|
admin:database-delete-geospatial-element-pair-index
|
This function deletes a geospatial element pair index for
the specified database from the configuration.
|
|
admin:database-delete-merge-blackout
|
This function deletes a merge blackout specification for a
database from a configuration.
|
|
admin:database-delete-phrase-around
|
This function deletes a phrase around for the
specified database from the configuration.
|
|
admin:database-delete-phrase-through
|
This function deletes a phrase through for the
specified database from the configuration.
|
|
admin:database-delete-range-element-attribute-index
|
This function deletes a range element attribute index for
the specified database in the configuration.
|
|
admin:database-delete-range-element-index
|
This function deletes a range element index for the specified
database in the configuration.
|
|
admin:database-delete-word-lexicon
|
This function deletes a word lexicon for the
specified database from the configuration.
|
|
admin:database-delete-word-query-excluded-element
|
This function deletes the word query excluded
element specification in the specified
database from the configuration.
|
|
admin:database-delete-word-query-included-element
|
This function deletes the word query included
element specification in the specified
database from the configuration.
|
|
admin:database-detach-forest
|
This function detaches the specified forest from the
specified database.
|
|
admin:database-element-attribute-word-lexicon
|
This function constructs an element attribute word
lexicon specification.
|
|
admin:database-element-word-lexicon
|
This function constructs an element word lexicon specification.
|
|
admin:database-element-word-query-through
|
This function constructs an element word query
through specification.
|
|
admin:database-excluded-element
|
This function constructs an excluded element specification.
|
|
admin:database-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-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-index
|
This function constructs a geospatial element index
specification.
|
|
admin:database-geospatial-element-pair-index
|
This function constructs a geospatial element pair index
specification.
|
|
admin:database-get-attached-forests
|
This function returns the attached forest IDs
for the specified database from the configuration.
|
|
admin:database-get-attribute-value-positions
|
This function returns the attribute value positions setting
for the specified database from the configuration.
|
|
admin:database-get-backups
|
This function returns the scheduled backups
for the specified database from the configuration.
|
|
admin:database-get-collection-lexicon
|
This function returns the collection lexicon setting
for the specified database from the configuration.
|
|
admin:database-get-directory-creation
|
This function returns the directory creation setting
for the specified database from the configuration.
|
|
admin:database-get-element-attribute-word-lexicons
|
This function returns the element attribute word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-element-value-positions
|
This function returns the element value positions setting
for the specified database from the configuration.
|
|
admin:database-get-element-word-lexicons
|
This function returns the element word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-element-word-positions
|
This function returns the element word positions setting
for the specified database from the configuration.
|
|
admin:database-get-element-word-query-throughs
|
This function returns the element word query throughs
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-enabled
|
This function returns the enabled value
for the specified database from the configuration.
|
|
admin:database-get-expunge-locks
|
This function returns the expunge locks setting
for the specified database from the configuration.
|
|
admin:database-get-fast-case-sensitive-searches
|
This function returns the fast case sensitive searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-diacritic-sensitive-searches
|
This function returns the fast diacritic sensitive
searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-character-searches
|
This function returns the fast element character
searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-phrase-searches
|
This function returns the fast element phrase searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-trailing-wildcard-searches
|
This function returns the trailing wildcard searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-element-word-searches
|
This function returns the fast element word searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-phrase-searches
|
This function returns the fast phrase searches setting
for the specified database from the configuration.
|
|
admin:database-get-fast-reverse-searches
|
This function returns the fast reverse searches setting
for the specified database from the configuration.
|
|
admin:database-get-field
|
This function returns the field specification
for the specified database from the configuration.
|
|
admin:database-get-field-excluded-elements
|
This function returns the field excluded elements
specification
for the specified database from the configuration.
|
|
admin:database-get-field-fast-case-sensitive-searches
|
This function returns true if the fast case sensitive searches setting
for the specified field is enabled.
|
|
admin:database-get-field-fast-diacritic-sensitive-searches
|
This function returns true if the fast diacritic sensitive
searches setting for the specified field is enabled.
|
|
admin:database-get-field-fast-phrase-searches
|
This function returns true if the fast phrase searches setting
for the specified field is enabled.
|
|
admin:database-get-field-include-document-root
|
This function returns the field include document root setting
for the specified field from the configuration.
|
|
admin:database-get-field-included-elements
|
This function returns the fields included elements
specification for the specified database from the
configuration.
|
|
admin:database-get-field-one-character-searches
|
This function returns true if the one character searches setting
for the specified field is enabled.
|
|
admin:database-get-field-stemmed-searches
|
This function returns stemmed searches setting
for the specified field if configured.
|
|
admin:database-get-field-three-character-searches
|
This function returns true if the three character searches setting
for the specified field is enabled.
|
|
admin:database-get-field-three-character-word-positions
|
This function returns true if the three character word positions setting
for the specified field is enabled.
|
|
admin:database-get-field-trailing-wildcard-searches
|
This function returns true if the trailing wildcard searches setting
for the specified field is enabled.
|
|
admin:database-get-field-trailing-wildcard-word-positions
|
This function returns true if the trailing wildcard word positions setting
for the specified field is enabled.
|
|
admin:database-get-field-two-character-searches
|
This function returns true if the two character searches setting
for the specified field is enabled.
|
|
admin:database-get-field-word-lexicons
|
This function returns the word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-field-word-searches
|
This function returns true if the word searches setting
for the specified field is enabled.
|
|
admin:database-get-fields
|
This function returns the fields specification(s)
for the specified database from the configuration.
|
|
admin:database-get-format-compatibility
|
This function returns the format compatibility setting
for the specified database from the configuration.
|
|
admin:database-get-fragment-parents
|
This function returns the fragment parents specification
for the specified database from the configuration.
|
|
admin:database-get-fragment-roots
|
This function returns the fragment roots specification
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-attribute-pair-indexes
|
This function returns the geospatial element attribute pair
indexes specification(s)
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-child-indexes
|
This function returns the geospatial element child indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-indexes
|
This function returns the geospatial element indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-geospatial-element-pair-indexes
|
This function returns the geospatial element pair indexes
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-id
|
This function returns the ID for the specified database from the configuration.
|
|
admin:database-get-in-memory-limit
|
This function returns the in memory limit setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-list-size
|
This function returns the in memory list size setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-range-index-size
|
This function returns the in memory range index size setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-reverse-index-size
|
This function returns the in memory reverse index size setting
for the specified database from the configuration.
|
|
admin:database-get-in-memory-tree-size
|
This function returns the in memory tree size setting
for the specified database from the configuration.
|
|
admin:database-get-index-detection
|
This function returns the index detection setting
for the specified database from the configuration.
|
|
admin:database-get-inherit-collections
|
This function returns the inherit collections setting
for the specified database from the configuration.
|
|
admin:database-get-inherit-permissions
|
This function returns the inherit positions setting
for the specified database from the configuration.
|
|
admin:database-get-inherit-quality
|
This function returns the inherit quality setting
for the specified database from the configuration.
|
|
admin:database-get-journal-size
|
This function returns the journal size setting
for the specified database from the configuration.
|
|
admin:database-get-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-tf-normalization
|
This function returns the current term-frequency
normalization setting for the database.
|
|
admin:database-get-three-character-searches
|
This function returns the three character searches setting
for the specified database from the configuration.
|
|
admin:database-get-three-character-word-positions
|
This function returns the three character word positions
setting
for the specified database from the configuration.
|
|
admin:database-get-trailing-wildcard-searches
|
This function returns the trailing wildcard searches setting
for the specified database from the configuration.
|
|
admin:database-get-trailing-wildcard-word-positions
|
This function returns the trailing wildcard word
positions setting
for the specified database from the configuration.
|
|
admin:database-get-triggers-database
|
This function returns the ID of the triggers database
for the specified database from the configuration.
|
|
admin:database-get-two-character-searches
|
This function returns the two character searches setting
for the specified database from the configuration.
|
|
admin:database-get-uri-lexicon
|
This function returns the URI lexicon setting
for the specified database from the configuration.
|
|
admin:database-get-word-lexicons
|
This function returns the word lexicons
specification(s)
for the specified database from the configuration.
|
|
admin:database-get-word-positions
|
This function returns the word positions setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-excluded-elements
|
This function returns the word query excluded elements setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-fast-case-sensitive-searches
|
This function returns true if the word query fast case
sensitive searches setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-fast-diacritic-sensitive-searches
|
This function returns true if the word query fast diacritic
sensitive searches setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-fast-phrase-searches
|
This function returns true if the word query fast phrase
searches setting
for the specified database is set in the configuration.
|
|
admin:database-get-word-query-include-document-root
|
This function returns the word query include
document root setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-included-elements
|
This function returns the word query included elements setting
for the specified database from the configuration.
|
|
admin:database-get-word-query-one-character-searches
|
This function returns true if the word query one character
searches setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-stemmed-searches
|
This function returns the reindexer word query stemmed
searches setting for the specified database from the
configuration.
|
|
admin:database-get-word-query-three-character-searches
|
This function returns true if the word query three character
searches setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-three-character-word-positions
|
This function returns true if the word query three character
word positions setting is enabled
for the specified database from the configuration.
|
|
admin:database-get-word-query-trailing-wildcard-searches
|
This function returns true if the word query trailing
wildcard searches setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-trailing-wildcard-word-positions
|
This function returns true if the word query trailing
wildcard word positions setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-two-character-searches
|
This function returns true if the word query two character
searches setting is enabled
for the specified database in the configuration.
|
|
admin:database-get-word-query-word-searches
|
This function returns true if the word query searches setting
for the specified database is enabled in the configuration.
|
|
admin:database-get-word-searches
|
This function returns the word searches setting
for the specified database from the configuration.
|
|
admin:database-hourly-backup
|
This function constructs a hourly scheduled database backup.
|
|
admin:database-included-element
|
This function constructs an included element specification.
|
|
admin:database-minutely-backup
|
This function constructs a scheduled database backup on a number-of-minutes basis.
|
|
admin:database-monthly-backup
|
This function constructs a monthly scheduled backup.
|
|
admin:database-one-time-backup
|
This function constructs a one-time backup.
|
|
admin:database-one-time-merge-blackout
|
This function constructs a one-time merge-blackout
specification.
|
|
admin:database-phrase-around
|
This function constructs a phrase through specification.
|
|
admin:database-phrase-through
|
This function constructs a phrase through specification.
|
|
admin:database-range-element-attribute-index
|
This function constructs a range element attribute index
specification.
|
|
admin:database-range-element-index
|
This function constructs a range element index
specification.
|
|
admin:database-recurring-merge-blackout
|
This function constructs a merge-blackout specification.
|
|
admin:database-set-attribute-value-positions
|
This function sets the attribute value positions setting
for the specified database in the configuration.
|
|
admin:database-set-collection-lexicon
|
This function sets the collection lexicon setting
for the specified database in the configuration.
|
|
admin:database-set-directory-creation
|
This function sets the directory creation setting
for the specified database in the configuration.
|
|
admin:database-set-element-value-positions
|
This function sets the element value positions setting
for the specified database in the configuration.
|
|
admin:database-set-element-word-positions
|
This function sets the element word positions setting
for the specified database in the configuration.
|
|
admin:database-set-enabled
|
This function sets the enabled value
for the specified database in the configuration.
|
|
admin:database-set-expunge-locks
|
This function sets the expunge locks setting
for the specified database in the configuration.
|
|
admin:database-set-fast-case-sensitive-searches
|
This function sets the fast case sensitive searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-diacritic-sensitive-searches
|
This function sets the fast diacritic-sensitive searches
setting for the specified database in the configuration.
|
|
admin:database-set-fast-element-character-searches
|
This function sets the fast element character searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-element-phrase-searches
|
This function sets the fast element phrase searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-element-trailing-wildcard-searches
|
This function sets the fast element trailing wildcard searches
setting for the specified database in the configuration.
|
|
admin:database-set-fast-element-word-searches
|
This function sets the element word searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-phrase-searches
|
This function sets the fast phrase searches setting
for the specified database in the configuration.
|
|
admin:database-set-fast-reverse-searches
|
This function sets the fast reverse searches setting
for the specified database in the configuration.
|
|
admin:database-set-field-fast-case-sensitive-searches
|
This function sets the field fast case sensitive
searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-fast-diacritic-sensitive-searches
|
This function sets the field fast diacritic sensitive
searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-fast-phrase-searches
|
This function sets the field fast phrase searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-include-document-root
|
This function sets the field include document root setting
for the specified field in the configuration.
|
|
admin:database-set-field-name
|
This function sets the field name setting
for the specified field in the configuration.
|
|
admin:database-set-field-one-character-searches
|
This function sets the field one character searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-stemmed-searches
|
This function sets the field stemmed searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-three-character-searches
|
This function sets the field three character searches
setting
for the specified field in the configuration.
|
|
admin:database-set-field-three-character-word-positions
|
This function sets the field three character
word positions setting
for the specified field in the configuration.
|
|
admin:database-set-field-trailing-wildcard-searches
|
This function sets the field trailing wildcard
searches setting
for the specified database in the configuration.
|
|
admin:database-set-field-trailing-wildcard-word-positions
|
This function sets the field trailing wildcard word
positions setting
for the specified field in the configuration.
|
|
admin:database-set-field-two-character-searches
|
This function sets the field two character searches setting
for the specified field in the configuration.
|
|
admin:database-set-field-word-searches
|
This function sets the field word searches setting
for the specified field in the configuration.
|
|
admin:database-set-format-compatibility
|
This function sets the format cpmpatibility setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-limit
|
This function sets the in-memory limit setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-list-size
|
This function sets the in-memory list size setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-range-index-size
|
This function sets the in-memory range index size setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-reverse-index-size
|
This function sets the in-memory range reverse index
size setting
for the specified database in the configuration.
|
|
admin:database-set-in-memory-tree-size
|
This function sets the in-memory tree size setting
for the specified database in the configuration.
|
|
admin:database-set-index-detection
|
This function sets the index detection setting
for the specified database in the configuration.
|
|
admin:database-set-inherit-collections
|
This function sets the inherit collections setting
for the specified database in the configuration.
|
|
admin:database-set-inherit-permissions
|
This function sets the inherit permissions setting
for the specified database in the configuration.
|
|
admin:database-set-inherit-quality
|
This function sets the inherit quality setting
for the specified database in the configuration.
|
|
admin:database-set-journal-size
|
This function sets the journal size setting
for the specified database in the configuration.
|
|
admin:database-set-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-tf-normalization
|
This function specifies whether to use the default term-frequency
normalization (scaled-log), which scales the term frequency based on the size of
the document, or to use the unscaled-log, which uses term frequency as a function
of the actual term frequency in a document, regardless of the document size.
|
|
admin:database-set-three-character-searches
|
This function sets the three character searches setting
for the specified database in the configuration.
|
|
admin:database-set-three-character-word-positions
|
This function sets the three character word positions setting
for the specified database in the configuration.
|
|
admin:database-set-trailing-wildcard-searches
|
This function sets the trailing wildcard searches setting
for the specified database in the configuration.
|
|
admin:database-set-trailing-wildcard-word-positions
|
This function sets the trailing wildcard word positions setting
for the specified database in the configuration.
|
|
admin:database-set-triggers-database
|
This function sets the triggers database to the specified
database ID for the specified database in the configuration.
|
|
admin:database-set-two-character-searches
|
This function sets the two character searches setting
for the specified database in the configuration.
|
|
admin:database-set-uri-lexicon
|
This function sets the URI lexicon setting
for the specified database in the configuration.
|
|
admin:database-set-word-positions
|
This function sets the word positions setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-fast-case-sensitive-searches
|
This function returns the word query fast case
sensitive searches setting
for the specified database from the configuration.
|
|
admin:database-set-word-query-fast-diacritic-sensitive-searches
|
This function sets the word query fast diacritic
sensitive searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-fast-phrase-searches
|
This function sets the word query fast phrase
searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-include-document-root
|
This function sets the word query include
document root setting
for the specified field in the configuration.
|
|
admin:database-set-word-query-one-character-searches
|
This function sets the word query one character
searches setting
for the specified field in the configuration.
|
|
admin:database-set-word-query-stemmed-searches
|
This function sets the word query stemmed searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-three-character-searches
|
This function sets the word query three character
searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-three-character-word-positions
|
This function sets the word query three character
word positions setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-trailing-wildcard-searches
|
This function sets the word query trailing
wildcard searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-trailing-wildcard-word-positions
|
This function sets the word query trailing wildcard
word positions setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-two-character-searches
|
This function sets the word query two character
searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-query-word-searches
|
This function sets the word query word searches setting
for the specified database in the configuration.
|
|
admin:database-set-word-searches
|
This function sets the word searches setting
for the specified database in the configuration.
|
|
admin:database-weekly-backup
|
This function constructs a weekly scheduled backup.
|
|
admin:database-word-lexicon
|
This function constructs a word lexicon specification.
|
|
admin:forest-add-backup
|
This function adds scheduled backup specifications for a
forest to a configuration.
|
|
admin:forest-add-failover-host
|
This function adds a failover host to the list of failover
hosts for the specified forest in the specified
configuration.
|
|
admin:forest-copy
|
This function creates a new forest specification with the
same settings as the forest with the specified ID.
|
|
admin:forest-create
|
This function creates a new forest configuration.
|
|
admin:forest-daily-backup
|
This function constructs a daily scheduled forest backup.
|
|
admin:forest-delete
|
This function deletes the configuration for the specified
forest from the configuration.
|
|
admin:forest-delete-backup
|
This function deletes scheduled backup specifications for a
forest from a configuration.
|
|
admin:forest-delete-failover-host
|
This function deletes the specified failover host(s) from the
failover-host list in the specified configuration.
|
|
admin:forest-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 of the specified forest,
given the forest ID.
|
|
admin:forest-get-updates-allowed
|
This function returns the state of what kinds of updates are allowed
for the specified forest.
|
|
admin:forest-hourly-backup
|
This function constructs a hourly scheduled forest backup.
|
|
admin:forest-minutely-backup
|
This function constructs a scheduled forest backup on a number-of-minutes basis.
|
|
admin:forest-monthly-backup
|
This function constructs a monthly scheduled backup.
|
|
admin:forest-one-time-backup
|
This function constructs a one-time backup.
|
|
admin:forest-set-enabled
|
This function sets the enabled state for a forest
configuration.
|
|
admin:forest-set-failover-enable
|
This function sets the forest failover enabled state for a
forest configuration.
|
|
admin:forest-set-host
|
This function sets a forest configuration to a new
host.
|
|
admin:forest-set-updates-allowed
|
This function sets the updates-allowed state for a
forest configuration.
|
|
admin:forest-weekly-backup
|
This function constructs a weekly scheduled backup.
|
|
admin:get-appserver-ids
|
This function returns all the appserver IDs from the configuration.
|
|
admin:get-configuration
|
Loads the admin configuration into memory for use
by other functions in the Admin module.
|
|
admin:get-database-ids
|
This function returns all the database IDs from the configuration.
|
|
admin:get-forest-ids
|
This function returns all the forest IDs from the configuration.
|
|
admin:get-group-ids
|
This function returns all the group IDs from the configuration.
|
|
admin:get-host-ids
|
This function returns all the host IDs from the configuration.
|
|
admin:group-add-namespace
|
Add one or more namespaces to a Group configuration,
which will predefine the namespace(s) for all requests
evaluated against any App Server in the Group.
|
|
admin:group-add-scheduled-task
|
This function adds one or more scheduled tasks to the specified group.
|
|
admin:group-add-schema
|
This function adds a schema binding definition to the
existing schema binding definitions in the configuration
for the specified Group.
|
|
admin:group-add-trace-event
|
This function adds trace events to the configuration.
|
|
admin:group-copy
|
This function creates a new group specification with the
same settings as the group with the specified ID.
|
|
admin:group-create
|
This function creates a new group with the specified
name in the configuration.
|
|
admin:group-daily-scheduled-task
|
This function constructs a task to be invoked at daily intervals.
|
|
admin:group-delete
|
This function deletes one or more groups in the configuration.
|
|
admin:group-delete-namespace
|
This function deletes the specified namespaces from the
configuration for the specified group.
|
|
admin:group-delete-scheduled-task
|
This function deletes one or more scheduled tasks from the specified group.
|
|
admin:group-delete-schema
|
This function deletes a schema binding definition to the
existing schema binding definitions in the configuration
for the specified Group.
|
|
admin:group-delete-trace-event
|
This function deletes the specified trace events from
the configuration.
|
|
admin:group-disable-audit-event-type
|
This function changes the audit event type(s) enabled setting
for the audit configuration.
|
|
admin:group-enable-audit-event-type
|
This function changes the audit event type(s) enabled setting
for the audit configuration.
|
|
admin:group-get-appserver-ids
|
This function returns the IDs of all appservers belonging to the group.
|
|
admin:group-get-audit-enabled
|
This function returns the value for the audit enabled
setting from the specified group.
|
|
admin:group-get-audit-event-type-enabled
|
This function returns the audit event type's enabled setting
for the audit configuration.
|
|
admin:group-get-audit-excluded-roles
|
This function returns the roles excluded from auditing.
|
|
admin:group-get-audit-excluded-uris
|
This function returns the uris excluded from auditing.
|
|
admin:group-get-audit-excluded-users
|
This function returns the users excluded from auditing.
|
|
admin:group-get-audit-included-roles
|
This function returns the roles included from auditing.
|
|
admin:group-get-audit-included-uris
|
This function returns the uris included from auditing.
|
|
admin:group-get-audit-included-users
|
This function returns the users included from auditing.
|
|
admin:group-get-audit-outcome-restriction
|
This function returns whether auditing events are restricted by a
success or failure outcome.
|
|
admin:group-get-compressed-tree-cache-partitions
|
This function returns the value for the compressed tree
cache partitions setting from the specified group.
|
|
admin:group-get-compressed-tree-cache-size
|
This function returns the value for the compressed tree
cache size setting from the specified group.
|
|
admin:group-get-compressed-tree-read-size
|
This function returns the value for the compressed tree
read size (in kilobytes) setting from the specified group.
|
|
admin:group-get-expanded-tree-cache-partitions
|
This function returns the value for the expanded tree
cache partitions setting from the specified group.
|
|
admin:group-get-expanded-tree-cache-size
|
This function returns the value for the expanded tree
cache size setting from the specified group.
|
|
admin:group-get-failover-enable
|
This function returns the value for the failover enable
setting from the specified group.
|
|
admin:group-get-file-log-level
|
This function returns the value for the file log level
setting from the specified group.
|
|
admin:group-get-host-ids
|
This function returns the IDs of all hosts belonging to the group.
|
|
admin:group-get-host-initial-timeout
|
This function returns the value for the host initial timeout
setting from the specified group.
|
|
admin:group-get-host-timeout
|
This function returns the value for the host timeout
setting from the specified group.
|
|
admin:group-get-http-timeout
|
This function returns the value for the http timeout
setting from the specified group.
|
|
admin:group-get-http-user-agent
|
This function returns the value for the http user agent
setting from the specified group.
|
|
admin:group-get-httpserver-ids
|
This function returns the IDs of all httpservers belonging to the group.
|
|
admin:group-get-id
|
This function returns the ID of the group.
|
|
admin:group-get-keep-audit-files
|
This function returns the value for the keep audit files
setting from the specified group.
|
|
admin:group-get-keep-log-files
|
This function returns the value for the keep log files
setting from the specified group.
|
|
admin:group-get-list-cache-partitions
|
This function returns the value for the list cache partitions
setting from the specified group.
|
|
admin:group-get-list-cache-size
|
This function returns the value for the list cache size
setting from the specified group.
|
|
admin:group-get-name
|
This function returns the name of the specified group.
|
|
admin:group-get-namespaces
|
This function returns the value of any namespace definitions
predefined for the specified group.
|
|
admin:group-get-retry-timeout
|
This function returns the value for the number of seconds a request
will retry before timing out.
|
|
admin:group-get-rotate-audit-files
|
This function returns the value for the rotate audit files
setting from the specified group.
|
|
admin:group-get-rotate-log-files
|
This function returns the value for the rotate log files
setting from the specified group.
|
|
admin:group-get-scheduled-tasks
|
This function returns all of the tasks scheduled for the specified
group.
|
|
admin:group-get-schemas
|
This function returns the value of any schemas definitions
predefined for the specified group.
|
|
admin:group-get-smtp-relay
|
This function returns the value for the smtp relay
setting from the specified group.
|
|
admin:group-get-smtp-timeout
|
This function returns the value for the smtp timeout
setting from the specified group.
|
|
admin:group-get-system-log-level
|
This function returns the value for the system log level
setting from the specified group.
|
|
admin:group-get-taskserver-id
|
This function returns the ID of of the taskserver belonging to the group.
|
|
admin:group-get-trace-events
|
This function returns the value of any trace events
activated for the specified group.
|
|
admin:group-get-trace-events-activated
|
This function returns the value for the trace events
activated setting from the specified group.
|
|
admin:group-get-webdavserver-ids
|
This function returns the IDs of all webdavservers belonging to the group.
|
|
admin:group-get-xdbcserver-ids
|
This function returns the IDs of all xdbcservers belonging to the group.
|
|
admin:group-get-xdqp-ssl-allow-sslv3
|
This function returns true if the SSL v3 protocol
is enabled for the group.
|
|
admin:group-get-xdqp-ssl-allow-tls
|
This function returns true if the TLS protocol
is enabled for the group.
|
|
admin:group-get-xdqp-ssl-ciphers
|
This function returns the SSL ciphers set for the group.
|
|
admin:group-get-xdqp-ssl-enabled
|
This function returns true if SSL is enabled for the
group.
|
|
admin:group-get-xdqp-timeout
|
This function returns the value for the xdqp timeout
setting from the specified group.
|
|
admin:group-hourly-scheduled-task
|
This function constructs a task to be invoked at hourly intervals.
|
|
admin:group-minutely-scheduled-task
|
This function constructs a task to be invoked at intervals defined in terms of minutes.
|
|
admin:group-monthly-scheduled-task
|
This function constructs a task to be invoked at monthly intervals.
|
|
admin:group-namespace
|
This function constructs a namespace element with the
specified prefix and URI.
|
|
admin:group-one-time-scheduled-task
|
This function constructs a task to be invoked once, at a specific calendar day and time.
|
|
admin:group-schema
|
This function constructs a schema element with the
specified prefix and URI.
|
|
admin:group-set-audit-enabled
|
This function changes the audit enabled setting
for the group in the configuration.
|
|
admin:group-set-audit-outcome-restriction
|
This function restricts the audit configuration by auditing
events only if they are "success" or "failure" events.
|
|
admin:group-set-audit-role-restriction
|
This function restricts the audit configuration by excluding or
including by role.
|
|
admin:group-set-audit-uri-restriction
|
This function restricts the audit configuration by excluding or
including by document uri(s).
|
|
admin:group-set-audit-user-restriction
|
This function restricts the audit configuration by excluding or
including by user.
|
|
admin:group-set-compressed-tree-cache-partitions
|
This function changes the compressed tree cache partitions
setting of the group with the
specified ID to the specified value.
|
|
admin:group-set-compressed-tree-cache-size
|
This function changes the compressed tree cache size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-compressed-tree-read-size
|
This function changes the compressed tree read size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-expanded-tree-cache-partitions
|
This function changes the expanded tree cache partitions
setting of the group with the
specified ID to the specified value.
|
|
admin:group-set-expanded-tree-cache-size
|
This function changes the expanded tree cache size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-failover-enable
|
This function changes the failover enable setting
for the group in the configuration.
|
|
admin:group-set-file-log-level
|
This function changes the host file log level setting
for the group in the configuration.
|
|
admin:group-set-host-initial-timeout
|
This function changes the host initial timeout setting
(the time the cluster will wait for a host to come online
during cluster startup) for the group
in the configuration.
|
|
admin:group-set-host-timeout
|
This function changes the host timeout setting (the timeout
for communication between hosts) for the group
in the configuration.
|
|
admin:group-set-http-timeout
|
This function changes the HTTP timeout setting for the group
in the configuration.
|
|
admin:group-set-http-user-agent
|
This function changes the HTTP User-Agent setting for
the group in the configuration.
|
|
admin:group-set-keep-audit-files
|
This function changes the keep audit files setting
for the group in the configuration.
|
|
admin:group-set-keep-log-files
|
This function changes the keep log files setting
for the group in the configuration.
|
|
admin:group-set-list-cache-partitions
|
This function changes the list cache partitions setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-list-cache-size
|
This function changes the list cache size setting
of the group with the
specified ID to the specified value.
|
|
admin:group-set-name
|
This function changes the name of the group with the
specified ID to the specified name.
|
|
admin:group-set-retry-timeout
|
This function changes the the number of seconds a request
will retry before timing out.
|
|
admin:group-set-rotate-audit-files
|
This function changes the rotate audit files setting
for the group in the configuration.
|
|
admin:group-set-rotate-log-files
|
This function changes the rotate log files setting
for the group in the configuration.
|
|
admin:group-set-smtp-relay
|
This function changes the SMTP relay setting for the group
in the configuration.
|
|
admin:group-set-smtp-timeout
|
This function changes the SMTP timeout setting for the group
in the configuration.
|
|
admin:group-set-system-log-level
|
This function changes the host system log level setting
for the group in the configuration.
|
|
admin:group-set-trace-events-activated
|
This function changes the value for trace events in the
group configuration.
|
|
admin:group-set-xdqp-ssl-allow-sslv3
|
This function enables or disables the SSL v3 protocol for the
specified group.
|
|
admin:group-set-xdqp-ssl-allow-tls
|
This function enables or disables the TLS protocol for the specified
group.
|
|
admin:group-set-xdqp-ssl-ciphers
|
This function sets SSL ciphers for the specified group.
|
|
admin:group-set-xdqp-ssl-enabled
|
This function enables or disables SSL for the group.
|
|
admin:group-set-xdqp-timeout
|
This function changes the XDQP timeout setting (the timeout
for communication between data nodes and evaluator nodes)
for the group in the configuration.
|
|
admin:group-trace-event
|
This function constructs an event element for the
specified event name.
|
|
admin:group-weekly-scheduled-task
|
This function constructs a task to be invoked at weekly intervals.
|
|
admin:host-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-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-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-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: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.
|
|
dls:as-of-query
|
This function returns a query that matches the most recent
numbered version of documents that were created before the specified date and time.
|
|
dls:author-query
|
This function returns a query that matches documents authored by the specified user.
|
|
dls:break-checkout
|
This function breaks (unlocks) a checked-out document.
|
|
dls:document-add-collections
|
This function adds the named document to the specified collections.
|
|
dls:document-add-permissions
|
This function adds the specified permissions for the named document.
|
|
dls:document-add-properties
|
This function adds the specified properties to any existing properties
associated with the named document.
|
|
dls:document-checkin
|
This function checks in (unlocks) the document at the
specified URI to allow other users to modify the document.
|
|
dls:document-checkout
|
This function checks out (locks) the document at the
specified URI to prevent other users from modifying the document.
|
|
dls:document-checkout-status
|
This function returns a checkout element containing the
checkout status of the specified document.
|
|
dls:document-delete
|
This function removes the specified managed document.
|
|
dls:document-extract-part
|
This function extracts an element from an existing document and creates a
new document from the
extracted element.
|
|
dls:document-get-permissions
|
This function gets the permissions for the specified document
from the point of view of the Library Services API.
|
|
dls:document-history
|
Returns the version history of the document located at the
specified URI.
|
|
dls:document-include-query
|
This function returns a query that matches any managed document that has
an XInclude link that exactly matches the specified URI.
|
|
dls:document-insert-and-manage
|
This function inserts a document into the database and places the document under
management.
|
|
dls:document-is-managed
|
This function determines whether or not the document at
the specified URI is managed.
|
|
dls:document-manage
|
This function places a document under management.
|
|
dls:document-purge
|
This function deletes all numbered versions of the specified
managed document and its referenced documents, as specified by the rention
policies set by dls:retention-rule.
|
|
dls:document-remove-collections
|
This function removes the named document from the
specified collection.
|
|
dls:document-remove-permissions
|
This function removes the specified permissions from the
named document.
|
|
dls:document-remove-properties
|
This function removes the specified properties from the
named document.
|
|
dls:document-retention-rules
|
This function returns the retention rules that apply to the
document at the specified URI.
|
|
dls:document-set-collections
|
This function sets the named document to the specified collections.
|
|
dls:document-set-permissions
|
This function sets the specified permissions for the named document.
|
|
dls:document-set-properties
|
This function sets the properties of a document to the given
sequence of elements.
|
|
dls:document-set-property
|
This function sets a property on a document.
|
|
dls:document-set-quality
|
This function sets the quality of the document with the given
URI.
|
|
dls:document-unmanage
|
Removes the specified document from management.
|
|
dls:document-update
|
This function updates the managed document at the specified URI
with the specified contents.
|
|
dls:document-version
|
This function returns a particular version of a managed document.
|
|
dls:document-version-as-of
|
This function returns the most recent version of a document
as of a point in time.
|
|
dls:document-version-delete
|
This function removes the specified version of the managed
document at the specified URI.
|
|
dls:document-version-query
|
This function returns a query that matches the specified version of
the managed documents.
|
|
dls:document-version-uri
|
This function returns the URI of the specified version of the
document located at the specified URI.
|
|
dls:document-version-uris
|
This function returns the URIs of all versions of a
managed document.
|
|
dls:document-versions-query
|
This function returns a query that matches any version
of the specified URI.
|
|
dls:documents-query
|
This function returns a query that matches the latest versions of
the managed documents in the database.
|
|
dls:link-expand
|
This function performs a single level expansion of a single
XInclude reference.
|
|
dls: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.
|
|
dls:node-expand
|
This function recursively examines the node for XInclude references
and expands them, following the rules of the XInclude specification.
|
|
dls:purge
|
This function deletes all numbered versions of managed documents and
its referenced documents (such as /foo/bar.xml_versions/1-bar.xml), as
specified by the rention policy set by one or more dls:retention-rule
functions.
|
|
dls:retention-rule
|
This function creates and returns a retention rule element.
|
|
dls:retention-rule-insert
|
This function inserts retention rules into the database.
|
|
dls:retention-rule-remove
|
This function removes the specified retention rules from the database.
|
|
dls:retention-rules
|
This function returns the specified retention rules from the database.
|
|
entity:enrich
|
Returns the entity-enriched XML for the given XML node.
|
|
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.
|
|
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.
|
|
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.
|
|
pki:create-template
|
This function creates a new X.509 certificate request template.
|
|
pki:delete-certificate
|
This function removes the specified certificate from the
Security database.
|
|
pki:delete-template
|
This function removes the specified certificate request template from the
Security database.
|
|
pki:generate-certificate-request
|
This function generates a PEM encoded X.509 certificate request from the template
for the specified id.
|
|
pki:generate-template-certificate-authority
|
This function creates a common temporary certificate authority to sign all
the certificates for the specified certificate template.
|
|
pki:generate-temporary-certificate
|
This function generates a new key pair and temporary certificate from the specified
certificate template.
|
|
pki:generate-temporary-certificate-if-necessary
|
This function generates a new key pair and temporary certificate
from the specified certificate template.
|
|
pki:get-certificate
|
This function returns the certificate for the specified template and host.
|
|
pki:get-certificate-pem
|
This function returns the PEM encoded certificate for the specified
certificate template and common name combination.
|
|
pki:get-certificate-xml
|
This function returns the XML representation of the certificate for the
specified id and common host name combination.
|
|
pki:get-certificates
|
This function returns the certificate data for the specified certificates.
|
|
pki:get-certificates-for-template
|
This function returns all of the certificates for the specified certificate template.
|
|
pki:get-certificates-for-template-xml
|
This function returns all of the certificates for the specified
certificate template in XML format.
|
|
pki:get-pending-certificate-request
|
This function returns any pending certificate requests for the specified
template id and host combination.
|
|
pki:get-pending-certificate-requests-pem
|
This function returns any pending certificate requests for the specified template.
|
|
pki:get-pending-certificate-requests-xml
|
This function returns any pending certificate requests for the specified template.
|
|
pki:get-template
|
This function returns the certificate template for the
specified id.
|
|
pki:get-template-by-name
|
This function returns the certificate template with the specified name.
|
|
pki:get-template-certificate-authority
|
This function returns the certificate authority for the specified certificate
template.
|
|
pki:get-template-ids
|
This function returns the ids for all of the certificate
templates.
|
|
pki:get-trusted-certificate-ids
|
This function returns the ids of all of the trusted certificates in the
Security database.
|
|
pki:insert-certificate-revocation-list
|
This function inserts a PEM- or DER-encoded Certificate Revocation List
(CRL) into the security database.
|
|
pki:insert-signed-certificates
|
This function inserts one or more PEM-encoded signed certificates into the database.
|
|
pki:insert-template
|
This function inserts the specified certificate request template into the
Security database and returns the certificate template id.
|
|
pki:insert-trusted-certificates
|
This function inserts PEM-encoded certificates into the database
without checking
for a matching certificate request.
|
|
pki:is-temporary
|
This function returns true if the certificate is temporary.
|
|
pki:need-certificate
|
This function returns true if the certificate specified by the template id and host
combination are not signed by a trusted certificate authority.
|
|
pki:template-get-description
|
This function returns the description of the specified certificate template.
|
|
pki:template-get-id
|
This function returns the id of the specified certificate template.
|
|
pki:template-get-key-options
|
This function returns all of the template key options set in the
specified certificate template.
|
|
pki:template-get-key-type
|
This function returns the key type for the specified certificate template.
|
|
pki:template-get-name
|
This function returns the name of the specified certificate template.
|
|
pki:template-get-request
|
This function returns the request portion of the certificate template.
|
|
pki:template-get-version
|
This function returns the version number for the specified certificate template.
|
|
pki:template-in-use
|
This function checks whether a certificate template is in
use by an App Server.
|
|
pki:template-set-description
|
This function changes the description of the specified certificate
template and returns the XML containing the change.
|
|
pki:template-set-key-options
|
This function sets the options for generating new keys in the
specified certificate template.
|
|
pki:template-set-key-type
|
This function changes the key type for the specified certificate
template and returns the XML containing the change.
|
|
pki:template-set-name
|
This function changes the name of the specified certificate
template and returns the XML containing the change.
|
|
pki:template-set-request
|
This function sets the request portion for the specified
certificate template.
|
|
search:check-options
|
This function verifies that options XML is
properly structured.
|
|
search:estimate
|
This function quickly estimates the number of hits
a query will return.
|
|
search:get-default-options
|
This function returns the default options XML.
|
|
search:parse
|
This function parses query text according to given options and returns the
appropriate cts:query XML.
|
|
search:remove-constraint
|
This function safely removes a token from query text, ensuring that grammar
elements (AND, OR, quotes, parentheses) are handled properly.
|
|
search:resolve
|
This function is the same as
search:search, except that it takes
a parsed and annotated cts:query XML tree as
input.
|
|
search:resolve-nodes
|
This function performs the same search as
search:search, but it takes
a parsed and annotated cts:query XML tree as
input and returns the actual result nodes from the database.
|
|
search:search
|
This function parses and invokes a query according to
specified options, returning up to $page-length result nodes
starting from $start.
|
|
search:snippet
|
This function extracts matching text from the
result node based on options, and returns the matches
wrapped in a containing node, with highlights
tagged.
|
|
search:suggest
|
This function returns a sequence of suggested text
strings that match a wildcarded search for the
$qtext input, ready for use in a user
interface.
|
|
search:unparse
|
This function turns a serialized and annotated
cts:query (typically from
search:parse) back into
query text according to the specified rules.
|
|
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-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-roles
|
Removes references to the role ($role-name) from all 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-children
|
This function returns the IDs of roles of all
roles inherited by the specified role(s), including roles
directly assigned to the role and roles inherited from other
roles.
|
|
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.
|
|
sec:validate-permissions
|
This function throws the SEC_NOPERMCAP exception if
a permission has no capability specified and it throws the
SEC-NOPERMROLEID exception if there is no role specified in
the permission.
|
|
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:load
|
Add the words from the file specified in $path to the dictionary at $uri.
|
|
spell:make-dictionary
|
Creates a dictionary node from a sequence of words.
|
|
spell:remove-word
|
Remove the word $word from the dictionary at $uri.
|
|
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.
|
|
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.
|