Difference between revisions of "Repository Module"
Jump to navigation
Jump to search
m (Text replace - "assigned to the {{Code|http://basex.org/errors}} namespace" to "assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace") |
|||
(15 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
=Conventions= | =Conventions= | ||
− | All functions in this module | + | All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/repo</nowiki></code> namespace, which is statically bound to the {{Code|repo}} prefix.<br/> |
− | |||
=Functions= | =Functions= | ||
==repo:install== | ==repo:install== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|repo:install|$ | + | |{{Func|repo:install|$uri as xs:string|empty-sequence()}}<br /> |
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
− | | | + | |Retrieves and installs a package from the given {{Code|$uri}}. Existing packages are replaced. |
− | |- | + | |- valign="top" |
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|not-found|#Errors}} a package does not exist.<br />{{Error|descriptor|#Errors}} the package descriptor is invalid.<br />{{Error|installed|#Errors}} the module contained in the package to be installed is already installed as part of another package.<br />{{Error|parse|#Errors}} an error occurred while parsing the package.<br />{{Error|version|#Errors}} the package version is not supported. |
|} | |} | ||
==repo:delete== | ==repo:delete== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|repo:delete|$ | + | |{{Func|repo:delete|$package as xs:string|empty-sequence()}}<br /> |
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
− | |Deletes a | + | |Deletes a {{Code|$package}}. The argument contains the package name, optionally suffixed with a dash and the package version.<br /> |
− | |- | + | |- valign="top" |
| '''Errors''' | | '''Errors''' | ||
− | |{{Error| | + | |{{Error|not-found|#Errors}} a package does not exist.<br />{{Error|delete|#Errors}} the package cannot be deleted. |
|} | |} | ||
Line 37: | Line 38: | ||
{| width='100%' | {| width='100%' | ||
− | |- | + | |- valign="top" |
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
|{{Func|repo:list||element(package)*}}<br /> | |{{Func|repo:list||element(package)*}}<br /> | ||
− | |- | + | |- valign="top" |
| '''Summary''' | | '''Summary''' | ||
|Lists the names and versions of all currently installed packages.<br /> | |Lists the names and versions of all currently installed packages.<br /> | ||
Line 50: | Line 51: | ||
! width="110"|Code | ! width="110"|Code | ||
|Description | |Description | ||
− | |- | + | |- valign="top" |
− | |{{Code| | + | |{{Code|delete}} |
− | |The | + | |The package cannot be deleted because of dependencies, or because files are missing. |
− | + | |- valign="top" | |
− | + | |{{Code|descriptor}} | |
− | |||
− | |||
− | |||
− | |||
− | |- | ||
− | |{{Code| | ||
|The package descriptor is invalid. | |The package descriptor is invalid. | ||
− | |- | + | |- valign="top" |
− | |{{Code| | + | |{{Code|installed}} |
|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. | ||
− | |- | + | |- valign="top" |
− | |{{Code| | + | |{{Code|not-found}} |
− | + | |A package does not exist. | |
− | + | |- valign="top" | |
− | + | |{{Code|parse}} | |
− | | | + | |An error occurred while parsing the package. |
− | |- | + | |- valign="top" |
− | |{{Code| | + | |{{Code|version}} |
− | | | ||
− | |- | ||
− | |{{Code| | ||
|The package version is not supported. | |The package version is not supported. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.0 | ||
+ | |||
+ | * Updated: error codes updated; errors now use the module namespace | ||
;Version 7.2.1 | ;Version 7.2.1 | ||
− | * Updated: | + | * Updated: {{Function||repo:install}}: existing packages will be replaced |
− | * Updated: | + | * Updated: {{Function||repo:delete}}: remove specific version of a package |
;Version 7.2 | ;Version 7.2 | ||
− | * Updated: | + | * Updated: {{Function||repo:list}} now returns nodes |
The module was introduced with Version 7.1. | The module was introduced with Version 7.1. | ||
− | |||
− |
Revision as of 14:19, 20 July 2022
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($uri as xs:string) as empty-sequence() |
Summary | Retrieves and installs a package from the given $uri . Existing packages are replaced.
|
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 : an error occurred while parsing the package.version : the package version is not supported.
|
repo:delete
Signatures | repo:delete($package as xs:string) as empty-sequence() |
Summary | Deletes a $package . The argument contains the package name, optionally suffixed with a dash 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
|
An error occurred while parsing the package. |
version
|
The package version is not supported. |
Changelog
- Version 9.0
- Updated: error codes updated; 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.