Difference between revisions of "Repository Module"
Jump to navigation
Jump to search
(→Errors) |
|||
| Line 18: | Line 18: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
| − | |<b>[[XQuery Errors#Packaging Errors| | + | |<b>[[XQuery Errors#Packaging Errors|BXRE0001]]</b> is raised if the package does not exist.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0002]]</b> is raised if a package uses an invalid namespace URI.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0003]]</b> is raised if the package to be installed requires a package which is still not installed.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0004]]</b> is raised if the package descriptor is invalid.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0005]]</b> is raised if the module contained in the package to be installed is already installed as part of another package.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0006]]</b> is raised if the package cannot be parsed.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0009]]</b> is raised if the package version is not supported.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0010]]</b> is raised if the package contains an invalid JAR descriptor.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0011]]</b> is raised if the package contains a JAR descriptor but it cannot be read.<br /> |
|} | |} | ||
| Line 31: | Line 31: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
| − | |<b>[[XQuery Errors#Packaging Errors| | + | |<b>[[XQuery Errors#Packaging Errors|BXRE0007]]</b> is raised if the package cannot be deleted.<br /><b>[[XQuery Errors#Packaging Errors|BXRE0008]]</b> is raised if another package depends on the package to be deleted.<br /> |
|} | |} | ||
| Line 53: | Line 53: | ||
! width="95%"|Description | ! width="95%"|Description | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0001</code> |
|The addressed package does not exist. | |The addressed package does not exist. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0002</code> |
|A package uses an invalid namespace URI. | |A package uses an invalid namespace URI. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0003</code> |
|The package to be installed requires a package which is not installed yet. | |The package to be installed requires a package which is not installed yet. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0004</code> |
|The package descriptor is invalid. | |The package descriptor is invalid. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0005</code> |
|The module contained in the package to be installed is already installed as part of another package. | |The module contained in the package to be installed is already installed as part of another package. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0006</code> |
|The package cannot be parsed. | |The package cannot be parsed. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0009</code> |
|The package version is not supported. | |The package version is not supported. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0010</code> |
|The package contains an invalid JAR descriptor. | |The package contains an invalid JAR descriptor. | ||
|- | |- | ||
| − | |<code> | + | |<code>BXRE0011</code> |
|The package contains a JAR descriptor but it cannot be read. | |The package contains a JAR descriptor but it cannot be read. | ||
|} | |} | ||
Revision as of 02:36, 26 May 2012
This XQuery Module contains functions for installing, listing and deleting modules contained in the Repository.
Contents
Conventions
All functions in this module are assigned to the http://basex.org/modules/repo namespace, which is statically bound to the repo prefix.
All errors are assigned to the http://basex.org/errors namespace, which is statically bound to the bxerr prefix.
Functions
repo:install
| Signatures | repo:install($path as xs:string) as empty-sequence() |
| Summary | Installs a package, or (since Version 7.2.1), replaces an existing package. The parameter $path indicates the path to the package. |
| Errors | BXRE0001 is raised if the package does not exist. BXRE0002 is raised if a package uses an invalid namespace URI. BXRE0003 is raised if the package to be installed requires a package which is still not installed. BXRE0004 is raised if the package descriptor is invalid. BXRE0005 is raised if the module contained in the package to be installed is already installed as part of another package. BXRE0006 is raised if the package cannot be parsed. BXRE0009 is raised if the package version is not supported. BXRE0010 is raised if the package contains an invalid JAR descriptor. BXRE0011 is raised if the package contains a JAR descriptor but it cannot be read. |
repo:delete
| Signatures | repo: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 (since Version 7.2.1) the name, suffixed with a hyphen and the package version. |
| Errors | BXRE0007 is raised if the package cannot be deleted. BXRE0008 is raised if another package depends on the package to be deleted. |
repo:list
| Signatures | repo:list() as element(package)* |
| Summary | Lists the names and versions of all currently installed packages. |
Errors
| Code | Description |
|---|---|
BXRE0001
|
The addressed package does not exist. |
BXRE0002
|
A package uses an invalid namespace URI. |
BXRE0003
|
The package to be installed requires a package which is not installed yet. |
BXRE0004
|
The package descriptor is invalid. |
BXRE0005
|
The module contained in the package to be installed is already installed as part of another package. |
BXRE0006
|
The package cannot be parsed. |
BXRE0009
|
The package version is not supported. |
BXRE0010
|
The package contains an invalid JAR descriptor. |
BXRE0011
|
The package contains a JAR descriptor but it cannot be read. |
Changelog
Version 7.2.1
- Updated: repo:install: existing packages will be replaced
- Updated: repo:delete: remove specific version of a package
Version 7.2
- Updated: repo:list now returns nodes
The module was introduced with Version 7.1.
