Module Library

From BaseX Documentation

Jump to: navigation, search

This article is part of the XQuery Portal.

In addition to the standard XQuery Functions, BaseX offers further function modules, which are listed in the following table. The module namespaces are statically bound, which means that they need not (but may) be explicitly declared in the query prolog.

Module Description Prefix Namespace URI
Admin Functions restricted to admin users. admin
Archive Creating and processing ZIP archives. archive
Array Functions for handling arrays. array
Binary Processing binary data. bin
Client Executing commands and queries on remote BaseX servers. client
Conversion Converting data (binary, numeric) to other formats. convert
Cryptography Cryptographic functions, based on the EXPath Cryptograhic module. crypto
CSV Functions for processing CSV input. csv
Database Functions for accessing and updating databases. db
Fetch Functions for fetching resources identified by URIs. fetch
File File handling, based on the latest draft of the EXPath File module. file
Full-Text Functions for performing full-text operations. ft
Hashing Cryptographic hash functions. hash
Higher-Order Additional higher-order functions that are not in the standard libraries. hof
HTML Functions for converting HTML input to XML documents. html
HTTP Sending HTTP requests, based on the EXPath HTTP module. http
Index Functions for requesting details on database indexes. index
Inspection Functions for extracting internal module information. inspect
Jobs Organization of running commands and queries. jobs
JSON Parsing and serializing JSON documents. json
Map Functions for handling maps (key/value pairs). map
Math Mathematical operations, extending the W3C Working Draft. math
Output Functions for simplifying formatted output. out
Process Executing system commands from XQuery. proc
Profiling Functions for profiling code snippets. prof
Random Functions for creating random numbers. random
Repository Installing, deleting and listing packages. repo
SQL JDBC bridge to access relational databases. sql
Streaming Functions for handling streamable items. stream
Strings Functions for performing string computations. strings
Unit Unit testing framework. unit
User Creating and administering database users. user
Utility Various utility and helper functions. util
Validation Validating documents: DTDs, XML Schema, RelaxNG. validate
Web Convenience functions for building web applications. web
XQuery Evaluating new XQuery expressions at runtime. xquery
XSLT Stylesheet transformations, based on Java’s and Saxon’s XSLT processor. xslt
ZIP ZIP functionality, based on the EXPath ZIP module (soon obsolete). zip

For the following web application modules, the basex-api package must be included in the classpath and the modules must be imported in the query prolog. This is automatically the case if you use one of the complete distributions (zip, exe, war) of BaseX:

Module Description Prefix Namespace URI
Geo Functions for processing geospatial data. geo
Request Server-side functions for handling HTTP Request data. request
RESTXQ Helper functions for the RESTXQ API. rest
Session Functions for handling server-side HTTP Sessions. session
Sessions Functions for managing all server-side HTTP Sessions. sessions
Personal tools