Module Library

This article is part of the XQuery Portal.

In addition to the standard XQuery Functions, BaseX comes with hundreds of additional functions, which are packaged in various modules.

The namespaces of the built-in modules are statically bound to their prefix. This means that they need not (but may) be declared in the query prolog.

Modules

Module	Description	Prefix	Namespace URI
Admin	Functions restricted to admin users.	admin	http://basex.org/modules/admin
Archive	Creating and processing ZIP archives.	archive	http://basex.org/modules/archive
Array	Functions for handling arrays.	array	http://www.w3.org/2005/xpath-functions/array
Binary	Processing binary data.	bin	http://expath.org/ns/binary
Client	Executing commands and queries on remote BaseX servers.	client	http://basex.org/modules/client
Conversion	Converting data (binary, numeric) to other formats.	convert	http://basex.org/modules/convert
Cryptography	Cryptographic functions, based on the EXPath Cryptograhic module.	crypto	http://expath.org/ns/crypto
CSV	Functions for processing CSV input.	csv	http://basex.org/modules/csv
Database	Functions for accessing and updating databases.	db	http://basex.org/modules/db
Fetch	Functions for fetching resources identified by URIs.	fetch	http://basex.org/modules/fetch
File	File handling, based on the latest draft of the EXPath File module.	file	http://expath.org/ns/file
Full-Text	Functions for performing full-text operations.	ft	http://basex.org/modules/ft
Hashing	Cryptographic hash functions.	hash	http://basex.org/modules/hash
Higher-Order	Additional higher-order functions that are not in the standard libraries.	hof	http://basex.org/modules/hof
HTML	Functions for converting HTML input to XML documents.	html	http://basex.org/modules/html
HTTP Client	Sending HTTP requests, based on the EXPath HTTP module.	http	http://expath.org/ns/http-client
Index	Functions for requesting details on database indexes.	index	http://basex.org/modules/index
Inspection	Functions for extracting internal module information.	inspect	http://basex.org/modules/inspect
Job	Organization of running commands and queries.	job	http://basex.org/modules/job
JSON	Parsing and serializing JSON documents.	json	http://basex.org/modules/json
Lazy	Functions for handling lazy items.	lazy	http://basex.org/modules/lazy
Map	Functions for handling maps (key/value pairs).	map	http://www.w3.org/2005/xpath-functions/map
Math	Mathematical operations, extending the W3C Working Draft.	math	http://www.w3.org/2005/xpath-functions/math
Process	Executing system commands from XQuery.	proc	http://basex.org/modules/proc
Profiling	Functions for profiling code snippets.	prof	http://basex.org/modules/prof
Random	Functions for creating random numbers.	random	http://basex.org/modules/random
Repository	Installing, deleting and listing packages.	repo	http://basex.org/modules/repo
SQL	JDBC bridge to access relational databases.	sql	http://basex.org/modules/sql
Store	Organize values in a main-memory key-value store.	store	http://basex.org/modules/store
String	Functions for performing string computations.	string	http://basex.org/modules/string
Unit	Unit testing framework.	unit	http://basex.org/modules/unit
Update	Functions for performing updates.	update	http://basex.org/modules/update
User	Creating and administering database users.	user	http://basex.org/modules/user
Utility	Various utility and helper functions.	util	http://basex.org/modules/util
Validation	Validating documents: DTDs, XML Schema, RelaxNG.	validate	http://basex.org/modules/validate
Web	Convenience functions for building web applications.	web	http://basex.org/modules/web
XQuery	Evaluating new XQuery expressions at runtime.	xquery	http://basex.org/modules/xquery
XSLT	Stylesheet transformations, based on Java’s and Saxon’s XSLT processor.	xslt	http://basex.org/modules/xslt
The following modules are available if the basex-api library is included in the classpath. This is the case if you start BaseX with one of the startup scripts or links provided by our complete distributions (zip, exe, war).
Request	Server-side functions for handling HTTP Request data.	request	http://exquery.org/ns/request
RESTXQ	Helper functions for the RESTXQ API.	rest	http://exquery.org/ns/restxq
Session	Functions for handling server-side HTTP Sessions.	session	http://basex.org/modules/session
Sessions	Functions for managing all server-side HTTP Sessions.	sessions	http://basex.org/modules/sessions
WebSocket	Functions for handling WebSocket connections.	ws	http://basex.org/modules/ws

Changelog

Version 10

• Removed: ZIP Module; Geo Module; Output Module (incorporated in String Module)