Bureaucrats, editor, reviewer, Administrators
13,550
edits
Changes
Jump to navigation
Jump to search
no edit summary
This article is part of the [[XQuery|XQuery Portal]].
In addition to the standard [https://www.w3.org/TR/xpath-functions-31/ XQuery Functions], BaseX comes with some hundred 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.
=ConventionsModules=
{| class="wikitable sortable"
|-valign="top"
! Module
! Description
! Prefix
! Namespace URI
|-valign="top"
| [[Admin Module|Admin]]
| Functions restricted to admin users.
| <code>admin</code>
| <code><nowiki>http://basex.org/modules/admin</nowiki></code>
|-valign="top"
| [[Archive Module|Archive]]
| Creating and processing ZIP archives.
| <code>archive</code>
| <code><nowiki>http://basex.org/modules/archive</nowiki></code>
|-valign="top"
| [[Array Module|Array]]
| Functions for handling arrays.
| <code>array</code>
| <code><nowiki>http://www.w3.org/2005/xpath-functions/array</nowiki></code>
|-valign="top"
| [[Binary Module|Binary]]
| Processing binary data.
| <code>bin</code>
| <code><nowiki>http://expath.org/ns/binary</nowiki></code>
|-valign="top"
| [[Client Module|Client]]
| Executing commands and queries on remote BaseX servers.
| <code>client</code>
| <code><nowiki>http://basex.org/modules/client</nowiki></code>
|-valign="top"
| [[Conversion Module|Conversion]]
| Converting data (binary, numeric) to other formats.
| <code>convert</code>
| <code><nowiki>http://basex.org/modules/convert</nowiki></code>
|-valign="top"
| [[Cryptographic Module|Cryptography]]
| Cryptographic functions, based on the [http://expath.org/spec/crypto EXPath Cryptograhic] module.
| <code>crypto</code>
| <code><nowiki>http://expath.org/ns/crypto</nowiki></code>
|-valign="top"
| [[CSV Module|CSV]]
| Functions for processing CSV input.
| <code>csv</code>
| <code><nowiki>http://basex.org/modules/csv</nowiki></code>
|-valign="top"
| [[Database Module|Database]]
| Functions for accessing and updating databases.
| <code>db</code>
| <code><nowiki>http://basex.org/modules/db</nowiki></code>
|-valign="top"
| [[Fetch Module|Fetch]]
| Functions for fetching resources identified by URIs.
| <code>fetch</code>
| <code><nowiki>http://basex.org/modules/fetch</nowiki></code>
|-valign="top"
| [[File Module|File]]
| File handling, based on the latest draft of the [http://expath.org/spec/file EXPath File] module.
| <code>file</code>
| <code><nowiki>http://expath.org/ns/file</nowiki></code>
|-valign="top"
| [[Full-Text Module|Full-Text]]
| Functions for performing full-text operations.
| <code>ft</code>
| <code><nowiki>http://basex.org/modules/ft</nowiki></code>
|-valign="top"
| [[Hashing Module|Hashing]]
| Cryptographic hash functions.
| <code>hash</code>
| <code><nowiki>http://basex.org/modules/hash</nowiki></code>
|-valign="top"
| [[Higher-Order Functions Module|Higher-Order]]
| Additional higher-order functions that are not in the standard libraries.
| <code>hof</code>
| <code><nowiki>http://basex.org/modules/hof</nowiki></code>
|-valign="top"
| [[HTML Module|HTML]]
| Functions for converting HTML input to XML documents.
| <code>html</code>
| <code><nowiki>http://basex.org/modules/html</nowiki></code>
|-valign="top"
| [[HTTP Client Module|HTTP Client]]
| Sending HTTP requests, based on the [http://expath.org/spec/http-client EXPath HTTP] module.
| <code>http</code>
| <code><nowiki>http://expath.org/ns/http-client</nowiki></code>
|-valign="top"
| [[Index Module|Index]]
| Functions for requesting details on database indexes.
| <code>index</code>
| <code><nowiki>http://basex.org/modules/index</nowiki></code>
|-valign="top"
| [[Inspection Module|Inspection]]
| Functions for extracting internal module information.
| <code>inspect</code>
| <code><nowiki>http://basex.org/modules/inspect</nowiki></code>
|-valign="top"
| [[Job Module|Job]]
| Organization of running commands and queries. {{Announce|Updated with Version 10}}
| <code>job</code>
| <code><nowiki>http://basex.org/modules/job</nowiki></code>
|-valign="top"
| [[JSON Module|JSON]]
| Parsing and serializing [https://www.json.org JSON documents].
| <code>json</code>
| <code><nowiki>http://basex.org/modules/json</nowiki></code>
|-valign="top"
| [[Lazy Module|Lazy]]
| Functions for handling lazy items.
| <code>lazy</code>
| <code><nowiki>http://basex.org/modules/lazy</nowiki></code>
|-valign="top"
| [[Map Module|Map]]
| Functions for handling maps (key/value pairs).
| <code>map</code>
| <code><nowiki>http://www.w3.org/2005/xpath-functions/map</nowiki></code>
|-valign="top"
| [[Math Module|Math]]
| Mathematical operations, extending the [https://www.w3.org/TR/xpath-functions-31/ W3C Working Draft].
| <code>math</code>
| <code><nowiki>http://www.w3.org/2005/xpath-functions/math</nowiki></code>
|-| [[Output Module|Output]]| Functions for simplifying formatted output.| <code>out</code>| <code><nowiki>http://basex.org/modules/out</nowiki></code>|-valign="top"
| [[Process Module|Process]]
| Executing system commands from XQuery.
| <code>proc</code>
| <code><nowiki>http://basex.org/modules/proc</nowiki></code>
|-valign="top"
| [[Profiling Module|Profiling]]
| Functions for profiling code snippets.
| <code>prof</code>
| <code><nowiki>http://basex.org/modules/prof</nowiki></code>
|-valign="top"
| [[Random Module|Random]]
| Functions for creating random numbers.
| <code>random</code>
| <code><nowiki>http://basex.org/modules/random</nowiki></code>
|-valign="top"
| [[Repository Module|Repository]]
| Installing, deleting and listing packages.
| <code>repo</code>
| <code><nowiki>http://basex.org/modules/repo</nowiki></code>
|-valign="top"
| [[SQL Module|SQL]]
| JDBC bridge to access relational databases.
| <code>sql</code>
| <code><nowiki>http://basex.org/modules/sql</nowiki></code>
|-valign="top"
| [[Store Module|Store]]
| Organize values in a main-memory key-value store. {{Announce|Introduced with Version 10}}
| <code>store</code>
| <code><nowiki>http://basex.org/modules/store</nowiki></code>
|-valign="top"
| [[String Module|String]]
| Functions for performing string computations. {{Announce|Updated with Version 10}}
| <code>string</code>
| <code><nowiki>http://basex.org/modules/string</nowiki></code>
|-valign="top"
| [[Unit Module|Unit]]
| Unit testing framework.
| <code>unit</code>
| <code><nowiki>http://basex.org/modules/unit</nowiki></code>
|-valign="top"
| [[Update Module|Update]]
| Functions for performing updates.
| <code>update</code>
| <code><nowiki>http://basex.org/modules/update</nowiki></code>
|-valign="top"
| [[User Module|User]]
| Creating and administering database users.
| <code>user</code>
| <code><nowiki>http://basex.org/modules/user</nowiki></code>
|-valign="top"
| [[Utility Module|Utility]]
| Various utility and helper functions.
| <code>util</code>
| <code><nowiki>http://basex.org/modules/util</nowiki></code>
|-valign="top"
| [[Validation Module|Validation]]
| Validating documents: DTDs, XML Schema, RelaxNG.
| <code>validate</code>
| <code><nowiki>http://basex.org/modules/validate</nowiki></code>
|-valign="top"
| [[Web Module|Web]]
| Convenience functions for building web applications.
| <code>web</code>
| <code><nowiki>http://basex.org/modules/web</nowiki></code>
|-valign="top"
| [[XQuery Module|XQuery]]
| Evaluating new XQuery expressions at runtime.
| <code>xquery</code>
| <code><nowiki>http://basex.org/modules/xquery</nowiki></code>
|-valign="top"
| [[XSLT Module|XSLT]]
| Stylesheet transformations, based on Java’s and Saxon’s XSLT processor.
| <code>xslt</code>
| <code><nowiki>http://basex.org/modules/xslt</nowiki></code>
|-valign="top"| [[ZIP Module|ZIP]]| ZIP functionality, based on the [http://expath.org/spec/zip EXPath ZIP] module (soon obsolete).| <code>zip</code>| <code><nowiki>http://expath.org/ns/zip</nowiki></code>colspan="4"|} The following modules will be are available if the {{Code|basex-api}} library is included in the classpath. This will be is the case if you start BaseX with one of the startup scripts or links provided by our complete distributions (zip, exe, war). {| class- valign="wikitable sortabletop"|-! Module! Description! Prefix! Namespace URI|-| [[Geo Module|Geo]]| Functions for processing geospatial data.| <code>geo</code>| <code><nowiki>http://expath.org/ns/geo</nowiki></code>|-
| [[Request Module|Request]]
| Server-side functions for handling HTTP Request data.
| <code>request</code>
| <code><nowiki>http://exquery.org/ns/request</nowiki></code>
|-valign="top"
| [[RESTXQ Module|RESTXQ]]
| Helper functions for the RESTXQ API.
| <code>rest</code>
| <code><nowiki>http://exquery.org/ns/restxq</nowiki></code>
|-valign="top"
| [[Session Module|Session]]
| Functions for handling server-side HTTP Sessions.
| <code>session</code>
| <code><nowiki>http://basex.org/modules/session</nowiki></code>
|-valign="top"
| [[Sessions Module|Sessions]]
| Functions for managing all server-side HTTP Sessions.
| <code>sessions</code>
| <code><nowiki>http://basex.org/modules/sessions</nowiki></code>
|-valign="top"
| [[WebSocket Module|WebSocket]]
| Functions for handling WebSocket connections.
| <code><nowiki>http://basex.org/modules/ws</nowiki></code>
|}
=Changelog=
;Version 10
* Removed: ZIP Module; Geo Module; Output Module (incorporated in String Module)
