MarkLogic Server 11.0 Product Documentationtieredstorage functions
The table below lists all the
tieredstorage built-in
functions (in this namespace:
http://marklogic.com/xdmp/tieredstorage).
This module provides functions for managing forests and partitions in storage tiers and for managing super-databases and sub-databases. For details, see Tiered Storage in the Administrator's Guide.
The Tiered Storage function module is installed as the following file:
-
install_dir/Modules/MarkLogic/tieredstorage.xqy
where install_dir is the directory in which
MarkLogic Server is installed.
To use the tieredstorage.xqy module in your own XQuery modules,
include the following line in your XQuery prolog:
import module namespace ts="http://marklogic.com/xdmp/tieredstorage"
at "/MarkLogic/tieredstorage.xqy";
24 functions
| Function name | Description |
|---|---|
| tieredstorage.databaseCreateSubDatabase | This function creates a database with the name $database-name and make the created database the sub database of the database designated by $database-id. |
| tieredstorage.databaseCreateSuperDatabase | This function creates a database with the name $database-name and make the created database the super database of the database designated by $database-id. |
| tieredstorage.databaseDeleteSubDatabase | This function disassociates the sub database designated by $delete-dbid with the super-database designated by $database-id and deletes the sub database. |
| tieredstorage.databaseDeleteSuperDatabase | This function disassociates the super database designated by $delete-dbid with the sub-database designated by $database-id and deletes the super database. |
| tieredstorage.databasePartitionNumbers | This function returns the partition numbers of the forests in the database |
| tieredstorage.databasePartitions | This function returns the names of the partitions in the named database. |
| tieredstorage.forestCombine | This function combines data in multiple forests into one new forest. |
| tieredstorage.forestMigrate | This function moves data in a forest to new data directories and optionally sets new host for the forest. |
| tieredstorage.partitionDelete | This function deletes all forests in the specified partition. |
| tieredstorage.partitionDeleteQuery | This function deletes the query from the specified partition. |
| tieredstorage.partitionForests | This function returns a sequence of ids for the forests in the named partition. |
| tieredstorage.partitionGetExclusionEnabled | This function returns the safe-to-exclude setting for the database. |
| tieredstorage.partitionGetQuery | This function returns the query of a partition specified by the partition number. |
| tieredstorage.partitionMigrate | This function migrates all forests in a partition to the specified data directory and hosts. |
| tieredstorage.partitionNumberForests | This function returns the IDs of the forests with the specified partition-number in the named database. |
| tieredstorage.partitionQueries | This function returns all the queries in this schema database. |
| tieredstorage.partitionResize | This function either creates or combines forests in a partition. |
| tieredstorage.partitionSetAvailability | This function sets the availability of the partition to either online or offline. |
| tieredstorage.partitionSetExclusionEnabled | By default, when a search query is given to MarkLogic, all query partitions are searched, regardless of the query assignment policy set on the partition. |
| tieredstorage.partitionSetQuery | This function sets the query for a partition specified by the partition number. |
| tieredstorage.partitionSetUpdatesAllowed | This function sets update-allowed state for the forests in the specified partition. |
| tieredstorage.partitionTransfer | This function detaches forests in a partition from one database and attaches them to another. |
| tieredstorage.queryPartitionCreate | This function creates forests on specified hosts and forms a partition with the specified partition number. |
| tieredstorage.rangePartitionCreate | This function creates forests on the specified hosts and forms a range partition with the specified partition range. |