Difference between revisions of "Repository Module"
Jump to navigation
Jump to search
Rosishadura (talk | contribs) (Created page with "This module contains functions for managing [http://expath.org/modules/pkg/ EXPath packages]. You can read more about BaseX' implementation of the EXPath Packaging API [http://do...") |
Rosishadura (talk | contribs) m |
||
Line 5: | Line 5: | ||
|- | |- | ||
| valign='top' width='90' | '''Signatures''' | | valign='top' width='90' | '''Signatures''' | ||
− | |<code><b>pkg:install</b>($path as xs:string) as empty-sequence</code><br /> | + | |<code><b>pkg:install</b>($path as xs:string) as empty-sequence()</code><br /> |
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
Line 18: | Line 18: | ||
|- | |- | ||
| valign='top' width='90' | '''Signatures''' | | valign='top' width='90' | '''Signatures''' | ||
− | |<code><b>pkg:delete</b>($pkg as xs:string) as empty-sequence</code><br /> | + | |<code><b>pkg:delete</b>($pkg as xs:string) as empty-sequence()</code><br /> |
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
Line 24: | Line 24: | ||
|- | |- | ||
| valign='top' | '''Errors''' | | valign='top' | '''Errors''' | ||
− | |<b>[[XQuery Errors#Packaging Errors|PACK0007]]</b> is raised if the package cannot be deleted.<br /><b>[[XQuery Errors#Packaging Errors|PACK0008]]</b> is raised if another package depends on the package to be deleted.<br /><b> | + | |<b>[[XQuery Errors#Packaging Errors|PACK0007]]</b> is raised if the package cannot be deleted.<br /><b>[[XQuery Errors#Packaging Errors|PACK0008]]</b> is raised if another package depends on the package to be deleted.<br /> |
+ | |} | ||
+ | |||
+ | ==pkg:list== | ||
+ | {| | ||
+ | |- | ||
+ | | valign='top' width='90' | '''Signatures''' | ||
+ | |<code><b>pkg:list</b>($pkg as xs:string) as xs:string*</code><br /> | ||
+ | |- | ||
+ | | valign='top' | '''Summary''' | ||
+ | |Lists the names of all currently installed packages.<br /> | ||
|} | |} |
Revision as of 16:38, 19 January 2012
This module contains functions for managing EXPath packages. You can read more about BaseX' implementation of the EXPath Packaging API here
pkg:install
Signatures | pkg:install($path as xs:string) as empty-sequence() |
Summary | Installs a package. The parameter $path indicates the path to the package on the file system. |
Errors | PACK0001 is raised if the package does not exist. PACK0002 is raised if the package is already installed. PACK0003 is raised if the package to be installed requires a package which is still not installed. PACK0004 is raised if the package descriptor is invalid. PACK0005 is raised if the module contained in the package to be installed is already installed as part of another package. PACK0006 is raised if the package cannot be parsed. PACK0009 is raised if the package version is not supported. PACK0010 is raised if the package contains an invalid JAR descriptor. PACK0011 is raised if the package contains a JAR descriptor but it cannot be read. |
pkg:delete
Signatures | pkg:delete($pkg as xs:string) as empty-sequence() |
Summary | Deletes a package. The parameter $pkg indicates either the package name as specified in the package descriptor or the name of the directory where the package is installed. |
Errors | PACK0007 is raised if the package cannot be deleted. PACK0008 is raised if another package depends on the package to be deleted. |
pkg:list
Signatures | pkg:list($pkg as xs:string) as xs:string* |
Summary | Lists the names of all currently installed packages. |