Difference between revisions of "Fetch Module"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
− | This [[Module Library|XQuery Module]] provides functions to fetch the content of resources identified by URIs. | + | This [[Module Library|XQuery Module]] provides functions to fetch the content of resources identified by URIs. Resources can be stored locally or remotely and e.g. use the {{Code|file://}} or {{Code|http://}} scheme. The [HTML Module] can be used to convert retrieved HTML documents to XML. |
+ | |||
+ | The module has been inspired by [http://www.zorba-xquery.com/html/modules/zorba/io/fetch Zorba’s Fetch Module]. | ||
=Conventions= | =Conventions= |
Revision as of 00:04, 8 January 2013
This XQuery Module provides functions to fetch the content of resources identified by URIs. Resources can be stored locally or remotely and e.g. use the file://
or http://
scheme. The [HTML Module] can be used to convert retrieved HTML documents to XML.
The module has been inspired by Zorba’s Fetch Module.
Conventions
All functions in this module are assigned to the http://basex.org/modules/fetch
namespace, which is statically bound to the fetch
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
Functions
fetch:content
Signatures | fetch:content($uri as xs:string) as xs:string fetch:content($uri as xs:string, $encoding as xs:string) as xs:string |
Summary | Fetches the resource referred to by the given URI and returns it as string. |
Errors | BXFE0001 : the URI could not be resolved, or the resource could not be retrieved.BXFE0002 : the specified encoding is not supported, or unknown.
|
Examples |
|
fetch:content-binary
Signatures | fetch:content-binary($uri as xs:string) as xs:base64Binary |
Summary | Fetches the resource referred to by the given URI and returns it as base64Binary. |
Errors | BXFE0001 : the URI could not be resolved, or the resource could not be retrieved.
|
Examples |
|
Errors
Code | Description |
---|---|
BXFE0001
|
The URI could not be resolved, or the resource could not be retrieved. |
BXFE0002
|
The specified encoding is not supported, or unknown. |
Changelog
The module was introduced with Version 7.5.1.