A RESTful browser for eXist Function Modules

compression
http://exist-db.org/xquery/compression
A module for compression and decompression functions
gzip
compression:gzip($data as xs:base64Binary) xs:base64Binary?
GZip's data
$dataThe data to GZip
tar
compression:tar($sources as xs:anyType+, $use-collection-hierarchy as xs:boolean) xs:base64Binary*
Tars nodes, resources and collections.
$sourcesThe sequence of URI's and/or Entrys. If a URI points to a collection then the collection, its resources and sub-collections are zipped recursively. 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-hierarchyIndicates whether the Collection hierarchy (if any) should be preserved in the zip file.
tar
compression:tar($sources as xs:anyType+, $use-collection-hierarchy as xs:boolean, $strip-prefix as xs:string) xs:base64Binary*
Tars nodes, resources and collections.
$sourcesThe sequence of URI's and/or Entrys. If a URI points to a collection then the collection, its resources and sub-collections are zipped recursively. 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-hierarchyIndicates whether the Collection hierarchy (if any) should be preserved in the zip file.
$strip-prefixThis prefix is stripped from the Entrys name
ungzip
compression:ungzip($gzip-data as xs:base64Binary) xs:base64Binary?
UnGZip's data
$gzip-dataThe gzip data to uncompress.
untar
compression:untar($tar-data as xs:base64Binary, $entry-filter as function, $entry-filter-param as xs:anyType*, $entry-data as function, $entry-data-param as xs:anyType*) item()*
UnTar all the resources/folders from the provided data by calling user defined functions to determine what and how to store the resources/folders
$tar-dataThe tar file data
$entry-filterA 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-paramA sequence with an additional parameters for filtering function.
$entry-dataA 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-paramA sequence with an additional parameters for storing function.
unzip
compression:unzip($zip-data as xs:base64Binary, $entry-filter as function, $entry-filter-param as xs:anyType*, $entry-data as function, $entry-data-param as xs:anyType*) 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
$zip-dataThe zip file data
$entry-filterA 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-paramA sequence with an additional parameters for filtering function.
$entry-dataA 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-paramA sequence with an additional parameters for storing function.
zip
compression:zip($sources as xs:anyType+, $use-collection-hierarchy as xs:boolean) xs:base64Binary*
Zips nodes, resources and collections.
$sourcesThe sequence of URI's and/or Entrys. If a URI points to a collection then the collection, its resources and sub-collections are zipped recursively. 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-hierarchyIndicates whether the Collection hierarchy (if any) should be preserved in the zip file.
zip
compression:zip($sources as xs:anyType+, $use-collection-hierarchy as xs:boolean, $strip-prefix as xs:string) xs:base64Binary*
Zips nodes, resources and collections.
$sourcesThe sequence of URI's and/or Entrys. If a URI points to a collection then the collection, its resources and sub-collections are zipped recursively. 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-hierarchyIndicates whether the Collection hierarchy (if any) should be preserved in the zip file.
$strip-prefixThis prefix is stripped from the Entrys name
Return to list of all modules