MarkLogic Server 11.0 Product Documentationadmin functions (forest)
For the complete list of functions and categories in this namespace, refer to the main admin functions page.
57 functions
| Function name | Description |
|---|---|
| admin.forestAddBackup | This function adds scheduled backup specifications for a forest to a configuration. |
| admin.forestAddFailoverHost | This function adds a failover host to the list of failover hosts for the specified forest in the specified configuration. |
| admin.forestAddForeignReplicas | This function adds the replica forest that is associated with the specified master forest to the database replication configuration. |
| admin.forestAddReplica | This function adds a forest replica to a master forest. |
| admin.forestBackupGetEnabled | This function returns true or false to indicate whether backup is enabled for the specified forest. |
| admin.forestBackupSetEnabled | This function enables forest backup for the specified forest. |
| admin.forestCopy | This function creates a new forest specification with the same settings as the forest with the specified ID. |
| admin.forestCreate | This function creates a new forest configuration. |
| admin.forestDailyBackup | This function constructs a daily scheduled forest backup. |
| admin.forestDelete | This function deletes the configuration for the specified forest from the configuration. |
| admin.forestDeleteBackup | This function deletes scheduled backup specifications for a forest from a configuration. |
| admin.forestDeleteBackupById | This function deletes the forest backup specified by the forest ID. |
| admin.forestDeleteFailoverHost | This function deletes the specified failover host(s) from the failover-host list in the specified configuration. |
| admin.forestDeleteForeignMaster | This function deletes the master forest associated with the specified replica forest from the database replication configuration. |
| admin.forestDeleteForeignReplicas | This function deletes the foreign replica of the specified forest on the master host. |
| admin.forestExists | This function determines whether or not the specified forest exists. |
| admin.forestForeignMasterGetDatabaseId | This function returns the id for the database from the foreign master forest configuration element. |
| admin.forestForeignMasterGetForestId | This function returns the id for the forest from the foreign master forest configuration element. |
| admin.forestGetAvailability | This function gets the availability state of the forest, for use in Tiered Storage. |
| admin.forestGetBackups | This function returns the scheduled backups for the specified forest from the configuration. |
| admin.forestGetDatabase | This function returns the ID of the database that uses the specified forest. |
| admin.forestGetDataDirectory | This function returns the name of the data directory of the specified forest. |
| admin.forestGetEnabled | This function returns the enabled state of the specified forest. |
| admin.forestGetFailoverEnable | This function returns the state of whether failover is enabled for the specified forest. |
| admin.forestGetFailoverHosts | This function returns the IDs of the hosts defined as failover hosts for this forest. |
| admin.forestGetFastDataDirectory | This function returns the directory path set in the fast data directory field for the specified forest. |
| admin.forestGetFastDataMaxSize | This function returns maximum allowable size (in megabytes) of the data to be kept by the specified forest in its fast-data-directory, or 0 for no limit. |
| admin.forestGetForeignMaster | This function returns the replication configuration for the master forest associated with the specified replica forest. |
| admin.forestGetForeignReplicas | This function returns the foreign replicas configuration element. |
| admin.forestGetHost | This function returns the ID of the host in which the specified forest resides. |
| admin.forestGetId | This function returns the ID of the forest with the specified name, from the specified configuration. |
| admin.forestGetLargeDataDirectory | This function returns the name of the large data directory of the specified forest. |
| admin.forestGetName | This function returns the name of the specified forest, given the forest ID. |
| admin.forestGetRangePolicyLowerBound | This function returns the lower bound of the range configured on the forest. |
| admin.forestGetRangePolicyUpperBound | This function returns the upper bound of the range configured on the forest. |
| admin.forestGetRebalancerEnable | This function returns the rebalancer enable setting for the specified forest from the configuration. |
| admin.forestGetReplicas | This function returns the IDs of the forest replicas for the specified forest. |
| admin.forestGetUpdatesAllowed | This function returns the state of what kinds of updates are allowed for the specified forest. |
| admin.forestHourlyBackup | This function constructs a hourly scheduled forest backup specification. |
| admin.forestIsRangePolicyRangeSet | This function returns false if the specified forest has neither the lower boundary nor the upper boundary set. |
| admin.forestMinutelyBackup | This function constructs a scheduled forest backup on a number-of-minutes basis. |
| admin.forestMonthlyBackup | This function constructs a monthly scheduled backup. |
| admin.forestOneTimeBackup | This function constructs a one-time backup. |
| admin.forestRemoveReplica | This function removes a forest replica from a master forest. |
| admin.forestRename | This function renames a forest. |
| admin.forestSetAvailability | This function sets the availability state for a forest, for use in Tiered Storage. |
| admin.forestSetEnabled | This function sets the enabled state for a forest configuration. |
| admin.forestSetFailoverEnable | This function sets the forest failover enabled state for a forest configuration. |
| admin.forestSetFastDataMaxSize | This function sets the allowable size (in megabytes) for data to be kept by a forest in its fast data directory, or 0 for no limit. |
| admin.forestSetForeignMaster | This function writes the specified foreign master forest configuration into the database replication configuration. |
| admin.forestSetForeignReplicas | This function writes the specified replica forest configuration into the database replication configuration. |
| admin.forestSetHost | This function sets a forest configuration to a new host. |
| admin.forestSetRangePolicyRange | This function sets the boundaries of the range on a forest. |
| admin.forestSetRebalancerEnable | This function sets the rebalancer enable setting for the specified forest in the configuration. |
| admin.forestSetUpdatesAllowed | This function sets the updates-allowed state for a forest configuration. |
| admin.forestWeeklyBackup | This function constructs a weekly scheduled backup. |
| admin.getForestIds | This function returns all the forest IDs from the configuration. |