Difference between revisions of "Fetch Module"
Jump to navigation
Jump to search
Line 17: | Line 17: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Fetches the resource referred to by the given URI and returns it as streamable {{Code|xs:string}}. | + | |Fetches the resource referred to by the given URI and returns it as [[Streaming Module|streamable]] {{Code|xs:string}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 25: | Line 25: | ||
| | | | ||
* <code><nowiki>fetch:text("http://en.wikipedia.org")</nowiki></code> returns a string representation of the English Wikipedia main HTML page. | * <code><nowiki>fetch:text("http://en.wikipedia.org")</nowiki></code> returns a string representation of the English Wikipedia main HTML page. | ||
− | * <code><nowiki> | + | * <code><nowiki>stream:materialize(fetch:text("http://en.wikipedia.org"))</nowiki></code> returns a materialized representation of the streamable result. |
|} | |} | ||
Line 35: | Line 35: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Fetches the resource referred to by the given URI and returns it as streamable {{Code|xs:base64Binary}}. | + | |Fetches the resource referred to by the given URI and returns it as [[Streaming Module|streamable]] {{Code|xs:base64Binary}}. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 43: | Line 43: | ||
| | | | ||
* <code><nowiki>fetch:binary("http://images.trulia.com/blogimg/c/5/f/4/679932_1298401950553_o.jpg")</nowiki></code> returns the addressed image. | * <code><nowiki>fetch:binary("http://images.trulia.com/blogimg/c/5/f/4/679932_1298401950553_o.jpg")</nowiki></code> returns the addressed image. | ||
− | * <code><nowiki> | + | * <code><nowiki>stream:materialize(fetch:binary("http://en.wikipedia.org"))</nowiki></code> returns a materialized representation of the streamable result. |
|} | |} | ||
Revision as of 22:57, 12 March 2013
This XQuery Module provides simple 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. If more control over HTTP requests is required, the HTTP Module can be used. With the HTML Module, retrieved HTML documents can be converted to XML.
The module has initially been inspired by Zorba’s Fetch Module.
Contents
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:text
Signatures | fetch:text($uri as xs:string) as xs:string fetch:text($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 streamable xs: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:binary
Signatures | fetch:binary($uri as xs:string) as xs:base64Binary |
Summary | Fetches the resource referred to by the given URI and returns it as streamable xs:base64Binary .
|
Errors | BXFE0001 : the URI could not be resolved, or the resource could not be retrieved.
|
Examples |
|
fetch:content-type
Signatures | fetch:content-type($uri as xs:string) as xs:string |
Summary | Returns the content-type (also called mime-type) of the resource specified by $uri :
|
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.6.