Loading TOC...

pkg functions

The table below lists all the pkg built-in functions (in this namespace: http://marklogic.com/manage/package).

The Configuration Packaging API module contains functions for scripting the packaging of MarkLogic Server resource configurations, such as database and App Server settings. Use the API to create, compare, and install configuration packages.

The Configuration Packaging API is installed as the following file:


install_dir/Modules/MarkLogic/manage/package/package.xqy
  

To use the Package module as part of your own XQuery module, include the following line in your XQuery prolog:


import module namespace pkg = "http://marklogic.com/manage/package"
        at "/MarkLogic/manage/package/package.xqy";
  

The library namespace prefix pkg is not predefined in the server.

24 functions
Function name Description
pkg:create [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Create an empty configuration for use with other packaging functions.
pkg:database-configuration [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the configuration (in XML) of the named database.
pkg:delete [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Deletes the named package.
pkg:differences [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Determines the differences between the configuration in the package and the current configuration of the MarkLogic server on which the function is executed.
pkg:errors [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Check a package for errors and, if there are errors, return a description of the errors as err:configuration-error elements.
pkg:exists [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Checks to see if the named package exists.
pkg:get-database [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the configuration of the named database from the named package.
pkg:get-database-list [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the names of the databases that have configurations in the named package.
pkg:get-modules [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the modules data for the named app server from the named package.
pkg:get-package [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the contents of the named package.
pkg:get-package-list [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the list of packages.
pkg:get-server [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the configuration of the named app server from the named package.
pkg:get-server-list [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the names of the app servers that have configurations in the named package.
pkg:install [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Install the named package.
pkg:installable [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Checks to see if the named package can be installed.
pkg:put-database [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Adds a database configuration to the named package.
pkg:put-modules [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Puts the content of the modules database used by the named app server into the named package.
pkg:put-server [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Adds an app server configuration to the named package.
pkg:remove-database [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Removes the configuration of the named database from the named package.
pkg:remove-modules [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Removes the modules data for the named app server from the named package.
pkg:remove-server [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Removes the configuration of the named app server from the named package.
pkg:revert [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Revert configuration settings to those prior to a particular package installation.
pkg:server-configuration [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Returns the configuration (in XML) of the named app server, located in the named group.
pkg:valid [DEPRECATED: use cma:generate-config and cma:apply-config instead.] Test a package for consistency.