Difference between revisions of "Repository Module"
Jump to navigation
Jump to search
Line 34: | Line 34: | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error|not-found|#Errors}} a package does not exist.<br />{{Error|delete|#Errors}} the package cannot be deleted. | + | |{{Error|not-found|#Errors}} a package does not exist.<br />{{Error|delete|#Errors}} the package cannot be deleted. |
|} | |} | ||
Revision as of 14:46, 21 November 2017
This XQuery Module contains functions for installing, listing and deleting modules contained in the Repository.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/repo
namespace, which is statically bound to the repo
prefix.
Functions
repo:install
Signatures | repo:install($path as xs:string) as empty-sequence() |
Summary | Installs a package or replaces an existing package. The parameter $path indicates the path to the package. |
Errors | not-found : a package does not exist.descriptor : the package descriptor is invalid.installed : the module contained in the package to be installed is already installed as part of another package.parse : the package cannot be parsed.version : the package version is not supported.
|
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 the name, suffixed with a hyphen and the package version. |
Errors | not-found : a package does not exist.delete : the package cannot be deleted.
|
repo:list
Signatures | repo:list() as element(package)* |
Summary | Lists the names and versions of all currently installed packages. |
Errors
Code | Description |
---|---|
delete
|
The package cannot be deleted because of dependencies, or because files are missing. |
descriptor
|
The package descriptor is invalid. |
installed
|
The module contained in the package to be installed is already installed as part of another package. |
not-found
|
A package does not exist. |
parse
|
The package cannot be parsed. |
version
|
The package version is not supported. |
Changelog
- Version 9.0
- Updated: error codes updates; errors now use the module namespace
- 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.