XQuery Function Documentation

GZip's data

Parameters:

$data

The data to GZip

Returns:

xs:base64Binary?

Tars nodes, resources and collections.

Parameters:

$sources+

The sequence of URI's and/or Entrys. If an URI points to a collection then the collection, its resources and sub-collections are zipped recursively. If URI points to file (available only to the DBA role.) then file or directory are zipped. An Entry takes the format <entry name="filename.ext" type="collection|uri|binary|xml|text" method="deflate|store">data</entry>. The method attribute is only effective for the compression:zip function.

$use-collection-hierarchy

Indicates whether the Collection hierarchy (if any) should be preserved in the zip file.

Returns:

xs:base64Binary*

Tars nodes, resources and collections.

Parameters:

$sources+	The sequence of URI's and/or Entrys. If an URI points to a collection then the collection, its resources and sub-collections are zipped recursively. If URI points to file (available only to the DBA role.) then file or directory are zipped. An Entry takes the format <entry name="filename.ext" type="collection|uri|binary|xml|text" method="deflate|store">data</entry>. The method attribute is only effective for the compression:zip function.
$use-collection-hierarchy	Indicates whether the Collection hierarchy (if any) should be preserved in the zip file.
$strip-prefix	This prefix is stripped from the Entrys name

Returns:

xs:base64Binary*

UnGZip's data

Parameters:

$gzip-data

The gzip data to uncompress.

Returns:

xs:base64Binary?

UnTar all the resources/folders from the provided data by calling user defined functions to determine what and how to store the resources/folders

Parameters:

$tar-data	The tar file data
$entry-filter	A user defined function for filtering resources from the tar file. The function takes 3 parameters e.g. user:untar-entry-filter($path as xs:string, $data-type as xs:string, $param as item()*) as xs:boolean. $data-type may be 'resource' or 'folder'. $param is a sequence with any additional parameters, for example a list of extracted files. If the return type is true() it indicates the entry should be processed and passed to the entry-data function, else the resource is skipped.
$entry-filter-param*	A sequence with an additional parameters for filtering function.
$entry-data	A user defined function for storing an extracted resource from the tar file. The function takes 4 parameters e.g. user:untar-entry-data($path as xs:string, $data-type as xs:string, $data as item()?, $param as item()*). Or a user defined function wich returns path for storing an extracted resource from the tar file. The function takes 3 parameters e.g. user:entry-path($path as xs:string, $data-type as xs:string, $param as item()*) as xs:anyURI. $data-type may be 'resource' or 'folder'. $param is a sequence with any additional parameters
$entry-data-param*	A sequence with an additional parameters for storing function.

Returns:

item()*

UnZip all the resources/folders from the provided data by calling user defined functions to determine what and how to store the resources/folders

Parameters:

$zip-data	The zip file data
$entry-filter	A user defined function for filtering resources from the zip file. The function takes 3 parameters e.g. user:unzip-entry-filter($path as xs:string, $data-type as xs:string, $param as item()*) as xs:boolean. $data-type may be 'resource' or 'folder'. $param is a sequence with any additional parameters, for example a list of extracted files. If the return type is true() it indicates the entry should be processed and passed to the entry-data function, else the resource is skipped.
$entry-filter-param*	A sequence with an additional parameters for filtering function.
$entry-data	A user defined function for storing an extracted resource from the zip file. The function takes 4 parameters e.g. user:unzip-entry-data($path as xs:string, $data-type as xs:string, $data as item()?, $param as item()*). Or a user defined function wich returns path for storing an extracted resource from the tar file. The function takes 3 parameters e.g. user:entry-path($path as xs:string, $data-type as xs:string, $param as item()*) as xs:anyURI. $data-type may be 'resource' or 'folder'. $param is a sequence with any additional parameters.
$entry-data-param*	A sequence with an additional parameters for storing function.

Returns:

item()*

Zips nodes, resources and collections.

Parameters:

$sources+

The sequence of URI's and/or Entrys. If an URI points to a collection then the collection, its resources and sub-collections are zipped recursively. If URI points to file (available only to the DBA role.) then file or directory are zipped. An Entry takes the format <entry name="filename.ext" type="collection|uri|binary|xml|text" method="deflate|store">data</entry>. The method attribute is only effective for the compression:zip function.

$use-collection-hierarchy

Indicates whether the Collection hierarchy (if any) should be preserved in the zip file.

Returns:

xs:base64Binary*

Zips nodes, resources and collections.

Parameters:

$sources+	The sequence of URI's and/or Entrys. If an URI points to a collection then the collection, its resources and sub-collections are zipped recursively. If URI points to file (available only to the DBA role.) then file or directory are zipped. An Entry takes the format <entry name="filename.ext" type="collection|uri|binary|xml|text" method="deflate|store">data</entry>. The method attribute is only effective for the compression:zip function.
$use-collection-hierarchy	Indicates whether the Collection hierarchy (if any) should be preserved in the zip file.
$strip-prefix	This prefix is stripped from the Entrys name

Returns:

xs:base64Binary*