XQuery Function Documentation

http://exist-db.org/xquery/file

java:org.exist.xquery.modules.file.FileModule

A module for performing various operations on files and directories stored in the server file system.

file:serialize

file:serialize($node-set as node()*, $path as item(), $parameters as item()*) as xs:boolean?

Writes the node set into a file on the file system. $parameters contains a sequence of zero or more serialization parameters specified as key=value pairs. The serialization options are the same as those recognized by "declare option exist:serialize". The function does NOT automatically inherit the serialization options of the XQuery it is called from. This method is only available to the DBA role.

Parameters:

$node-set*	The contents to write to the file system.
$path	The full path or URI to the file
$parameters*	The serialization parameters: either a sequence of key=value pairs or an output:serialization-parameters element as defined by the standard fn:serialize function.

Returns:

xs:boolean? : true on success - false if the specified file can not be created or is not writable. The empty sequence is returned if the argument sequence is empty.

file:serialize

file:serialize($node-set as node()*, $path as item(), $parameters as item()*, $append as xs:boolean) as xs:boolean?

Writes the node set into a file on the file system, optionally appending to it. $parameters contains a sequence of zero or more serialization parameters specified as key=value pairs. The serialization options are the same as those recognized by "declare option exist:serialize". The function does NOT automatically inherit the serialization options of the XQuery it is called from. This method is only available to the DBA role.

Parameters:

$node-set*	The contents to write to the file system.
$path	The full path or URI to the file
$parameters*	The serialization parameters: either a sequence of key=value pairs or an output:serialization-parameters element as defined by the standard fn:serialize function.
$append	Should content be appended?

Returns:

xs:boolean? : true on success - false if the specified file can not be created or is not writable. The empty sequence is returned if the argument sequence is empty.

file:serialize-binary

file:serialize-binary($binarydata as xs:base64Binary, $path as item()) as xs:boolean

Writes binary data into a file on the file system. This method is only available to the DBA role.

Parameters:

$binarydata	The contents to write to the file system.
$path	The full path or URI to the file

Returns:

xs:boolean : true on success - false if the specified file can not be created or is not writable

file:serialize-binary

file:serialize-binary($binarydata as xs:base64Binary, $path as item(), $append as xs:boolean) as xs:boolean

Writes binary data into a file on the file system, optionally appending the content. This method is only available to the DBA role.

Parameters:

$binarydata	The contents to write to the file system.
$path	The full path or URI to the file
$append	Should content be appended?

Returns:

xs:boolean : true on success - false if the specified file can not be created or is not writable