MarkLogic 12 EA 1 Product Documentationadmin functions (database)
For the complete list of functions and categories in this namespace, refer to the main admin functions page.
396 functions
| Function name | Description |
|---|---|
| admin.bucketAssignmentPolicy | This function returns an element that represents the bucket assignment policy. |
| admin.databaseAddBackup | This function adds scheduled backup specifications for a database to a configuration. |
| admin.databaseAddDefaultRuleset | This function adds a ruleset (db:ruleset) to be used for inference on a database. |
| admin.databaseAddElementAttributeWordLexicon | This function adds an element attribute word lexicon to the specified database in the configuration. |
| admin.databaseAddElementWordLexicon | This function adds an element word lexicon to the specified database in the configuration. |
| admin.databaseAddElementWordQueryThrough | This function adds an element word query through to the specified database in the configuration. |
| admin.databaseAddField | This function adds the field specification to the specified database in the configuration. |
| admin.databaseAddFieldExcludedElement | This function adds the field excluded element specification in the specified database in the configuration. |
| admin.databaseAddFieldIncludedElement | This function adds the field included element specification tn the specified database in the configuration. |
| admin.databaseAddFieldPaths | This function adds given paths to the field specified by field-name. |
| admin.databaseAddFieldTokenizerOverride | This function adds tokenizer overrides for the specified field of the specified database. |
| admin.databaseAddFieldWordLexicon | This function adds a word lexicon to the specified database in the configuration. |
| admin.databaseAddForeignReplicas | This function adds one or more replica databases to the database replication configuration. |
| admin.databaseAddFragmentParent | This function adds the specified fragment parent to the specified database in the configuration. |
| admin.databaseAddFragmentRoot | This function adds the specified fragment root to the specified database in the configuration. |
| admin.databaseAddGeospatialElementAttributePairIndex | This function adds a geospatial element attribute pair index to the specified database in the configuration. |
| admin.databaseAddGeospatialElementChildIndex | This function adds a geospatial element child index to the specified database in the configuration. |
| admin.databaseAddGeospatialElementIndex | This function adds a range element index to the specified database in the configuration. |
| admin.databaseAddGeospatialElementPairIndex | This function adds a geospatial element pair index to the specified database in the configuration. |
| admin.databaseAddGeospatialPathIndex | This function adds a range path index to the specified database in the configuration. |
| admin.databaseAddGeospatialRegionPathIndex | This function adds a geospatial region path index to the specified database in the configuration. |
| admin.databaseAddMergeBlackout | This function adds a merge blackout specification for a database to a configuration. |
| admin.databaseAddPathNamespace | Add one or more namespaces to a database configuration, which will predefine the namespace(s) for all XPath expressions used in range index definitions. |
| admin.databaseAddPhraseAround | This function adds a phrase around to the specified database in the configuration. |
| admin.databaseAddPhraseThrough | This function adds a phrase through to the specified database in the configuration. |
| admin.databaseAddRangeElementAttributeIndex | This function adds a range element attribute index to the specified database in the configuration. |
| admin.databaseAddRangeElementIndex | This function adds a range element index to the specified database in the configuration. |
| admin.databaseAddRangeFieldIndex | This function adds a range field index to the specified database in the configuration. |
| admin.databaseAddRangePathIndex | This function adds a range path index to the specified database in the configuration. |
| admin.databaseAddWordLexicon | This function adds a word lexicon to the specified database in the configuration. |
| admin.databaseAddWordQueryExcludedElement | This function adds the word query excluded element specification for the specified database to the configuration. |
| admin.databaseAddWordQueryIncludedElement | This function adds the word query included element specification to the specified database in the configuration. |
| admin.databaseAttachForest | This function attaches the specified forest to the specified database. |
| admin.databaseAttachSubDatabase | This function adds a sub-database to a super-database. |
| admin.databaseBackupGetEnabled | This function returns true or false to indicate whether a specific backup is enabled for a database. |
| admin.databaseBackupSetEnabled | This function enables database backup for the specified database. |
| admin.databaseCopy | This function creates a new database specification with the same settings as the database with the specified ID. |
| admin.databaseCreate | This function creates a new database specification. |
| admin.databaseDailyBackup | This function constructs a daily scheduled database backup specification. |
| admin.databaseDailyIncrementalBackup | This function constructs a daily scheduled incremental database backup specification. |
| admin.databaseDelete | This function deletes the configuration from the specified database(s). |
| admin.databaseDeleteAllRangeFieldIndexes | This function deletes all the range field indexes on given fields for the specified database in the configuration. |
| admin.databaseDeleteBackup | This function deletes scheduled backup specifications for a database from a configuration. |
| admin.databaseDeleteBackupById | This function deletes a specific scheduled backup configuration, identified by the backup ID. |
| admin.databaseDeleteDefaultRuleset | This function deletes the default ruleset used for inference on a database. |
| admin.databaseDeleteElementAttributeWordLexicon | This function deletes an element attribute word lexicon for the specified database from the configuration. |
| admin.databaseDeleteElementWordLexicon | This function deletes an element word lexicon for the specified database from the configuration. |
| admin.databaseDeleteElementWordQueryThrough | This function deletes an element word query through for the specified database from the configuration. |
| admin.databaseDeleteField | This function deletes the field specification in the specified database from the configuration. |
| admin.databaseDeleteFieldExcludedElement | This function deletes the field excluded element specification in the specified database from the configuration. |
| admin.databaseDeleteFieldIncludedElement | This function deletes the field included element specification in the specified database from the configuration. |
| admin.databaseDeleteFieldPaths | This function deletes paths from a specified field. |
| admin.databaseDeleteFieldTokenizerOverride | This function deletes the field's tokenizer override in the specified database from the configuration. |
| admin.databaseDeleteFieldWordLexicon | This function deletes a word lexicon for the specified database from the configuration. |
| admin.databaseDeleteForeignMaster | This function removes the specified master database from the database replication configuration on the replica host. |
| admin.databaseDeleteForeignReplicas | This function deletes the foreign replica database configurations for the specified master database. |
| admin.databaseDeleteFragmentParent | This function deletes the specified fragment parent in the specified database from the configuration. |
| admin.databaseDeleteFragmentRoot | This function deletes the specified fragment root in the specified database from the configuration. |
| admin.databaseDeleteGeospatialElementAttributePairIndex | This function deletes a geospatial element attribute pair index in the specified database from the configuration. |
| admin.databaseDeleteGeospatialElementChildIndex | This function deletes a geospatial element child index for the specified database in the configuration. |
| admin.databaseDeleteGeospatialElementIndex | This function deletes a geospatial element index for the specified database in the configuration. |
| admin.databaseDeleteGeospatialElementPairIndex | This function deletes a geospatial element pair index for the specified database from the configuration. |
| admin.databaseDeleteGeospatialPathIndex | This function deletes a geospatial path index for the specified database in the configuration. |
| admin.databaseDeleteGeospatialRegionPathIndex | This function deletes a geospatial region path index to the specified database in the configuration. |
| admin.databaseDeleteMergeBlackout | This function deletes a merge blackout specification for a database from a configuration. |
| admin.databaseDeletePathNamespace | This function deletes the specified namespaces from the configuration for the specified database. |
| admin.databaseDeletePhraseAround | This function deletes a phrase around for the specified database from the configuration. |
| admin.databaseDeletePhraseThrough | This function deletes a phrase through for the specified database from the configuration. |
| admin.databaseDeleteRangeElementAttributeIndex | This function deletes a range element attribute index for the specified database in the configuration. |
| admin.databaseDeleteRangeElementIndex | This function deletes a range element index for the specified database in the configuration. |
| admin.databaseDeleteRangeFieldIndex | This function deletes a range field index for the specified database in the configuration. |
| admin.databaseDeleteRangePathIndex | This function deletes a range path index for the specified database in the configuration. |
| admin.databaseDeleteWordLexicon | This function deletes a word lexicon for the specified database from the configuration. |
| admin.databaseDeleteWordQueryExcludedElement | This function deletes the word query excluded element specification in the specified database from the configuration. |
| admin.databaseDeleteWordQueryIncludedElement | This function deletes the word query included element specification in the specified database from the configuration. |
| admin.databaseDetachForest | This function detaches the specified forest from the specified database. |
| admin.databaseDetachSubDatabase | This function removes a sub-database from a super-database. |
| admin.databaseElementAttributeReference | This function greated a db:element-attribute-reference specification. |
| admin.databaseElementAttributeWordLexicon | This function constructs an element attribute word lexicon specification. |
| admin.databaseElementReference | This function greated a db:element-reference specification. |
| admin.databaseElementWordLexicon | This function constructs an element word lexicon specification. |
| admin.databaseElementWordQueryThrough | This function constructs an element word query through specification. |
| admin.databaseEmployForest | This function "employs" the specified forest in the configuration. |
| admin.databaseExcludedElement | This function constructs an excluded element specification. |
| admin.databaseExists | This function determines whether or not the specified database exists. |
| admin.databaseField | This function constructs a field specification. |
| admin.databaseFieldPath | This function is a constructor for field-path element. |
| admin.databaseFieldReference | This function creates a db:field-reference specification. |
| admin.databaseForeignMaster | This function returns a master database configuration. |
| admin.databaseForeignMasterGetClusterId | This function returns the id of the cluster from the specified foreign master configuration. |
| admin.databaseForeignMasterGetConnectForestsByName | This function returns the connect-forests-by-name setting from the master database configuration. |
| admin.databaseForeignMasterGetDatabaseId | This function returns the id of the foreign master database. |
| admin.databaseForeignReplica | This function returns a replica database configuration. |
| admin.databaseForeignReplicaGetClusterId | This function returns the id of the replica cluster from the replica database configuration. |
| admin.databaseForeignReplicaGetConnectForestsByName | This function returns the connect-forests-by-name setting from the replica database configuration. |
| admin.databaseForeignReplicaGetDatabaseId | This function returns the id of the replica database from the replica database configuration. |
| admin.databaseForeignReplicaGetLagLimit | This function returns the lag limit value from the replica database configuration. |
| admin.databaseForeignReplicaGetQueueSize | This function returns the queue size for the number of fragments or frames in-flight during database replication. |
| admin.databaseForeignReplicaGetReplicationEnabled | This function returns the enabled flag from the replica database configuration. |
| admin.databaseForeignReplicaSetLagLimit | This function sets the lag limit value on a replica database configuration. |
| admin.databaseForeignReplicaSetQueueSize | This function sets the queue size for the number of fragments or frames in-flight during database replication. |
| admin.databaseForeignReplicaSetReplicationEnabled | This function sets the enabled flag on a replica database configuration. |
| admin.databaseFragmentParent | This function constructs a fragment parent specification. |
| admin.databaseFragmentRoot | This function constructs a fragment root specification. |
| admin.databaseGeospatialElementAttributePairIndex | This function constructs a geospatial element attribute pair index specification. |
| admin.databaseGeospatialElementChildIndex | This function constructs a geospatial element child index specification. |
| admin.databaseGeospatialElementIndex | This function constructs a geospatial element index specification. |
| admin.databaseGeospatialElementPairIndex | This function constructs a geospatial element pair index specification. |
| admin.databaseGeospatialPathIndex | This function constructs a geospatial path index specification. |
| admin.databaseGeospatialRegionPathIndex | This function constructs a geospatial region path index specification. |
| admin.databaseGetAssignmentPolicy | This function returns the assignment policy for the specified database from the configuration. |
| admin.databaseGetAttachedForests | This function returns the attached forest IDs for the specified database from the configuration. |
| admin.databaseGetAttributeValuePositions | This function returns the attribute value positions setting for the specified database from the configuration. |
| admin.databaseGetBackups | This function returns the scheduled backups for the specified database from the configuration. |
| admin.databaseGetCollectionLexicon | This function returns the collection lexicon setting for the specified database from the configuration. |
| admin.databaseGetConfigForForeignMasterOnForeignCluster | This function returns the master configuration on a foreign cluster. |
| admin.databaseGetConfigForForeignReplicasOnForeignCluster | This function returns the replica configuration on a foreign cluster. |
| admin.databaseGetDataEncryption | This function returns the encryption setting for the database ID by database-id. |
| admin.databaseGetDefaultRulesets | This function returns the default rulesets for a database. |
| admin.databaseGetDirectoryCreation | This function returns the directory creation setting for the specified database from the configuration. |
| admin.databaseGetElementAttributeWordLexicons | This function returns the element attribute word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetElementValuePositions | This function returns the element value positions setting for the specified database from the configuration. |
| admin.databaseGetElementWordLexicons | This function returns the element word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetElementWordPositions | This function returns the element word positions setting for the specified database from the configuration. |
| admin.databaseGetElementWordQueryThroughs | This function returns the element word query throughs specification(s) for the specified database from the configuration. |
| admin.databaseGetEnabled | This function returns the enabled value for the specified database from the configuration. |
| admin.databaseGetExpungeLocks | This function returns the expunge locks setting for the specified database from the configuration. |
| admin.databaseGetFastCaseSensitiveSearches | This function returns the fast case sensitive searches setting for the specified database from the configuration. |
| admin.databaseGetFastDiacriticSensitiveSearches | This function returns the fast diacritic sensitive searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementCharacterSearches | This function returns the fast element character searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementPhraseSearches | This function returns the fast element phrase searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementTrailingWildcardSearches | This function returns the trailing wildcard searches setting for the specified database from the configuration. |
| admin.databaseGetFastElementWordSearches | This function returns the fast element word searches setting for the specified database from the configuration. |
| admin.databaseGetFastPhraseSearches | This function returns the fast phrase searches setting for the specified database from the configuration. |
| admin.databaseGetFastReverseSearches | This function returns the fast reverse searches setting for the specified database from the configuration. |
| admin.databaseGetField | This function returns the field specification for the specified database from the configuration. |
| admin.databaseGetFieldExcludedElements | This function returns the field excluded elements specification for the specified database from the configuration. |
| admin.databaseGetFieldFastCaseSensitiveSearches | This function returns true if the fast case sensitive searches setting for the specified field is enabled. |
| admin.databaseGetFieldFastDiacriticSensitiveSearches | This function returns true if the fast diacritic sensitive searches setting for the specified field is enabled. |
| admin.databaseGetFieldFastPhraseSearches | This function returns true if the fast phrase searches setting for the specified field is enabled. |
| admin.databaseGetFieldIncludedElements | This function returns the fields included elements specification for the specified database from the configuration. |
| admin.databaseGetFieldIncludeDocumentRoot | This function returns the field include document root setting for the specified field from the configuration. |
| admin.databaseGetFieldOneCharacterSearches | This function returns true if the one character searches setting for the specified field is enabled. |
| admin.databaseGetFieldPaths | This function returns all the paths on a given field. |
| admin.databaseGetFields | This function returns the fields specification(s) for the specified database from the configuration. |
| admin.databaseGetFieldStemmedSearches | This function returns stemmed searches setting for the specified field if configured. |
| admin.databaseGetFieldThreeCharacterSearches | This function returns true if the three character searches setting for the specified field is enabled. |
| admin.databaseGetFieldThreeCharacterWordPositions | This function returns true if the three character word positions setting for the specified field is enabled. |
| admin.databaseGetFieldTokenizerOverrides | This function fetches any custom tokenizer override specifications for the specified field and database. |
| admin.databaseGetFieldTrailingWildcardSearches | This function returns true if the trailing wildcard searches setting for the specified field is enabled. |
| admin.databaseGetFieldTrailingWildcardWordPositions | This function returns true if the trailing wildcard word positions setting for the specified field is enabled. |
| admin.databaseGetFieldTwoCharacterSearches | This function returns true if the two character searches setting for the specified field is enabled. |
| admin.databaseGetFieldValuePositions | This function gets the field value positions setting for the specified database in the configuration. |
| admin.databaseGetFieldValueSearches | This function returns the field value search setting for the specified field. |
| admin.databaseGetFieldWordLexicons | This function returns the word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetFieldWordSearches | This function returns true if the word searches setting for the specified field is enabled. |
| admin.databaseGetForeignMaster | This function returns the configuration for the foreign master database. |
| admin.databaseGetForeignReplicas | This function returns the configuration elements of the replica databases associated with the master database specified by database-id. |
| admin.databaseGetFormatCompatibility | This function returns the format compatibility setting for the specified database from the configuration. |
| admin.databaseGetFragmentParents | This function returns the fragment parents specification for the specified database from the configuration. |
| admin.databaseGetFragmentRoots | This function returns the fragment roots specification for the specified database from the configuration. |
| admin.databaseGetGeospatialElementAttributePairIndexes | This function returns the geospatial element attribute pair indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialElementChildIndexes | This function returns the geospatial element child indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialElementIndexes | This function returns the geospatial element indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialElementPairIndexes | This function returns the geospatial element pair indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialPathIndexes | This function returns the geospatial path indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetGeospatialRegionPathIndexes | This function returns the geospatial region path index specification(s) for the specified database in the configuration. |
| admin.databaseGetId | This function returns the ID for the specified database from the configuration. |
| admin.databaseGetIndexDetection | This function returns the index detection setting for the specified database from the configuration. |
| admin.databaseGetInheritCollections | This function returns the inherit collections setting for the specified database from the configuration. |
| admin.databaseGetInheritPermissions | This function returns the inherit positions setting for the specified database from the configuration. |
| admin.databaseGetInheritQuality | This function returns the inherit quality setting for the specified database from the configuration. |
| admin.databaseGetInMemoryGeospatialRegionIndexSize | This function returns the in memory geospatial region index size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryLimit | This function returns the in memory limit setting for the specified database from the configuration. |
| admin.databaseGetInMemoryListSize | This function returns the in memory list size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryRangeIndexSize | This function returns the in memory range index size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryReverseIndexSize | This function returns the in memory reverse index size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryTreeSize | This function returns the in memory tree size setting for the specified database from the configuration. |
| admin.databaseGetInMemoryTripleIndexSize | This function returns the in memory triple index size setting (in megabytes) for the specified database from the configuration. |
| admin.databaseGetJournaling | This function returns the journaling setting for the specified database in the configuration. |
| admin.databaseGetJournalSize | This function returns the journal size setting for the specified database from the configuration. |
| admin.databaseGetLanguage | This function returns the language for the specified database from the configuration. |
| admin.databaseGetLargeSizeThreshold | This function returns the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs). |
| admin.databaseGetLocking | This function returns the locking setting for the specified database in the configuration. |
| admin.databaseGetMaintainDirectoryLastModified | This function returns the maintain directory last modified setting for the specified database from the configuration. |
| admin.databaseGetMaintainLastModified | This function returns the maintain last modified setting for the specified database from the configuration. |
| admin.databaseGetMergeBlackouts | This function returns the merge blackouts specification for the specified database from the configuration. |
| admin.databaseGetMergeMaxSize | This function returns the merge max size setting for the specified database from the configuration. |
| admin.databaseGetMergeMinRatio | This function returns the merge min ratio setting for the specified database from the configuration. |
| admin.databaseGetMergeMinSize | This function returns the merge min size setting for the specified database from the configuration. |
| admin.databaseGetMergePriority | This function returns the CPU scheduler priority for merges for the specified database from the configuration. |
| admin.databaseGetMergeTimestamp | This function returns the merge timestamp setting for the specified database from the configuration. |
| admin.databaseGetName | This function returns the name for the specified database from the configuration. |
| admin.databaseGetOneCharacterSearches | This function returns the one character searches setting for the specified database from the configuration. |
| admin.databaseGetPathNamespaces | This function returns the value of any namespace definitions predefined for the specified database. |
| admin.databaseGetPhraseArounds | This function returns the phrase arounds specification(s) for the specified database from the configuration. |
| admin.databaseGetPhraseThroughs | This function returns the phrase throughs specification(s) for the specified database from the configuration. |
| admin.databaseGetPositionsListMaxSize | This function returns the positions list max size setting for the specified database from the configuration. |
| admin.databaseGetPreallocateJournals | This function returns the preallocate journals setting for the specified database from the configuration. |
| admin.databaseGetPreloadMappedData | This function returns the preload mapped data setting for the specified database from the configuration. |
| admin.databaseGetPreloadReplicaMappedData | This function returns the preload replica mapped data setting for the specified database from the configuration. |
| admin.databaseGetRangeElementAttributeIndexes | This function returns the range element attribute indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangeElementIndexes | This function returns the range element indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangeFieldIndexes | This function returns the range field indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangeIndexOptimize | This function returns the range index optimize setting for the specified database from the configuration. |
| admin.databaseGetRangePathIndexes | This function returns the range path indexes specification(s) for the specified database from the configuration. |
| admin.databaseGetRangePolicyPartitionKey | This function returns the range policy partition key set for the database. |
| admin.databaseGetRebalancerEnable | This function returns the rebalancer enable setting for the specified database from the configuration. |
| admin.databaseGetRebalancerThrottle | This function returns the rebalancer throttle setting for the specified database from the configuration. |
| admin.databaseGetReindexerEnable | This function returns the reindexer enable setting for the specified database from the configuration. |
| admin.databaseGetReindexerThrottle | This function returns the reindexer throttle setting for the specified database from the configuration. |
| admin.databaseGetReindexerTimestamp | This function returns the reindexer timestamp setting for the specified database from the configuration. |
| admin.databaseGetRetainUntilBackup | This function returns the "retain until backup" setting from the configuration for the specified database. |
| admin.databaseGetRetiredForests | This function returns the list of all retired forests for the specified database from the configuration. |
| admin.databaseGetSchemaDatabase | This function returns the ID of the schema database for the specified database from the configuration. |
| admin.databaseGetSecurityDatabase | This function returns the ID of the security database for the specified database from the configuration. |
| admin.databaseGetShutdownOnStorageFailure | This function returns the shutdown on storage failure setting for the specified database from the configuration. |
| admin.databaseGetStemmedSearches | This function returns the stemmed searches setting for the specified database from the configuration. |
| admin.databaseGetStorageFailureTimeout | This function returns the storage failure timeout for the specified database from the configuration. |
| admin.databaseGetTfNormalization | This function returns the current term-frequency normalization setting for the database. |
| admin.databaseGetThreeCharacterSearches | This function returns the three character searches setting for the specified database from the configuration. |
| admin.databaseGetThreeCharacterWordPositions | This function returns the three character word positions setting for the specified database from the configuration. |
| admin.databaseGetTrailingWildcardSearches | This function returns the trailing wildcard searches setting for the specified database from the configuration. |
| admin.databaseGetTrailingWildcardWordPositions | This function returns the trailing wildcard word positions setting for the specified database from the configuration. |
| admin.databaseGetTriggersDatabase | This function returns the ID of the triggers database for the specified database from the configuration. |
| admin.databaseGetTripleIndex | This function returns true if the triple index is enabled for the specified database, false if it is not enabled. |
| admin.databaseGetTriplePositions | This function returns triple positions setting of a database. |
| admin.databaseGetTwoCharacterSearches | This function returns the two character searches setting for the specified database from the configuration. |
| admin.databaseGetUriLexicon | This function returns the URI lexicon setting for the specified database from the configuration. |
| admin.databaseGetWordLexicons | This function returns the word lexicons specification(s) for the specified database from the configuration. |
| admin.databaseGetWordPositions | This function returns the word positions setting for the specified database from the configuration. |
| admin.databaseGetWordQueryExcludedElements | This function returns the word query excluded elements setting for the specified database from the configuration. |
| admin.databaseGetWordQueryFastCaseSensitiveSearches | This function returns true if the word query fast case sensitive searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryFastDiacriticSensitiveSearches | This function returns true if the word query fast diacritic sensitive searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryFastPhraseSearches | This function returns true if the word query fast phrase searches setting for the specified database is set in the configuration. |
| admin.databaseGetWordQueryIncludedElements | This function returns the word query included elements setting for the specified database from the configuration. |
| admin.databaseGetWordQueryIncludeDocumentRoot | This function returns the word query include document root setting for the specified database from the configuration. |
| admin.databaseGetWordQueryOneCharacterSearches | This function returns true if the word query one character searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryStemmedSearches | This function returns the reindexer word query stemmed searches setting for the specified database from the configuration. |
| admin.databaseGetWordQueryThreeCharacterSearches | This function returns true if the word query three character searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryThreeCharacterWordPositions | This function returns true if the word query three character word positions setting is enabled for the specified database from the configuration. |
| admin.databaseGetWordQueryTrailingWildcardSearches | This function returns true if the word query trailing wildcard searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryTrailingWildcardWordPositions | This function returns true if the word query trailing wildcard word positions setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryTwoCharacterSearches | This function returns true if the word query two character searches setting is enabled for the specified database in the configuration. |
| admin.databaseGetWordQueryWordSearches | This function returns true if the word query searches setting for the specified database is enabled in the configuration. |
| admin.databaseGetWordSearches | This function returns the word searches setting for the specified database from the configuration. |
| admin.databaseHourlyBackup | This function constructs an hourly scheduled database backup specification. |
| admin.databaseHourlyIncrementalBackup | This function constructs an hourly scheduled incremental database backup specification. |
| admin.databaseIncludedElement | This function constructs an included element specification. |
| admin.databaseInUsePathNamespacePrefixes | This function returns the prefixes of all the namespaces that are in use by some path or geospatial path index. |
| admin.databaseIsForestEmployed | This function returns true if the specified forest is employed and false the specified forest is not employed. |
| admin.databaseIsForestRetired | This function returns true if the specified forest is retired and false the specified forest is not retired. |
| admin.databaseMetadataField | This function constructs a metadata field specification. |
| admin.databaseMinutelyBackup | This function constructs a scheduled database backup specification on a number-of-minutes basis. |
| admin.databaseMinutelyIncrementalBackup | This function constructs a scheduled incremental database backup specification based on a number of minutes. |
| admin.databaseMonthlyBackup | This function constructs a monthly scheduled backup specification. |
| admin.databaseMonthlyIncrementalBackup | This function constructs a scheduled monthly incremental backup specification. |
| admin.databaseOneTimeBackup | This function constructs a one-time backup specification. |
| admin.databaseOneTimeIncrementalBackup | This function constructs a one-time incremental backup specification. |
| admin.databaseOneTimeMergeBlackout | This function constructs a one-time merge-blackout specification. |
| admin.databasePathField | This function constructs a field specification that has field paths. |
| admin.databasePathNamespace | This function constructs a namespace element with the specified prefix and URI. |
| admin.databasePathReference | This function creates a db:path-reference specification. |
| admin.databasePhraseAround | This function constructs a phrase through specification. |
| admin.databasePhraseThrough | This function constructs a phrase through specification. |
| admin.databaseRangeElementAttributeIndex | This function constructs a range element attribute index specification. |
| admin.databaseRangeElementIndex | This function constructs a range element index specification. |
| admin.databaseRangeFieldIndex | This function constructs a range field index specification. |
| admin.databaseRangePathIndex | This function constructs a path range index specification. |
| admin.databaseRecurringMergeBlackout | This function constructs a merge-blackout specification. |
| admin.databaseReorderForests | This function reorders the forests in the specified database. |
| admin.databaseRetireForest | This function "retires" the specified forest in the configuration. |
| admin.databaseRuleset | The ruleset element (db:default-ruleset) created to be used for inference on a database. |
| admin.databaseSetAssignmentPolicy | This function sets the assignment policy for the specified database in the configuration. |
| admin.databaseSetAttributeValuePositions | This function sets the attribute value positions setting for the specified database in the configuration. |
| admin.databaseSetCollectionLexicon | This function sets the collection lexicon setting for the specified database in the configuration. |
| admin.databaseSetDataEncryption | This function sets the encryption setting for the database identified by database-id. |
| admin.databaseSetDirectoryCreation | This function sets the directory creation setting for the specified database in the configuration. |
| admin.databaseSetElementValuePositions | This function sets the element value positions setting for the specified database in the configuration. |
| admin.databaseSetElementWordPositions | This function sets the element word positions setting for the specified database in the configuration. |
| admin.databaseSetEnabled | This function sets the enabled value for the specified database in the configuration. |
| admin.databaseSetExpungeLocks | This function sets the expunge locks setting for the specified database in the configuration. |
| admin.databaseSetFastCaseSensitiveSearches | This function sets the fast case sensitive searches setting for the specified database in the configuration. |
| admin.databaseSetFastDiacriticSensitiveSearches | This function sets the fast diacritic-sensitive searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementCharacterSearches | This function sets the fast element character searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementPhraseSearches | This function sets the fast element phrase searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementTrailingWildcardSearches | This function sets the fast element trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetFastElementWordSearches | This function sets the element word searches setting for the specified database in the configuration. |
| admin.databaseSetFastPhraseSearches | This function sets the fast phrase searches setting for the specified database in the configuration. |
| admin.databaseSetFastReverseSearches | This function sets the fast reverse searches setting for the specified database in the configuration. |
| admin.databaseSetFieldFastCaseSensitiveSearches | This function sets the field fast case sensitive searches setting for the specified field in the configuration. |
| admin.databaseSetFieldFastDiacriticSensitiveSearches | This function sets the field fast diacritic sensitive searches setting for the specified field in the configuration. |
| admin.databaseSetFieldFastPhraseSearches | This function sets the field fast phrase searches setting for the specified field in the configuration. |
| admin.databaseSetFieldIncludeDocumentRoot | This function sets the field include document root setting for the specified field in the configuration. |
| admin.databaseSetFieldName | This function sets the field name setting for the specified field in the configuration. |
| admin.databaseSetFieldOneCharacterSearches | This function sets the field one character searches setting for the specified field in the configuration. |
| admin.databaseSetFieldStemmedSearches | This function sets the field stemmed searches setting for the specified field in the configuration. |
| admin.databaseSetFieldThreeCharacterSearches | This function sets the field three character searches setting for the specified field in the configuration. |
| admin.databaseSetFieldThreeCharacterWordPositions | This function sets the field three character word positions setting for the specified field in the configuration. |
| admin.databaseSetFieldTrailingWildcardSearches | This function sets the field trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetFieldTrailingWildcardWordPositions | This function sets the field trailing wildcard word positions setting for the specified field in the configuration. |
| admin.databaseSetFieldTwoCharacterSearches | This function sets the field two character searches setting for the specified field in the configuration. |
| admin.databaseSetFieldValuePositions | This function sets the field value positions setting for the specified database in the configuration. |
| admin.databaseSetFieldValueSearches | This function sets the field value searches setting for the specified database in the configuration. |
| admin.databaseSetFieldWordSearches | This function sets the field word searches setting for the specified field in the configuration. |
| admin.databaseSetForeignMaster | This function configures the specified replica database to receive replicated data from the specified foreign master. |
| admin.databaseSetForeignReplicas | This function sets the foreign replica database configuration. |
| admin.databaseSetFormatCompatibility | This function sets the format compatibility setting for the specified database in the configuration. |
| admin.databaseSetIndexDetection | This function sets the index detection setting for the specified database in the configuration. |
| admin.databaseSetInheritCollections | This function sets the inherit collections setting for the specified database in the configuration. |
| admin.databaseSetInheritPermissions | This function sets the inherit permissions setting for the specified database in the configuration. |
| admin.databaseSetInheritQuality | This function sets the inherit quality setting for the specified database in the configuration. |
| admin.databaseSetInMemoryGeospatialRegionIndexSize | This function sets the in-memory geospatial region index size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryLimit | This function sets the in-memory limit setting for the specified database in the configuration. |
| admin.databaseSetInMemoryListSize | This function sets the in-memory list size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryRangeIndexSize | This function sets the in-memory range index size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryReverseIndexSize | This function sets the in-memory range reverse index size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryTreeSize | This function sets the in-memory tree size setting for the specified database in the configuration. |
| admin.databaseSetInMemoryTripleIndexSize | This function sets the size, in megabytes, of the in-memory triple index. |
| admin.databaseSetJournaling | This function sets the journaling setting for the specified database in the configuration. |
| admin.databaseSetJournalSize | This function sets the journal size setting for the specified database in the configuration. |
| admin.databaseSetLanguage | This function sets the language for the specified database in the configuration. |
| admin.databaseSetLargeSizeThreshold | This function sets the threshold at which binary documents in the specified database should be handled as binary large objects (BLOBs). |
| admin.databaseSetLocking | This function sets the locking setting for the specified database in the configuration. |
| admin.databaseSetMaintainDirectoryLastModified | This function sets the maintain directory last modified setting for the specified database in the configuration. |
| admin.databaseSetMaintainLastModified | This function sets the maintain last modified setting for the specified database in the configuration. |
| admin.databaseSetMergeMaxSize | This function sets the merge max size setting for the specified database in the configuration. |
| admin.databaseSetMergeMinRatio | This function sets the merge min ratio setting for the specified database in the configuration. |
| admin.databaseSetMergeMinSize | This function sets the merge minimum size setting for the specified database in the configuration. |
| admin.databaseSetMergePriority | This function sets the CPU scheduler priority for merges. |
| admin.databaseSetMergeTimestamp | This function sets the merge timestamp setting for the specified database in the configuration. |
| admin.databaseSetName | This function changes the name of the database with the specified ID to the specified name. |
| admin.databaseSetOneCharacterSearches | This function sets the one character searches setting for the specified database in the configuration. |
| admin.databaseSetPositionsListMaxSize | This function sets the positions list max size setting for the specified database in the configuration. |
| admin.databaseSetPreallocateJournals | This function sets the preallocate journals setting for the specified database in the configuration. |
| admin.databaseSetPreloadMappedData | This function sets the preload mapped data setting for the specified database in the configuration. |
| admin.databaseSetPreloadReplicaMappedData | This function sets the preload-replica-mapped-data setting for the specified database. |
| admin.databaseSetRangeIndexOptimize | This function sets the range index optimize setting for the specified database in the configuration. |
| admin.databaseSetRebalancerEnable | This function sets the rebalancer enable setting for the specified database in the configuration. |
| admin.databaseSetRebalancerThrottle | This function sets the rebalancer throttle setting for the specified database in the configuration. |
| admin.databaseSetReindexerEnable | This function sets the reindexer enable setting for the specified database in the configuration. |
| admin.databaseSetReindexerThrottle | This function sets the reindexer throttle setting for the specified database in the configuration. |
| admin.databaseSetReindexerTimestamp | This function sets the reindexer timestamp setting for the specified database in the configuration. |
| admin.databaseSetRetainUntilBackup | This function sets "the retain until backup" setting in the configuration for the specified database. |
| admin.databaseSetSchemaDatabase | This function sets the schema database for a database to the specified database in the configuration. |
| admin.databaseSetSecurityDatabase | This function sets the security database for a database to the specified database in the configuration. |
| admin.databaseSetShutdownOnStorageFailure | This function sets the shutdown on storage failure for the specified database in the configuration. |
| admin.databaseSetStemmedSearches | This function sets the stemmed searches setting for the specified database in the configuration. |
| admin.databaseSetStorageFailureTimeout | This function sets the storage failure timeout for the specified database in the configuration. |
| admin.databaseSetTfNormalization | This function specifies whether to use the default term-frequency normalization (scaled-log), which scales the term frequency based on the size of the document, or to use the unscaled-log, which uses term frequency as a function of the actual term frequency in a document, regardless of the document size. |
| admin.databaseSetThreeCharacterSearches | This function sets the three character searches setting for the specified database in the configuration. |
| admin.databaseSetThreeCharacterWordPositions | This function sets the three character word positions setting for the specified database in the configuration. |
| admin.databaseSetTrailingWildcardSearches | This function sets the trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetTrailingWildcardWordPositions | This function sets the trailing wildcard word positions setting for the specified database in the configuration. |
| admin.databaseSetTriggersDatabase | This function sets the triggers database to the specified database ID for the specified database in the configuration. |
| admin.databaseSetTripleIndex | This function sets the triple index on or off for a database. |
| admin.databaseSetTriplePositions | This function sets the triple positions of a database to true or false. |
| admin.databaseSetTwoCharacterSearches | This function sets the two character searches setting for the specified database in the configuration. |
| admin.databaseSetUriLexicon | This function sets the URI lexicon setting for the specified database in the configuration. |
| admin.databaseSetWordPositions | This function sets the word positions setting for the specified database in the configuration. |
| admin.databaseSetWordQueryFastCaseSensitiveSearches | This function returns the word query fast case sensitive searches setting for the specified database from the configuration. |
| admin.databaseSetWordQueryFastDiacriticSensitiveSearches | This function sets the word query fast diacritic sensitive searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryFastPhraseSearches | This function sets the word query fast phrase searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryIncludeDocumentRoot | This function sets the word query include document root setting for the specified field in the configuration. |
| admin.databaseSetWordQueryOneCharacterSearches | This function sets the word query one character searches setting for the specified field in the configuration. |
| admin.databaseSetWordQueryStemmedSearches | This function sets the word query stemmed searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryThreeCharacterSearches | This function sets the word query three character searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryThreeCharacterWordPositions | This function sets the word query three character word positions setting for the specified database in the configuration. |
| admin.databaseSetWordQueryTrailingWildcardSearches | This function sets the word query trailing wildcard searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryTrailingWildcardWordPositions | This function sets the word query trailing wildcard word positions setting for the specified database in the configuration. |
| admin.databaseSetWordQueryTwoCharacterSearches | This function sets the word query two character searches setting for the specified database in the configuration. |
| admin.databaseSetWordQueryWordSearches | This function sets the word query word searches setting for the specified database in the configuration. |
| admin.databaseSetWordSearches | This function sets the word searches setting for the specified database in the configuration. |
| admin.databaseSubDatabases | This function returns a database-reference element representing the sub-databases of the specified super-database. |
| admin.databaseSuperDatabases | This function returns a database-reference element representing where the specified database serves as a sub-database. |
| admin.databaseTokenizerOverride | This function constructs a custom tokenizer override. |
| admin.databaseValidateFieldPath | This function validates the specified field path. |
| admin.databaseValidateFieldPaths | This function checks if the paths conform to the permissible XPath syntax. |
| admin.databaseValidatePathFields | For a given sequence of fields, this function validates all the paths on each field using admin:database-validate-field-paths call. |
| admin.databaseWeeklyBackup | This function constructs a weekly scheduled backup specification. |
| admin.databaseWeeklyIncrementalBackup | This function constructs a weekly scheduled incremental backup specification. |
| admin.databaseWordLexicon | This function constructs a word lexicon specification. |
| admin.forestForeignMaster | This function creates a replication configuration element for the specified master forest. |
| admin.forestForeignMasterGetClusterId | This function returns the ID for the cluster from the foreign master forest configuration element. |
| admin.forestForeignReplica | This function returns a replica forest configuration. |
| admin.forestForeignReplicaGetClusterId | This function returns the id of the replica cluster from the specified replica forest configuration element. |
| admin.forestForeignReplicaGetDatabaseId | This function returns the id of the replica database from the specified replica forest configuration element. |
| admin.forestForeignReplicaGetForestId | This function returns the id of the replica forest from the specified replica forest configuration element. |
| admin.forestGetPartitionNumber | This function returns the partition number for the specified forest. |
| admin.forestSetPartitionNumber | This function sets the partition number for the specified forest. |
| admin.getDatabaseIds | This function returns all the database IDs from the configuration. |
| admin.legacyAssignmentPolicy | This function returns an element that represents the legacy assignment policy. |
| admin.queryAssignmentPolicy | This function returns an element that represents the query assignment policy. |
| admin.rangeAssignmentPolicy | This function returns an element that represents the range assignment policy. |
| admin.segmentAssignmentPolicy | This function returns an element that represents the segment assignment policy. |
| admin.statisticalAssignmentPolicy | This function returns an element that represents the statistical assignment policy. |