MarkLogic 9 Product Documentationadmin functions (database)
For the complete list of functions and categories in this namespace, refer to the main admin functions page.
392 functions
| Function name | Description |
|---|---|
| admin:bucket-assignment-policy | This function returns an element that represents the bucket assignment policy. |
| admin:database-add-backup | This function adds scheduled backup specifications for a database to a configuration. |
| admin:database-add-default-ruleset | This function adds a ruleset (db:ruleset) to be used for inference on a database. |
| admin:database-add-element-attribute-word-lexicon | This function adds an element attribute word lexicon to the specified database in the configuration. |
| admin:database-add-element-word-lexicon | This function adds an element word lexicon to the specified database in the configuration. |
| admin:database-add-element-word-query-through | This function adds an element word query through to the specified database in the configuration. |
| admin:database-add-field | This function adds the field specification to the specified database in the configuration. |
| admin:database-add-field-excluded-element | This function adds the field excluded element specification in the specified database in the configuration. |
| admin:database-add-field-included-element | This function adds the field included element specification tn the specified database in the configuration. |
| admin:database-add-field-paths | This function adds given paths to the field specified by field-name. |
| admin:database-add-field-tokenizer-override | This function adds tokenizer overrides for the specified field of the specified database. |
| admin:database-add-field-word-lexicon | This function adds a word lexicon to the specified database in the configuration. |
| admin:database-add-foreign-replicas | This function adds one or more replica databases to the database replication configuration. |
| admin:database-add-fragment-parent | This function adds the specified fragment parent to the specified database in the configuration. |
| admin:database-add-fragment-root | This function adds the specified fragment root to the specified database in the configuration. |
| admin:database-add-geospatial-element-attribute-pair-index | This function adds a geospatial element attribute pair index to the specified database in the configuration. |
| admin:database-add-geospatial-element-child-index | This function adds a geospatial element child index to the specified database in the configuration. |
| admin:database-add-geospatial-element-index | This function adds a range element index to the specified database in the configuration. |
| admin:database-add-geospatial-element-pair-index | This function adds a geospatial element pair index to the specified database in the configuration. |
| admin:database-add-geospatial-path-index | This function adds a range path index to the specified database in the configuration. |
| admin:database-add-geospatial-region-path-index | This function adds a geospatial region path index to the specified database in the configuration. |
| admin:database-add-merge-blackout | This function adds a merge blackout specification for a database to a configuration. |
| admin:database-add-path-namespace | Add one or more namespaces to a database configuration, which will predefine the namespace(s) for all XPath expressions used in range index definitions. |
| admin:database-add-phrase-around | This function adds a phrase around to the specified database in the configuration. |
| admin:database-add-phrase-through | This function adds a phrase through to the specified database in the configuration. |
| admin:database-add-range-element-attribute-index | This function adds a range element attribute index to the specified database in the configuration. |
| admin:database-add-range-element-index | This function adds a range element index to the specified database in the configuration. |
| admin:database-add-range-field-index | This function adds a range field index to the specified database in the configuration. |
| admin:database-add-range-path-index | This function adds a range path index to the specified database in the configuration. |
| admin:database-add-word-lexicon | This function adds a word lexicon to the specified database in the configuration. |
| admin:database-add-word-query-excluded-element | This function adds the word query excluded element specification for the specified database to the configuration. |
| admin:database-add-word-query-included-element | This function adds the word query included element specification to the specified database in the configuration. |
| admin:database-attach-forest | This function attaches the specified forest to the specified database. |
| admin:database-attach-sub-database | This function adds a sub-database to a super-database. |
| admin:database-backup-get-enabled | This function returns true or false to indicate whether a specific backup is enabled for a database. |
| admin:database-backup-set-enabled | This function enables database backup for the specified database. |
| admin:database-copy | This function creates a new database specification with the same settings as the database with the specified ID. |
| admin:database-create | This function creates a new database specification. |
| admin:database-daily-backup | This function constructs a daily scheduled database backup specification. |
| admin:database-daily-incremental-backup | This function constructs a daily scheduled incremental database backup specification. |
| admin:database-delete | This function deletes the configuration from the specified database(s). |
| admin:database-delete-all-range-field-indexes | This function deletes all the range field indexes on given fields for the specified database in the configuration. |
| admin:database-delete-backup | This function deletes scheduled backup specifications for a database from a configuration. |
| admin:database-delete-backup-by-id | This function deletes a specific database backup, identified by the backup ID. |
| admin:database-delete-default-ruleset | This function deletes the default ruleset used for inference on a database. |
| admin:database-delete-element-attribute-word-lexicon | This function deletes an element attribute word lexicon for the specified database from the configuration. |
| admin:database-delete-element-word-lexicon | This function deletes an element word lexicon for the specified database from the configuration. |
| admin:database-delete-element-word-query-through | This function deletes an element word query through for the specified database from the configuration. |
| admin:database-delete-field | This function deletes the field specification in the specified database from the configuration. |
| admin:database-delete-field-excluded-element | This function deletes the field excluded element specification in the specified database from the configuration. |
| admin:database-delete-field-included-element | This function deletes the field included element specification in the specified database from the configuration. |
| admin:database-delete-field-paths | This function deletes paths from a specified field. |
| admin:database-delete-field-tokenizer-override | This function deletes the field's tokenizer override in the specified database from the configuration. |
| admin:database-delete-field-word-lexicon | This function deletes a word lexicon for the specified database from the configuration. |
| admin:database-delete-foreign-master | This function removes the specified master database from the database replication configuration on the replica host. |
| admin:database-delete-foreign-replicas | This function deletes the foreign replica database configurations for the specified master database. |
| admin:database-delete-fragment-parent | This function deletes the specified fragment parent in the specified database from the configuration. |
| admin:database-delete-fragment-root | This function deletes the specified fragment root in the specified database from the configuration. |
| admin:database-delete-geospatial-element-attribute-pair-index | This function deletes a geospatial element attribute pair index in the specified database from the configuration. |
| admin:database-delete-geospatial-element-child-index | This function deletes a geospatial element child index for the specified database in the configuration. |
| admin:database-delete-geospatial-element-index | This function deletes a geospatial element index for the specified database in the configuration. |
| admin:database-delete-geospatial-element-pair-index | This function deletes a geospatial element pair index for the specified database from the configuration. |
| admin:database-delete-geospatial-path-index | This function deletes a geospatial path index for the specified database in the configuration. |
| admin:database-delete-geospatial-region-path-index | This function deletes a geospatial region path index to the specified database in the configuration. |
| admin:database-delete-merge-blackout | This function deletes a merge blackout specification for a database from a configuration. |
| admin:database-delete-path-namespace | This function deletes the specified namespaces from the configuration for the specified database. |
| admin:database-delete-phrase-around | This function deletes a phrase around for the specified database from the configuration. |
| admin:database-delete-phrase-through | This function deletes a phrase through for the specified database from the configuration. |
| admin:database-delete-range-element-attribute-index | This function deletes a range element attribute index for the specified database in the configuration. |
| admin:database-delete-range-element-index | This function deletes a range element index for the specified database in the configuration. |
| admin:database-delete-range-field-index | This function deletes a range field index for the specified database in the configuration. |
| admin:database-delete-range-path-index | This function deletes a range path index for the specified database in the configuration. |
| admin:database-delete-word-lexicon | This function deletes a word lexicon for the specified database from the configuration. |
| admin:database-delete-word-query-excluded-element | This function deletes the word query excluded element specification in the specified database from the configuration. |
| admin:database-delete-word-query-included-element | This function deletes the word query included element specification in the specified database from the configuration. |
| admin:database-detach-forest | This function detaches the specified forest from the specified database. |
| admin:database-detach-sub-database | This function removes a sub-database from a super-database. |
| admin:database-element-attribute-reference | This function greated a db:element-attribute-reference specification. |
| admin:database-element-attribute-word-lexicon | This function constructs an element attribute word lexicon specification. |
| admin:database-element-reference | This function greated a db:element-reference specification. |
| admin:database-element-word-lexicon | This function constructs an element word lexicon specification. |
| admin:database-element-word-query-through | This function constructs an element word query through specification. |
| admin:database-employ-forest | This function "employs" the specified forest in the configuration. |
| admin:database-excluded-element | This function constructs an excluded element specification. |
| admin:database-exists | This function determines whether or not the specified database exists. |
| admin:database-field | This function constructs a field specification. |
| admin:database-field-path | This function is a constructor for field-path element. |
| admin:database-field-reference | This function creates a db:field-reference specification. |
| admin:database-foreign-master | This function returns a master database configuration. |
| admin:database-foreign-master-get-cluster-id | This function returns the id of the cluster from the specified foreign master configuration. |
| admin:database-foreign-master-get-connect-forests-by-name | This function returns the connect-forests-by-name setting from the master database configuration. |
| admin:database-foreign-master-get-database-id | This function returns the id of the foreign master database. |
| admin:database-foreign-replica | This function returns a replica database configuration. |
| admin:database-foreign-replica-get-cluster-id | This function returns the id of the replica cluster from the replica database configuration. |
| admin:database-foreign-replica-get-connect-forests-by-name | This function returns the connect-forests-by-name setting from the replica database configuration. |
| admin:database-foreign-replica-get-database-id | This function returns the id of the replica database from the replica database configuration. |
| admin:database-foreign-replica-get-lag-limit | This function returns the lag limit value from the replica database configuration. |
| admin:database-foreign-replica-get-queue-size | This function returns the queue size for the number of fragments or frames in-flight during database replication. |
| admin:database-foreign-replica-get-replication-enabled | This function returns the enabled flag from the replica database configuration. |
| admin:database-foreign-replica-set-lag-limit | This function sets the lag limit value on a replica database configuration. |
| admin:database-foreign-replica-set-queue-size | This function sets the queue size for the number of fragments or frames in-flight during database replication. |
| admin:database-foreign-replica-set-replication-enabled | This function sets the enabled flag on a replica database configuration. |
| admin:database-fragment-parent | This function constructs a fragment parent specification. |
| admin:database-fragment-root | This function constructs a fragment root specification. |
| admin:database-geospatial-element-attribute-pair-index | This function constructs a geospatial element attribute pair index specification. |
| admin:database-geospatial-element-child-index | This function constructs a geospatial element child index specification. |
| admin:database-geospatial-element-index | This function constructs a geospatial element index specification. |
| admin:database-geospatial-element-pair-index | This function constructs a geospatial element pair index specification. |
| admin:database-geospatial-path-index | This function constructs a geospatial path index specification. |
| admin:database-geospatial-region-path-index | This function constructs a geospatial region path index specification. |
| admin:database-get-assignment-policy | This function returns the assignment policy for the specified database from the configuration. |
| admin:database-get-attached-forests | This function returns the attached forest IDs for the specified database from the configuration. |
| admin:database-get-attribute-value-positions | This function returns the attribute value positions setting for the specified database from the configuration. |
| admin:database-get-backups | This function returns the scheduled backups for the specified database from the configuration. |
| admin:database-get-collection-lexicon | This function returns the collection lexicon setting for the specified database from the configuration. |
| admin:database-get-config-for-foreign-master-on-foreign-cluster | This function returns the master configuration on a foreign cluster. |
| admin:database-get-config-for-foreign-replicas-on-foreign-cluster | This function returns the replica configuration on a foreign cluster. |
| admin:database-get-data-encryption | This function returns the encryption setting for the database ID by database-id. |
| admin:database-get-default-rulesets | This function returns the default rulesets for a database. |
| admin:database-get-directory-creation | This function returns the directory creation setting for the specified database from the configuration. |
| admin:database-get-element-attribute-word-lexicons | This function returns the element attribute word lexicons specification(s) for the specified database from the configuration. |
| admin:database-get-element-value-positions | This function returns the element value positions setting for the specified database from the configuration. |
| admin:database-get-element-word-lexicons | This function returns the element word lexicons specification(s) for the specified database from the configuration. |
| admin:database-get-element-word-positions | This function returns the element word positions setting for the specified database from the configuration. |
| admin:database-get-element-word-query-throughs | This function returns the element word query throughs specification(s) for the specified database from the configuration. |
| admin:database-get-enabled | This function returns the enabled value for the specified database from the configuration. |
| admin:database-get-expunge-locks | This function returns the expunge locks setting for the specified database from the configuration. |
| admin:database-get-fast-case-sensitive-searches | This function returns the fast case sensitive searches setting for the specified database from the configuration. |
| admin:database-get-fast-diacritic-sensitive-searches | This function returns the fast diacritic sensitive searches setting for the specified database from the configuration. |
| admin:database-get-fast-element-character-searches | This function returns the fast element character searches setting for the specified database from the configuration. |
| admin:database-get-fast-element-phrase-searches | This function returns the fast element phrase searches setting for the specified database from the configuration. |
| admin:database-get-fast-element-trailing-wildcard-searches | This function returns the trailing wildcard searches setting for the specified database from the configuration. |
| admin:database-get-fast-element-word-searches | This function returns the fast element word searches setting for the specified database from the configuration. |
| admin:database-get-fast-phrase-searches | This function returns the fast phrase searches setting for the specified database from the configuration. |
| admin:database-get-fast-reverse-searches | This function returns the fast reverse searches setting for the specified database from the configuration. |
| admin:database-get-field | This function returns the field specification for the specified database from the configuration. |
| admin:database-get-field-excluded-elements | This function returns the field excluded elements specification for the specified database from the configuration. |
| admin:database-get-field-fast-case-sensitive-searches | This function returns true if the fast case sensitive searches setting for the specified field is enabled. |
| admin:database-get-field-fast-diacritic-sensitive-searches | This function returns true if the fast diacritic sensitive searches setting for the specified field is enabled. |
| admin:database-get-field-fast-phrase-searches | This function returns true if the fast phrase searches setting for the specified field is enabled. |
| admin:database-get-field-include-document-root | This function returns the field include document root setting for the specified field from the configuration. |
| admin:database-get-field-included-elements | This function returns the fields included elements specification for the specified database from the configuration. |
| admin:database-get-field-one-character-searches | This function returns true if the one character searches setting for the specified field is enabled. |
| admin:database-get-field-paths | This function returns all the paths on a given field. |
| admin:database-get-field-stemmed-searches | This function returns stemmed searches setting for the specified field if configured. |
| admin:database-get-field-three-character-searches | This function returns true if the three character searches setting for the specified field is enabled. |
| admin:database-get-field-three-character-word-positions | This function returns true if the three character word positions setting for the specified field is enabled. |
| admin:database-get-field-tokenizer-overrides | This function fetches any custom tokenizer override specifications for the specified field and database. |
| admin:database-get-field-trailing-wildcard-searches | This function returns true if the trailing wildcard searches setting for the specified field is enabled. |
| admin:database-get-field-trailing-wildcard-word-positions | This function returns true if the trailing wildcard word positions setting for the specified field is enabled. |
| admin:database-get-field-two-character-searches | This function returns true if the two character searches setting for the specified field is enabled. |
| admin:database-get-field-value-positions | This function gets the field value positions setting for the specified database in the configuration. |
| admin:database-get-field-value-searches | This function returns the field value search setting for the specified field. |
| admin:database-get-field-word-lexicons | This function returns the word lexicons specification(s) for the specified database from the configuration. |
| admin:database-get-field-word-searches | This function returns true if the word searches setting for the specified field is enabled. |
| admin:database-get-fields | This function returns the fields specification(s) for the specified database from the configuration. |
| admin:database-get-foreign-master | This function returns the configuration for the foreign master database. |
| admin:database-get-foreign-replicas | This function returns the configuration elements of the replica databases associated with the master database specified by database-id. |
| admin:database-get-format-compatibility | This function returns the format compatibility setting for the specified database from the configuration. |
| admin:database-get-fragment-parents | This function returns the fragment parents specification for the specified database from the configuration. |
| admin:database-get-fragment-roots | This function returns the fragment roots specification for the specified database from the configuration. |
| admin:database-get-geospatial-element-attribute-pair-indexes | This function returns the geospatial element attribute pair indexes specification(s) for the specified database from the configuration. |
| admin:database-get-geospatial-element-child-indexes | This function returns the geospatial element child indexes specification(s) for the specified database from the configuration. |
| admin:database-get-geospatial-element-indexes | This function returns the geospatial element indexes specification(s) for the specified database from the configuration. |
| admin:database-get-geospatial-element-pair-indexes | This function returns the geospatial element pair indexes specification(s) for the specified database from the configuration. |
| admin:database-get-geospatial-path-indexes | This function returns the geospatial path indexes specification(s) for the specified database from the configuration. |
| admin:database-get-geospatial-region-path-indexes | This function returns the geospatial region path index specification(s) for the specified database in the configuration. |
| admin:database-get-id | This function returns the ID for the specified database from the configuration. |
| admin:database-get-in-memory-geospatial-region-index-size | This function returns the in memory geospatial region index size setting for the specified database from the configuration. |
| admin:database-get-in-memory-limit | This function returns the in memory limit setting for the specified database from the configuration. |
| admin:database-get-in-memory-list-size | This function returns the in memory list size setting for the specified database from the configuration. |
| admin:database-get-in-memory-range-index-size | This function returns the in memory range index size setting for the specified database from the configuration. |
| admin:database-get-in-memory-reverse-index-size | This function returns the in memory reverse index size setting for the specified database from the configuration. |
| admin:database-get-in-memory-tree-size | This function returns the in memory tree size setting for the specified database from the configuration. |
| admin:database-get-in-memory-triple-index-size | This function returns the in memory triple index size setting (in megabytes) for the specified database from the configuration. |
| admin:database-get-index-detection | This function returns the index detection setting for the specified database from the configuration. |
| admin:database-get-inherit-collections | This function returns the inherit collections setting for the specified database from the configuration. |
| admin:database-get-inherit-permissions | This function returns the inherit positions setting for the specified database from the configuration. |
| admin:database-get-inherit-quality | This function returns the inherit quality setting for the specified database from the configuration. |
| admin:database-get-journal-size | This function returns the journal size setting for the specified database from the configuration. |
| admin:database-get-journaling | This function returns the journaling setting for the specified database in the configuration. |
| admin:database-get-language | This function returns the language for the specified database from the configuration. |
| admin:database-get-large-size-threshold | This function returns the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs). |
| admin:database-get-locking | This function returns the locking setting for the specified database in the configuration. |
| admin:database-get-maintain-directory-last-modified | This function returns the maintain directory last modified setting for the specified database from the configuration. |
| admin:database-get-maintain-last-modified | This function returns the maintain last modified setting for the specified database from the configuration. |
| admin:database-get-merge-blackouts | This function returns the merge blackouts specification for the specified database from the configuration. |
| admin:database-get-merge-max-size | This function returns the merge max size setting for the specified database from the configuration. |
| admin:database-get-merge-min-ratio | This function returns the merge min ratio setting for the specified database from the configuration. |
| admin:database-get-merge-min-size | This function returns the merge min size setting for the specified database from the configuration. |
| admin:database-get-merge-priority | This function returns the CPU scheduler priority for merges for the specified database from the configuration. |
| admin:database-get-merge-timestamp | This function returns the merge timestamp setting for the specified database from the configuration. |
| admin:database-get-name | This function returns the name for the specified database from the configuration. |
| admin:database-get-one-character-searches | This function returns the one character searches setting for the specified database from the configuration. |
| admin:database-get-path-namespaces | This function returns the value of any namespace definitions predefined for the specified database. |
| admin:database-get-phrase-arounds | This function returns the phrase arounds specification(s) for the specified database from the configuration. |
| admin:database-get-phrase-throughs | This function returns the phrase throughs specification(s) for the specified database from the configuration. |
| admin:database-get-positions-list-max-size | This function returns the positions list max size setting for the specified database from the configuration. |
| admin:database-get-preallocate-journals | This function returns the preallocate journals setting for the specified database from the configuration. |
| admin:database-get-preload-mapped-data | This function returns the preload mapped data setting for the specified database from the configuration. |
| admin:database-get-preload-replica-mapped-data | This function returns the preload replica mapped data setting for the specified database from the configuration. |
| admin:database-get-range-element-attribute-indexes | This function returns the range element attribute indexes specification(s) for the specified database from the configuration. |
| admin:database-get-range-element-indexes | This function returns the range element indexes specification(s) for the specified database from the configuration. |
| admin:database-get-range-field-indexes | This function returns the range field indexes specification(s) for the specified database from the configuration. |
| admin:database-get-range-index-optimize | This function returns the range index optimize setting for the specified database from the configuration. |
| admin:database-get-range-path-indexes | This function returns the range path indexes specification(s) for the specified database from the configuration. |
| admin:database-get-range-policy-partition-key | This function returns the range policy partition key set for the database. |
| admin:database-get-rebalancer-enable | This function returns the rebalancer enable setting for the specified database from the configuration. |
| admin:database-get-rebalancer-throttle | This function returns the rebalancer throttle setting for the specified database from the configuration. |
| admin:database-get-reindexer-enable | This function returns the reindexer enable setting for the specified database from the configuration. |
| admin:database-get-reindexer-throttle | This function returns the reindexer throttle setting for the specified database from the configuration. |
| admin:database-get-reindexer-timestamp | This function returns the reindexer timestamp setting for the specified database from the configuration. |
| admin:database-get-retain-until-backup | This function returns the "retain until backup" setting from the configuration for the specified database. |
| admin:database-get-retired-forests | This function returns the list of all retired forests for the specified database from the configuration. |
| admin:database-get-schema-database | This function returns the ID of the schema database for the specified database from the configuration. |
| admin:database-get-security-database | This function returns the ID of the security database for the specified database from the configuration. |
| admin:database-get-stemmed-searches | This function returns the stemmed searches setting for the specified database from the configuration. |
| admin:database-get-tf-normalization | This function returns the current term-frequency normalization setting for the database. |
| admin:database-get-three-character-searches | This function returns the three character searches setting for the specified database from the configuration. |
| admin:database-get-three-character-word-positions | This function returns the three character word positions setting for the specified database from the configuration. |
| admin:database-get-trailing-wildcard-searches | This function returns the trailing wildcard searches setting for the specified database from the configuration. |
| admin:database-get-trailing-wildcard-word-positions | This function returns the trailing wildcard word positions setting for the specified database from the configuration. |
| admin:database-get-triggers-database | This function returns the ID of the triggers database for the specified database from the configuration. |
| admin:database-get-triple-index | This function returns true if the triple index is enabled for the specified database, false if it is not enabled. |
| admin:database-get-triple-positions | This function returns triple positions setting of a database. |
| admin:database-get-two-character-searches | This function returns the two character searches setting for the specified database from the configuration. |
| admin:database-get-uri-lexicon | This function returns the URI lexicon setting for the specified database from the configuration. |
| admin:database-get-word-lexicons | This function returns the word lexicons specification(s) for the specified database from the configuration. |
| admin:database-get-word-positions | This function returns the word positions setting for the specified database from the configuration. |
| admin:database-get-word-query-excluded-elements | This function returns the word query excluded elements setting for the specified database from the configuration. |
| admin:database-get-word-query-fast-case-sensitive-searches | This function returns true if the word query fast case sensitive searches setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-fast-diacritic-sensitive-searches | This function returns true if the word query fast diacritic sensitive searches setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-fast-phrase-searches | This function returns true if the word query fast phrase searches setting for the specified database is set in the configuration. |
| admin:database-get-word-query-include-document-root | This function returns the word query include document root setting for the specified database from the configuration. |
| admin:database-get-word-query-included-elements | This function returns the word query included elements setting for the specified database from the configuration. |
| admin:database-get-word-query-one-character-searches | This function returns true if the word query one character searches setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-stemmed-searches | This function returns the reindexer word query stemmed searches setting for the specified database from the configuration. |
| admin:database-get-word-query-three-character-searches | This function returns true if the word query three character searches setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-three-character-word-positions | This function returns true if the word query three character word positions setting is enabled for the specified database from the configuration. |
| admin:database-get-word-query-trailing-wildcard-searches | This function returns true if the word query trailing wildcard searches setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-trailing-wildcard-word-positions | This function returns true if the word query trailing wildcard word positions setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-two-character-searches | This function returns true if the word query two character searches setting is enabled for the specified database in the configuration. |
| admin:database-get-word-query-word-searches | This function returns true if the word query searches setting for the specified database is enabled in the configuration. |
| admin:database-get-word-searches | This function returns the word searches setting for the specified database from the configuration. |
| admin:database-hourly-backup | This function constructs an hourly scheduled database backup specification. |
| admin:database-hourly-incremental-backup | This function constructs an hourly scheduled incremental database backup specification. |
| admin:database-in-use-path-namespace-prefixes | This function returns the prefixes of all the namespaces that are in use by some path or geospatial path index. |
| admin:database-included-element | This function constructs an included element specification. |
| admin:database-is-forest-employed | This function returns fn:true() if the specified forest is employed and fn:false() the specified forest is not employed. |
| admin:database-is-forest-retired | This function returns fn:true() if the specified forest is retired and fn:false() the specified forest is not retired. |
| admin:database-metadata-field | This function constructs a metadata field specification. |
| admin:database-minutely-backup | This function constructs a scheduled database backup specification on a number-of-minutes basis. |
| admin:database-minutely-incremental-backup | This function constructs a scheduled incremental database backup specification based on a number of minutes. |
| admin:database-monthly-backup | This function constructs a monthly scheduled backup specification. |
| admin:database-monthly-incremental-backup | This function constructs a scheduled monthly incremental backup specification. |
| admin:database-one-time-backup | This function constructs a one-time backup specification. |
| admin:database-one-time-incremental-backup | This function constructs a one-time incremental backup specification. |
| admin:database-one-time-merge-blackout | This function constructs a one-time merge-blackout specification. |
| admin:database-path-field | This function constructs a field specification that has field paths. |
| admin:database-path-namespace | This function constructs a namespace element with the specified prefix and URI. |
| admin:database-path-reference | This function creates a db:path-reference specification. |
| admin:database-phrase-around | This function constructs a phrase through specification. |
| admin:database-phrase-through | This function constructs a phrase through specification. |
| admin:database-range-element-attribute-index | This function constructs a range element attribute index specification. |
| admin:database-range-element-index | This function constructs a range element index specification. |
| admin:database-range-field-index | This function constructs a range field index specification. |
| admin:database-range-path-index | This function constructs a path range index specification. |
| admin:database-recurring-merge-blackout | This function constructs a merge-blackout specification. |
| admin:database-reorder-forests | This function reorders the forests in the specified database. |
| admin:database-retire-forest | This function "retires" the specified forest in the configuration. |
| admin:database-ruleset | The ruleset element (db:default-ruleset) created to be used for inference on a database. |
| admin:database-set-assignment-policy | This function sets the assignment policy for the specified database in the configuration. |
| admin:database-set-attribute-value-positions | This function sets the attribute value positions setting for the specified database in the configuration. |
| admin:database-set-collection-lexicon | This function sets the collection lexicon setting for the specified database in the configuration. |
| admin:database-set-data-encryption | This function sets the encryption setting for the database identified by database-id. |
| admin:database-set-directory-creation | This function sets the directory creation setting for the specified database in the configuration. |
| admin:database-set-element-value-positions | This function sets the element value positions setting for the specified database in the configuration. |
| admin:database-set-element-word-positions | This function sets the element word positions setting for the specified database in the configuration. |
| admin:database-set-enabled | This function sets the enabled value for the specified database in the configuration. |
| admin:database-set-expunge-locks | This function sets the expunge locks setting for the specified database in the configuration. |
| admin:database-set-fast-case-sensitive-searches | This function sets the fast case sensitive searches setting for the specified database in the configuration. |
| admin:database-set-fast-diacritic-sensitive-searches | This function sets the fast diacritic-sensitive searches setting for the specified database in the configuration. |
| admin:database-set-fast-element-character-searches | This function sets the fast element character searches setting for the specified database in the configuration. |
| admin:database-set-fast-element-phrase-searches | This function sets the fast element phrase searches setting for the specified database in the configuration. |
| admin:database-set-fast-element-trailing-wildcard-searches | This function sets the fast element trailing wildcard searches setting for the specified database in the configuration. |
| admin:database-set-fast-element-word-searches | This function sets the element word searches setting for the specified database in the configuration. |
| admin:database-set-fast-phrase-searches | This function sets the fast phrase searches setting for the specified database in the configuration. |
| admin:database-set-fast-reverse-searches | This function sets the fast reverse searches setting for the specified database in the configuration. |
| admin:database-set-field-fast-case-sensitive-searches | This function sets the field fast case sensitive searches setting for the specified field in the configuration. |
| admin:database-set-field-fast-diacritic-sensitive-searches | This function sets the field fast diacritic sensitive searches setting for the specified field in the configuration. |
| admin:database-set-field-fast-phrase-searches | This function sets the field fast phrase searches setting for the specified field in the configuration. |
| admin:database-set-field-include-document-root | This function sets the field include document root setting for the specified field in the configuration. |
| admin:database-set-field-name | This function sets the field name setting for the specified field in the configuration. |
| admin:database-set-field-one-character-searches | This function sets the field one character searches setting for the specified field in the configuration. |
| admin:database-set-field-stemmed-searches | This function sets the field stemmed searches setting for the specified field in the configuration. |
| admin:database-set-field-three-character-searches | This function sets the field three character searches setting for the specified field in the configuration. |
| admin:database-set-field-three-character-word-positions | This function sets the field three character word positions setting for the specified field in the configuration. |
| admin:database-set-field-trailing-wildcard-searches | This function sets the field trailing wildcard searches setting for the specified database in the configuration. |
| admin:database-set-field-trailing-wildcard-word-positions | This function sets the field trailing wildcard word positions setting for the specified field in the configuration. |
| admin:database-set-field-two-character-searches | This function sets the field two character searches setting for the specified field in the configuration. |
| admin:database-set-field-value-positions | This function sets the field value positions setting for the specified database in the configuration. |
| admin:database-set-field-value-searches | This function sets the field value searches setting for the specified database in the configuration. |
| admin:database-set-field-word-searches | This function sets the field word searches setting for the specified field in the configuration. |
| admin:database-set-foreign-master | This function configures the specified replica database to receive replicated data from the specified foreign master. |
| admin:database-set-foreign-replicas | This function sets the foreign replica database configuration. |
| admin:database-set-format-compatibility | This function sets the format compatibility setting for the specified database in the configuration. |
| admin:database-set-in-memory-geospatial-region-index-size | This function sets the in-memory geospatial region index size setting for the specified database in the configuration. |
| admin:database-set-in-memory-limit | This function sets the in-memory limit setting for the specified database in the configuration. |
| admin:database-set-in-memory-list-size | This function sets the in-memory list size setting for the specified database in the configuration. |
| admin:database-set-in-memory-range-index-size | This function sets the in-memory range index size setting for the specified database in the configuration. |
| admin:database-set-in-memory-reverse-index-size | This function sets the in-memory range reverse index size setting for the specified database in the configuration. |
| admin:database-set-in-memory-tree-size | This function sets the in-memory tree size setting for the specified database in the configuration. |
| admin:database-set-in-memory-triple-index-size | This function sets the size, in megabytes, of the in-memory triple index. |
| admin:database-set-index-detection | This function sets the index detection setting for the specified database in the configuration. |
| admin:database-set-inherit-collections | This function sets the inherit collections setting for the specified database in the configuration. |
| admin:database-set-inherit-permissions | This function sets the inherit permissions setting for the specified database in the configuration. |
| admin:database-set-inherit-quality | This function sets the inherit quality setting for the specified database in the configuration. |
| admin:database-set-journal-size | This function sets the journal size setting for the specified database in the configuration. |
| admin:database-set-journaling | This function sets the journaling setting for the specified database in the configuration. |
| admin:database-set-language | This function sets the language for the specified database in the configuration. |
| admin:database-set-large-size-threshold | This function sets the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs). |
| admin:database-set-locking | This function sets the locking setting for the specified database in the configuration. |
| admin:database-set-maintain-directory-last-modified | This function sets the maintain directory last modified setting for the specified database in the configuration. |
| admin:database-set-maintain-last-modified | This function sets the maintain last modified setting for the specified database in the configuration. |
| admin:database-set-merge-max-size | This function sets the merge max size setting for the specified database in the configuration. |
| admin:database-set-merge-min-ratio | This function sets the merge min ratio setting for the specified database in the configuration. |
| admin:database-set-merge-min-size | This function sets the merge minimum size setting for the specified database in the configuration. |
| admin:database-set-merge-priority | This function sets the CPU scheduler priority for merges. |
| admin:database-set-merge-timestamp | This function sets the merge timestamp setting for the specified database in the configuration. |
| admin:database-set-name | This function changes the name of the database with the specified ID to the specified name. |
| admin:database-set-one-character-searches | This function sets the one character searches setting for the specified database in the configuration. |
| admin:database-set-positions-list-max-size | This function sets the positions list max size setting for the specified database in the configuration. |
| admin:database-set-preallocate-journals | This function sets the preallocate journals setting for the specified database in the configuration. |
| admin:database-set-preload-mapped-data | This function sets the preload mapped data setting for the specified database in the configuration. |
| admin:database-set-preload-replica-mapped-data | This function sets the preload-replica-mapped-data setting for the specified database. |
| admin:database-set-range-index-optimize | This function sets the range index optimize setting for the specified database in the configuration. |
| admin:database-set-rebalancer-enable | This function sets the reblanacer enable setting for the specified database in the configuration. |
| admin:database-set-rebalancer-throttle | This function sets the rebalancer throttle setting for the specified database in the configuration. |
| admin:database-set-reindexer-enable | This function sets the reindexer enable setting for the specified database in the configuration. |
| admin:database-set-reindexer-throttle | This function sets the reindexer throttle setting for the specified database in the configuration. |
| admin:database-set-reindexer-timestamp | This function sets the reindexer timestamp setting for the specified database in the configuration. |
| admin:database-set-retain-until-backup | This function sets "the retain until backup" setting in the configuration for the specified database. |
| admin:database-set-schema-database | This function sets the schema database for a database to the specified database in the configuration. |
| admin:database-set-security-database | This function sets the security database for a database to the specified database in the configuration. |
| admin:database-set-stemmed-searches | This function sets the stemmed searches setting for the specified database in the configuration. |
| admin:database-set-tf-normalization | This function specifies whether to use the default term-frequency normalization (scaled-log), which scales the term frequency based on the size of the document, or to use the unscaled-log, which uses term frequency as a function of the actual term frequency in a document, regardless of the document size. |
| admin:database-set-three-character-searches | This function sets the three character searches setting for the specified database in the configuration. |
| admin:database-set-three-character-word-positions | This function sets the three character word positions setting for the specified database in the configuration. |
| admin:database-set-trailing-wildcard-searches | This function sets the trailing wildcard searches setting for the specified database in the configuration. |
| admin:database-set-trailing-wildcard-word-positions | This function sets the trailing wildcard word positions setting for the specified database in the configuration. |
| admin:database-set-triggers-database | This function sets the triggers database to the specified database ID for the specified database in the configuration. |
| admin:database-set-triple-index | This function sets the triple index on or off for a database. |
| admin:database-set-triple-positions | This function sets the triple positions of a database to true or false. |
| admin:database-set-two-character-searches | This function sets the two character searches setting for the specified database in the configuration. |
| admin:database-set-uri-lexicon | This function sets the URI lexicon setting for the specified database in the configuration. |
| admin:database-set-word-positions | This function sets the word positions setting for the specified database in the configuration. |
| admin:database-set-word-query-fast-case-sensitive-searches | This function returns the word query fast case sensitive searches setting for the specified database from the configuration. |
| admin:database-set-word-query-fast-diacritic-sensitive-searches | This function sets the word query fast diacritic sensitive searches setting for the specified database in the configuration. |
| admin:database-set-word-query-fast-phrase-searches | This function sets the word query fast phrase searches setting for the specified database in the configuration. |
| admin:database-set-word-query-include-document-root | This function sets the word query include document root setting for the specified field in the configuration. |
| admin:database-set-word-query-one-character-searches | This function sets the word query one character searches setting for the specified field in the configuration. |
| admin:database-set-word-query-stemmed-searches | This function sets the word query stemmed searches setting for the specified database in the configuration. |
| admin:database-set-word-query-three-character-searches | This function sets the word query three character searches setting for the specified database in the configuration. |
| admin:database-set-word-query-three-character-word-positions | This function sets the word query three character word positions setting for the specified database in the configuration. |
| admin:database-set-word-query-trailing-wildcard-searches | This function sets the word query trailing wildcard searches setting for the specified database in the configuration. |
| admin:database-set-word-query-trailing-wildcard-word-positions | This function sets the word query trailing wildcard word positions setting for the specified database in the configuration. |
| admin:database-set-word-query-two-character-searches | This function sets the word query two character searches setting for the specified database in the configuration. |
| admin:database-set-word-query-word-searches | This function sets the word query word searches setting for the specified database in the configuration. |
| admin:database-set-word-searches | This function sets the word searches setting for the specified database in the configuration. |
| admin:database-sub-databases | This function returns a database-reference element representing the sub-databases of the specified super-database. |
| admin:database-super-databases | This function returns a database-reference element representing where the specified database serves as a sub-database. |
| admin:database-tokenizer-override | This function constructs a custom tokenizer override. |
| admin:database-validate-field-path | This function validates the specified field path. |
| admin:database-validate-field-paths | This function checks if the paths conform to the permissible XPath syntax. |
| admin:database-validate-path-fields | For a given sequence of fields, this function validates all the paths on each field using admin:database-validate-field-paths call. |
| admin:database-weekly-backup | This function constructs a weekly scheduled backup specification. |
| admin:database-weekly-incremental-backup | This function constructs a weekly scheduled incremental backup specification. |
| admin:database-word-lexicon | This function constructs a word lexicon specification. |
| admin:forest-foreign-master | This function creates a replication configuration element for the specified master forest. |
| admin:forest-foreign-master-get-cluster-id | This function returns the ID for the cluster from the foreign master forest configuration element. |
| admin:forest-foreign-replica | This function returns a replica forest configuration. |
| admin:forest-foreign-replica-get-cluster-id | This function returns the id of the replica cluster from the specified replica forest configuration element. |
| admin:forest-foreign-replica-get-database-id | This function returns the id of the replica database from the specified replica forest configuration element. |
| admin:forest-foreign-replica-get-forest-id | This function returns the id of the replica forest from the specified replica forest configuration element. |
| admin:forest-get-partition-number | This function returns the partition number for the specified forest. |
| admin:forest-set-partition-number | This function sets the partition number for the specified forest. |
| admin:get-database-ids | This function returns all the database IDs from the configuration. |
| admin:legacy-assignment-policy | This function returns an element that represents the legacy assignment policy. |
| admin:query-assignment-policy | This function returns an element that represents the query assignment policy. |
| admin:range-assignment-policy | This function returns an element that represents the range assignment policy. |
| admin:segment-assignment-policy | This function returns an element that represents the segment assignment policy. |
| admin:statistical-assignment-policy | This function returns an element that represents the statistical assignment policy. |