MarkLogic 9 Product Documentationinfo functions
The table below lists all the
info built-in
functions (in this namespace:
http://marklogic.com/appservices/infostudio).
The Information Studio API module contains functions that allow you to set policy, load content from a directory, configure databases, specify transformations, and check ticket status.
The Information Studio API is installed as the following file:
install_dir/Modules/MarkLogic/appservices/infostudio/info.xqy
where install_dir is the directory in which
MarkLogic Server is installed.
To use the info.xqy module in your own XQuery modules,
include the following line in your XQuery prolog:
import module namespace info = "http://marklogic.com/appservices/infostudio"
at "/MarkLogic/appservices/infostudio/info.xqy";
The library uses the info: namespace, which is
not predefined in the server.
MarkLogic recommends enabling the URI Lexicon when using Information Studio; the URI lexicon will improve performance, especially when the database grows to a large number of documents.
20 functions
| Function name | Description |
|---|---|
| info:database-create | [DEPRECATED] This function creates a database with attached forests. |
| info:database-delete | [DEPRECATED] This function deletes the specified database and its forest. |
| info:database-get-feature | [DEPRECATED] This function returns the a node representing support for database features of wildcarding, word positions, and reverse search. |
| info:database-set-feature | [DEPRECATED] This function adds or removes the related database settings for wildcarding, word positions, and/or reverse search. |
| info:error-detail | [DEPRECATED] This function returns the error detail associated with the specified error-id. |
| info:flow-cancel | [DEPRECATED] [DEPRECATED] This function cancels all active tickets associated with a flow. |
| info:flow-id | [DEPRECATED] This function returns the id of the flow with the specified name. |
| info:flow-policy | [DEPRECATED] This function returns the name of the policy associated with a flow. |
| info:flow-start | [DEPRECATED] This function starts (or "plays") the flow. |
| info:flow-tickets | [DEPRECATED] This function returns a sequence of IDs for all of the tickets started by this flow. |
| info:load | [DEPRECATED] This function does a one-time scan of the named directory path (local filesystem only), and attempts to load the files, spawning multiple transactions if necessary. |
| info:policy | [DEPRECATED] This function returns the stored policy matching the specified policy. |
| info:policy-delete | [DEPRECATED] This function deletes a named policy. |
| info:policy-names | [DEPRECATED] This function returns the names of all stored policies. |
| info:policy-set | [DEPRECATED] This function sets an ingestion policy, which consists of a reusable <options> node defining parameters for content loading and transformation. |
| info:ticket | [DEPRECATED] This function returns a ticket element containing the status information for a long-running process. |
| info:ticket-delete | [DEPRECATED] This function deletes a ticket and all associated state information. |
| info:ticket-errors | [DEPRECATED] This function returns any errors that may have occurred when loading content. |
| info:tickets | [DEPRECATED] This function returns a sequence of ticket IDs, optionally narrowed by database name. |
| info:unload | [DEPRECATED] This function deletes all of the documents associated with the specified $ticket-id from one or more databases. |