Repository Module

From BaseX Documentation

Jump to: navigation, search

This XQuery Module contains functions for installing, listing and deleting modules contained in the Repository.

Contents

[edit] Conventions

Updated with Version 9.0:

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.

[edit] Functions

[edit] 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: an error occurred while parsing the package.
version: the package version is not supported.

[edit] repo:delete

Signatures repo:delete($pkg as xs:string) as empty-sequence()
Summary Deletes a package. The parameter $pkg indicates 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.

[edit] repo:list

Signatures repo:list() as element(package)*
Summary Lists the names and versions of all currently installed packages.

[edit] Errors

Updated with Version 9.0:

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.

[edit] Changelog

Version 9.0
Version 7.2.1
Version 7.2

The module was introduced with Version 7.1.

Personal tools
Namespaces
Variants
Actions
Navigation
Print/export