infodev functions
The table below lists all the
infodev built-in
functions (in this namespace:
http://marklogic.com/appservices/infostudio/dev).
The Information Studio Developer API module contains functions that allow you to write custom collectors and transformers. This module is deprecated.
The Information Studio Developer API is installed as the following file:
install_dir/Modules/MarkLogic/appservices/infostudio/infodev.xqy
where install_dir is the directory in which
MarkLogic Server is installed.
To use the infodev.xqy module in your own XQuery modules,
include the following line in your XQuery prolog:
import module namespace infodev = "http://marklogic.com/appservices/infostudio/dev"
at "/MarkLogic/appservices/infostudio/infodev.xqy";
The library uses the infodev: 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.
| Function name | Description |
|---|---|
| infodev:check-options | [DEPRECATED] This function checks the options node to ensure that the structure and values are correct. |
| infodev:collector-options | [DEPRECATED] This function returns an options node in the xdmp:document-get namespace that is ready to pass into xdmp:document-get, including default-namespace, repair, format, default-language, encoding if they are defined by policy or options. |
| infodev:effective-policy | [DEPRECATED] This function temporarily resets the specified deltas on the named policy, while leaving the policy itself unchanged. |
| infodev:file-filter | [DEPRECATED] This function returns a string representing a matching pattern to be applied to file paths on ingest. |
| infodev:filesystem-walk | [DEPRECATED] This function can be used along with the infodev:ingest function to build custom load operations. |
| infodev:get-external-binary-file | [DEPRECATED] This function gets the specified binary file from the filesystem. |
| infodev:get-file | [DEPRECATED] This is a convenience function that wraps xdmp:document-get. |
| infodev:handle-error | [DEPRECATED] This function provides configuration-aware error handling. |
| infodev:ingest | [DEPRECATED] This function ingests a single document into the database specified in the ticket, according to the rules defined by the named policy and user-supplied options. |
| infodev:log-progress | [DEPRECATED] This function writes log information into a ticket's progress file that is written to the App-Services database. |
| infodev:ticket-add-annotation | [DEPRECATED] This function adds annotation to the specified ticket. |
| infodev:ticket-create | [DEPRECATED] This function generates a ticket and stores it in the specified database. |
| infodev:ticket-get-status | [DEPRECATED] This function returns the status of the specified ticket. |
| infodev:ticket-set-status | [DEPRECATED] This function sets the status of the specified ticket. |
| infodev:ticket-set-total-documents | [DEPRECATED] This function sets the number of documents to load into the database. |
| infodev:ticket-set-total-transactions | [DEPRECATED] This function adds and sets the value of a total-transactions element in the specified ticket. |
| infodev:transaction | [DEPRECATED] This function ingests a batch of documents in a single invoked transaction. |
| infodev:transaction-size | [DEPRECATED] This function resolves the transaction size parameter based on stored policy and runtime options and returns an integer that represents the maximum number of documents to handled in a single transaction. |