Difference between revisions of "Fetch Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 10: Line 10:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
−
|Tries to fetch the resource referred to by the given URI.
+
|Fetches the resource referred to by the given URI and returns it as string.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
−
|{{Error|FODC0002|XQuery Errors#Functions Errors}} the resource could not be retrieved.
+
|{{Error|FODC0001|XQuery Errors#Functions Errors}} the URI could not be resolved, or the resource could not be retrieved.<br/>{{Error|FODC0002|XQuery Errors#Functions Errors}} the specified encoding is not supported, or unknown.
 
|-
 
|-
 
| '''Examples'''
 
| '''Examples'''
 
|
 
|
−
* {{Code|fetch:content('http://en.wikipedia.org'/)}} returns a string representation of the English Wikipedia main HTML page.
+
* {{Code|fetch:content('http://en.wikipedia.org')}} returns a string representation of the English Wikipedia main HTML page.
 +
|}
 +
 
 +
==fetch:content-binary==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|fetch:content-binary|$uri as xs:string|xs:string}}<br/>
 +
|-
 +
| '''Summary'''
 +
|Fetches the resource referred to by the given URI and returns it as base64Binary.
 +
|-
 +
| '''Errors'''
 +
|{{Error|FODC0001|XQuery Errors#Functions Errors}} the URI could not be resolved, or the resource could not be retrieved.
 +
|-
 +
| '''Examples'''
 +
|
 +
* {{Code|fetch:content-binary('http://www.ngdc.noaa.gov/mgg/image/color_etopo1_ice_low.jpg')}} returns the addressed image.
 +
|}
 +
 
 +
=Errors=
 +
 
 +
{| width='100%' class="wikitable" width="100%"
 +
! width="5%"|Code
 +
! width="95%"|Description
 +
|-
 +
|{{Code|BXFE0001}}
 +
|The URI could not be resolved, or the resource could not be retrieved.
 +
|-
 +
|{{Code|BXFE0002}}
 +
|The specified encoding is not supported, or unknown.
 
|}
 
|}
  

Revision as of 23:19, 2 January 2013

This XQuery Module provides functions to fetch the content of resources identified by URIs. For example, it fetches the content of file or http resources. The module is very similar to Zorba’s Fetch Module.

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 FODC0001: the URI could not be resolved, or the resource could not be retrieved.
FODC0002: the specified encoding is not supported, or unknown.
Examples

fetch:content-binary

Signatures fetch:content-binary($uri as xs:string) as xs:string
Summary Fetches the resource referred to by the given URI and returns it as base64Binary.
Errors FODC0001: 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.

Retrieved from "https://old.docs.basex.org/index.php?title=Fetch_Module&oldid=8680"