Difference between revisions of "Fetch Module"
Jump to navigation
Jump to search
m (Text replace - "| width='90' | '''Signatures'''" to "| width='120' | '''Signatures'''") |
m |
||
Line 55: | Line 55: | ||
|Returns the content-type (also called mime-type) of the resource specified by {{Code|$uri}}: | |Returns the content-type (also called mime-type) of the resource specified by {{Code|$uri}}: | ||
* If a remote resource is addressed, the request header will be evaluated. | * If a remote resource is addressed, the request header will be evaluated. | ||
− | * If the addressed resource is locally stored, the | + | * If the addressed resource is locally stored, the content-type will be guessed based on the file extension. |
|- | |- | ||
| '''Errors''' | | '''Errors''' |
Revision as of 14:59, 29 November 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. Invalid XML characters will be ignored if the CHECKSTRINGS option is turned off.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.