Difference between revisions of "File Module"

From BaseX Documentation
Jump to navigation Jump to search
m (Fix syntax of wiki template usage so the content renders properly)
 
(16 intermediate revisions by 2 users not shown)
Line 46: Line 46:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:list|$dir as xs:string|xs:string*}}<br />{{Func|file:list|$dir as xs:string, $recursive as xs:boolean|xs:string*}}<br />{{Func|file:list|$dir as xs:string, $recursive as xs:boolean, $pattern as xs:string|xs:string*}}<br />
+
|<pre>file:list(
 +
  $dir       as xs:string,
 +
  $recursive as xs:boolean:= false(),
 +
  $pattern    as xs:string   := ()
 +
) as xs:string*</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Lists all files and directories found in the specified {{Code|$dir}}. The returned paths are relative to the provided path.<br />The optional parameter {{Code|$recursive}} specifies whether subdirectories will be traversed, too.<br />The optional parameter {{Code|$pattern}} defines a file name pattern in the [[Commands#Glob_Syntax|Glob Syntax]]. If present, only those files and directories are returned that correspond to the pattern. Several patterns can be separated with a comma ({{Code|,}}).<br />
+
|Lists all files and directories found in the specified {{Code|$dir}}. The returned paths are relative to the provided path.<br/>If {{Code|$recursive}} is set to true, subdirectories will be traversed.<br/>The optional parameter {{Code|$pattern}} defines a file name pattern in the [[Commands#Glob_Syntax|Glob Syntax]]. If present, only those files and directories are returned that correspond to the pattern. Several patterns can be separated with a comma ({{Code|,}}).<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|no-dir|#Errors}} the specified path does not point to a directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|no-dir|#Errors}} the specified path does not point to a directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 +
|- valign="top"
 +
| '''Examples'''
 +
| Return the contents of large {{Code|.txt}} files located in a specific directory and its subdirectories:
 +
<pre lang='xquery'>
 +
let $root := 'path/to/files/'
 +
for $file in file:list($root, true(), '*.txt')
 +
let $path := $root || $file
 +
where file:size($path) > 1000000
 +
return file:read-text($path)
 +
</pre>
 
|}
 
|}
  
Line 60: Line 74:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:children|$dir as xs:string|xs:string*}}
+
|<pre>file:children(
 +
  $dir as xs:string
 +
) as xs:string*</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 67: Line 83:
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|no-dir|#Errors}} the specified path does not point to a directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|no-dir|#Errors}} the specified path does not point to a directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 +
|- valign="top"
 +
| '''Examples'''
 +
| Return the contents of large {{Code|.txt}} files located in a specific directory:
 +
<pre lang='xquery'>
 +
for $file in file:children('path/to/files/')
 +
where matches($file, '.txt', 'i') and file:size($file) > 1000000
 +
return file:read-text($$file)
 +
</pre>
 
|}
 
|}
  
Line 74: Line 98:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:descendants|$dir as xs:string|xs:string*}}
+
|<pre>file:descendants(
 +
  $dir as xs:string
 +
) as xs:string*</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 81: Line 107:
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|no-dir|#Errors}} the specified path does not point to a directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|no-dir|#Errors}} the specified path does not point to a directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 +
|- valign="top"
 +
| '''Examples'''
 +
| Return the contents of all {{Code|.txt}} files located in a specific directory and its subdirectories:
 +
<pre lang='xquery'>
 +
for $file in file:descendants('path/to/files/')
 +
where matches($file, '.txt', 'i') and file:size($file) > 1000000
 +
return file:read-text($$file)
 +
</pre>
 
|}
 
|}
  
Line 88: Line 122:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:read-binary|$path as xs:string|xs:base64Binary}}<br />{{Func|file:read-binary|$path as xs:string, $offset as xs:integer|xs:base64Binary}}<br />{{Func|file:read-binary|$path as xs:string, $offset as xs:integer, $length as xs:integer|xs:base64Binary}}
+
|<pre>file:read-binary(
 +
  $path   as xs:string,
 +
  $offset as xs:integer := (),
 +
  $length  as xs:integer := ()
 +
) as xs:base64Binary</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Reads the binary content of the file specified by {{Code|$path}} and returns it as [[Lazy Module|lazy]] {{Code|xs:base64Binary}} item.<br />The optional parameters {{Code|$offset}} and {{Code|$length}} can be used to read chunks of a file.
+
|Reads the binary content of the file specified by {{Code|$path}} and returns it as [[Lazy Module|lazy]] {{Code|xs:base64Binary}} item.<br/>The optional parameters {{Code|$offset}} and {{Code|$length}} can be used to read chunks of a file.
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|out-of-range|#Errors}} the offset or length is negative, or the chosen values would exceed the file bounds.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|out-of-range|#Errors}} the offset or length is negative, or the chosen values would exceed the file bounds.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
Line 106: Line 144:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:read-text|$path as xs:string|xs:string}}<br />{{Func|file:read-text|$path as xs:string, $encoding as xs:string|xs:string}}<br />{{Func|file:read-text|$path as xs:string, $encoding as xs:string, $fallback as xs:boolean|xs:string}}<br />
+
|<pre>file:read-text(
 +
  $path     as xs:string,
 +
  $encoding as xs:string   := (),
 +
  $fallback as xs:boolean?  := false()
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
 
|Reads the textual contents of the file specified by {{Code|$path}} and returns it as [[Lazy Module|lazy]] {{Code|xs:string}} item:
 
|Reads the textual contents of the file specified by {{Code|$path}} and returns it as [[Lazy Module|lazy]] {{Code|xs:string}} item:
 
* The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
 
* The UTF-8 default encoding can be overwritten with the optional {{Code|$encoding}} argument.
* By default, invalid characters will be rejected. If {{Code|$fallback}} is set to true, these characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).
+
* By default, invalid XML characters will be rejected. If {{Code|$fallback}} is enabled, the characters will be replaced with the Unicode replacement character <code>FFFD</code> (&#xFFFD;).
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.
 
|- valign="top"
 
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
Line 126: Line 168:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:read-text-lines|$path as xs:string|xs:string*}}<br />{{Func|file:read-text-lines|$path as xs:string, $encoding as xs:string|xs:string*}}<br />{{Func|file:read-text-lines|$path as xs:string, $encoding as xs:string, $fallback as xs:boolean|xs:string*}}<br />{{Func|file:read-text-lines|$path as xs:string, $encoding as xs:string, $fallback as xs:boolean, $offset as xs:integer|xs:string*}}<br />{{Func|file:read-text-lines|$path as xs:string, $encoding as xs:string, $fallback as xs:boolean, $offset as xs:integer, $length as xs:integer|xs:string*}}<br />
+
|<pre>file:read-text-lines(
 +
  $path     as xs:string,
 +
  $encoding as xs:string   := (),
 +
  $fallback as xs:boolean:= false(),
 +
  $offset   as xs:integer:= (),
 +
  $length    as xs:integer?  := ()
 +
) as xs:string*</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 136: Line 184:
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 145: Line 193:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:create-dir|$dir as xs:string|empty-sequence()}}<br />
+
|<pre>file:create-dir(
 +
  $dir as xs:string
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Creates the directory specified by {{Code|$dir}} if it does not already exist. Non-existing parent directories will be created as well.<br />
+
|Creates the directory specified by {{Code|$dir}} if it does not already exist. Non-existing parent directories will be created as well.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|exists|#Errors}} the specified target exists, but is no directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|exists|#Errors}} the specified target exists, but is no directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 159: Line 209:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:create-temp-dir|$prefix as xs:string, $suffix as xs:string|xs:string}}<br />{{Func|file:create-temp-dir|$prefix as xs:string, $suffix as xs:string, $dir as xs:string|xs:string}}
+
|<pre>file:create-temp-dir(
 +
  $prefix as xs:string,
 +
  $suffix as xs:string,
 +
  $dir     as xs:string := ()
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 166: Line 220:
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the specified directory points to a file.<br />{{Error|io-error|#Errors}} the directory could not be created.
+
|{{Error|no-dir|#Errors}} the specified directory points to a file.<br/>{{Error|io-error|#Errors}} the directory could not be created.
 
|}
 
|}
  
Line 173: Line 227:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:create-temp-file|$prefix as xs:string, $suffix as xs:string|xs:string}}<br />{{Func|file:create-temp-file|$prefix as xs:string, $suffix as xs:string, $dir as xs:string|xs:string}}
+
|<pre>file:create-temp-file(
 +
  $prefix as xs:string,
 +
  $suffix as xs:string,
 +
  $dir     as xs:string := ()
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 180: Line 238:
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the specified directory points to a file.<br />{{Error|io-error|#Errors}} the directory could not be created.
+
|{{Error|no-dir|#Errors}} the specified directory points to a file.<br/>{{Error|io-error|#Errors}} the directory could not be created.
 
|}
 
|}
  
Line 187: Line 245:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:delete|$path as xs:string|empty-sequence()}}<br />{{Func|file:delete|$path as xs:string, $recursive as xs:boolean|empty-sequence()}}<br />
+
|<pre>file:delete(
 +
  $path       as xs:string,
 +
  $recursive as xs:boolean?  := false()
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Recursively deletes a file or directory specified by {{Code|$path}}.<br />The optional parameter {{Code|$recursive}} specifies whether subdirectories will be deleted, too.<br />
+
|Recursively deletes a file or directory specified by {{Code|$path}}.<br/>The optional parameter {{Code|$recursive}} specifies whether subdirectories will be deleted, too.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified path does not exist.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified path does not exist.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 201: Line 262:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:write|$path as xs:string, $items as item()*|empty-sequence()}}<br />{{Func|file:write|$path as xs:string, $items as item()*, $params as item()|empty-sequence()}}<br />
+
|<pre>file:write(
 +
  $path     as xs:string,
 +
  $input    as item()*,
 +
  $options  as map(*)?    := map { }
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Writes a serialized sequence of items to the specified file. If the file already exists, it will be overwritten.<br />The {{Code|$params}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br />
+
|Writes serialized {{Code|$input}} to the specified file. If the file already exists, it will be overwritten.<br/>The {{Code|$options}} argument contains [[Serialization|serialization parameters]]. As with [https://www.w3.org/TR/xpath-functions-31/#func-serialize fn:serialize()], the parameters can be specified<br/>
 
* either as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element:
 
* either as children of an {{Code|&lt;output:serialization-parameters/&gt;}} element:
<syntaxhighlight lang="xml">
+
<pre lang="xml">
 
<output:serialization-parameters>
 
<output:serialization-parameters>
 
   <output:method value='xml'/>
 
   <output:method value='xml'/>
Line 213: Line 278:
 
   ...
 
   ...
 
</output:serialization-parameters>
 
</output:serialization-parameters>
</syntaxhighlight>
+
</pre>
 
* or as map, which contains all key/value pairs:
 
* or as map, which contains all key/value pairs:
<syntaxhighlight lang="xquery">
+
<pre lang='xquery'>
 
map { "method": "xml", "cdata-section-elements": "div", ... }
 
map { "method": "xml", "cdata-section-elements": "div", ... }
</syntaxhighlight>
+
</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
Line 232: Line 297:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:write-binary|$path as xs:string, $value as xs:anyAtomicType|empty-sequence()}}<br />{{Func|file:write-binary|$path as xs:string, $value as xs:anyAtomicType, $offset as xs:integer|empty-sequence()}}<br />
+
|<pre>file:write-binary(
 +
  $path   as xs:string,
 +
  $value   as xs:anyAtomicType,
 +
  $offset as xs:integer       := ()
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Writes a binary item (xs:base64Binary, xs:hexBinary) to the specified file. If the file already exists, it will be overwritten.<br />If {{Code|$offset}} is specified, data will be written at this file position. An existing file may be resized by that operation.
+
|Writes a binary item (xs:base64Binary, xs:hexBinary) to the specified file. If the file already exists, it will be overwritten.<br/>If {{Code|$offset}} is specified, data will be written at this file position. An existing file may be resized by that operation.
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|out-of-range|#Errors}} the offset is negative, or it exceeds the current file size.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|out-of-range|#Errors}} the offset is negative, or it exceeds the current file size.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 246: Line 315:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:write-text|$path as xs:string, $value as xs:string|empty-sequence()}}<br />{{Func|file:write-text|$path as xs:string, $value as xs:string, $encoding as xs:string|empty-sequence()}}<br />
+
|<pre>file:write-text(
 +
  $path     as xs:string,
 +
  $value     as xs:string,
 +
  $encoding as xs:string := ()
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Writes a string to the specified file. If the file already exists, it will be overwritten.<br />The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br />
+
|Writes a string to the specified file. If the file already exists, it will be overwritten.<br/>The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 260: Line 333:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:write-text-lines|$path as xs:string, $values as xs:string*|empty-sequence()}}<br />{{Func|file:write-text-lines|$path as xs:string, $values as xs:string*, $encoding as xs:string|empty-sequence()}}<br />
+
|<pre>file:write-text-lines(
 +
  $path     as xs:string,
 +
  $values   as xs:string*,
 +
  $encoding as xs:string   := ()
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Writes a sequence of strings to the specified file, each followed by the system specific newline character. If the file already exists, it will be overwritten.<br />The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br />
+
|Writes a sequence of strings to the specified file, each followed by the system specific newline character. If the file already exists, it will be overwritten.<br/>The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 274: Line 351:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:append|$path as xs:string, $items as item()*|empty-sequence()}}<br />{{Func|file:append|$path as xs:string, $items as item()*, $params as item()|empty-sequence()}}<br />
+
|<pre>file:append(
 +
  $path     as xs:string,
 +
  $input    as item()*,
 +
  $options  as map(*)?    := map { }
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Appends a serialized sequence of items to the specified file. If the file does not exists, a new file is created.<br />
+
|Appends a serialized sequence of {{Code|$input}} to the specified file, with the supplied {{Code|$options}} as serialization parameters. If the file does not exist, a new file is created.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 288: Line 369:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:append-binary|$path as xs:string, $value as xs:anyAtomicType|empty-sequence()}}<br />
+
|<pre>file:append-binary(
 +
  $path   as xs:string,
 +
  $value as xs:anyAtomicType
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Appends a binary item (xs:base64Binary, xs:hexBinary) to the specified file. If the file does not exists, a new one is created.<br />
+
|Appends a binary item (xs:base64Binary, xs:hexBinary) to the specified file. If the file does not exists, a new one is created.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 302: Line 386:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:append-text|$path as xs:string, $value as xs:string|empty-sequence()}}<br />{{Func|file:append-text|$path as xs:string, $value as xs:string, $encoding as xs:string|empty-sequence()}}<br />
+
|<pre>file:append-text(
 +
  $path     as xs:string,
 +
  $value     as xs:string,
 +
  $encoding as xs:string := ()
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Appends a string to a file specified by {{Code|$path}}. If the specified file does not exists, a new file is created.<br />The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br />
+
|Appends a string to a file specified by {{Code|$path}}. If the specified file does not exists, a new file is created.<br/>The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 316: Line 404:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:append-text-lines|$path as xs:string, $values as xs:string*|empty-sequence()}}<br />{{Func|file:append-text-lines|$path as xs:string, $values as xs:string*, $encoding as xs:string|empty-sequence()}}<br />
+
|<pre>file:append-text-lines(
 +
  $path     as xs:string,
 +
  $values   as xs:string*,
 +
  $encoding as xs:string   := ()
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Appends a sequence of strings to the specified file, each followed by the system specific newline character. If the specified file does not exists, a new file is created.<br />The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br />
+
|Appends a sequence of strings to the specified file, each followed by the system specific newline character. If the specified file does not exists, a new file is created.<br/>The optional parameter {{Code|$encoding}} defines the output encoding (default: UTF-8).<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br />{{Error|is-dir|#Errors}} the specified path is a directory.<br />{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|no-dir|#Errors}} the parent of specified path is no directory.<br/>{{Error|is-dir|#Errors}} the specified path is a directory.<br/>{{Error|unknown-encoding|#Errors}} the specified encoding is not supported, or unknown.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 330: Line 422:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:copy|$source as xs:string, $target as xs:string|empty-sequence()}}<br />
+
|<pre>file:copy(
 +
  $source as xs:string,
 +
  $target as xs:string
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Copies a file or directory specified by {{Code|$source}} to the file or directory specified by {{Code|$target}}. If the target file already exists, it will be overwritten. No operation will be performed if the source and target path are equal.<br />
+
|Copies a file or directory specified by {{Code|$source}} to the file or directory specified by {{Code|$target}}. If the target file already exists, it will be overwritten. No operation will be performed if the source and target path are equal.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified source does not exist.<br />{{Error|exists|#Errors}} the specified source is a directory and the target is a file.<br />{{Error|no-dir|#Errors}} the parent of the specified target is no directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified source does not exist.<br/>{{Error|exists|#Errors}} the specified source is a directory and the target is a file.<br/>{{Error|no-dir|#Errors}} the parent of the specified target is no directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 
|}
 
|}
  
Line 344: Line 439:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:move|$source as xs:string, $target as xs:string|empty-sequence()}}<br />
+
|<pre>file:move(
 +
  $source as xs:string,
 +
  $target as xs:string
 +
) as empty-sequence()</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Moves or renames the file or directory specified by {{Code|$source}} to the path specified by {{Code|$target}}. If the target file already exists, it will be overwritten. No operation will be performed if the source and target path are equal.<br />
+
|Moves or renames the file or directory specified by {{Code|$source}} to the path specified by {{Code|$target}}. If the target file already exists, it will be overwritten. No operation will be performed if the source and target path are equal.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified source does not exist.<br />{{Error|exists|#Errors}} the specified source is a directory and the target is a file.<br />{{Error|no-dir|#Errors}} the parent of the specified target is no directory.<br />{{Error|io-error|#Errors}} the operation fails for some other reason.<br />
+
|{{Error|not-found|#Errors}} the specified source does not exist.<br/>{{Error|exists|#Errors}} the specified source is a directory and the target is a file.<br/>{{Error|no-dir|#Errors}} the parent of the specified target is no directory.<br/>{{Error|io-error|#Errors}} the operation fails for some other reason.<br/>
 +
|- valign="top"
 +
| '''Examples'''
 +
|When renaming a file, remember that relative file paths are resolved against the current working directory. Some ways to rename:
 +
<pre lang='xquery'>
 +
file:move('/projects/new/octopus', '/projects/new/septimus')
 +
</pre>
 +
<pre lang='xquery'>
 +
$path ! file:move(., file:parent(.)||$newName)
 +
</pre>
 +
 
 
|}
 
|}
  
Line 360: Line 468:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:exists|$path as xs:string|xs:boolean}}<br />
+
|<pre>file:exists(
 +
  $path as xs:string
 +
) as xs:boolean</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns an {{Code|xs:boolean}} indicating whether a file or directory specified by {{Code|$path}} exists in the file system.<br />
+
|Returns an {{Code|xs:boolean}} indicating whether a file or directory specified by {{Code|$path}} exists in the file system.<br/>
 
|}
 
|}
  
Line 371: Line 481:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:is-dir|$path as xs:string|xs:boolean}}<br />
+
|<pre>file:is-dir(
 +
  $path as xs:string
 +
) as xs:boolean</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns an {{Code|xs:boolean}} indicating whether the argument {{Code|$path}} points to an existing directory.<br />
+
|Returns an {{Code|xs:boolean}} indicating whether the argument {{Code|$path}} points to an existing directory.<br/>
 
|}
 
|}
  
Line 382: Line 494:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:is-absolute|$path as xs:string|xs:boolean}}<br />
+
|<pre>file:is-absolute(
 +
  $path as xs:string
 +
) as xs:boolean</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns an {{Code|xs:boolean}} indicating whether the argument {{Code|$path}} is absolute.<br />The behavior of this function depends on the operating system: On Windows, an absolute path starts with the drive letter and a colon, whereas on Linux it starts with a slash.
+
|Returns an {{Code|xs:boolean}} indicating whether the argument {{Code|$path}} is absolute.<br/>The behavior of this function depends on the operating system: On Windows, an absolute path starts with the drive letter and a colon, whereas on Linux it starts with a slash.
 
|}
 
|}
  
Line 393: Line 507:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:is-file|$path as xs:string|xs:boolean}}<br />
+
|<pre>file:is-file(
 +
  $path as xs:string
 +
) as xs:boolean</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns an {{Code|xs:boolean}} indicating whether the argument {{Code|$path}} points to an existing file.<br />
+
|Returns an {{Code|xs:boolean}} indicating whether the argument {{Code|$path}} points to an existing file.<br/>
 
|}
 
|}
  
Line 404: Line 520:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:last-modified|$path as xs:string|xs:dateTime}}<br />
+
|<pre>file:last-modified(
 +
  $path as xs:string
 +
) as xs:dateTime</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Retrieves the timestamp of the last modification of the file or directory specified by {{Code|$path}}.<br />
+
|Retrieves the timestamp of the last modification of the file or directory specified by {{Code|$path}}.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified path does not exist.<br />
+
|{{Error|not-found|#Errors}} the specified path does not exist.<br/>
 
|}
 
|}
  
Line 418: Line 536:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:size|$path as xs:string|xs:integer}}<br />
+
|<pre>file:size(
 +
  $path as xs:string
 +
) as xs:integer</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the size, in bytes, of the file specified by {{Code|$path}}, or {{Code|0}} for directories.<br />
+
|Returns the size, in bytes, of the file specified by {{Code|$path}}, or {{Code|0}} for directories.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>
 
|}
 
|}
  
Line 434: Line 554:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:name|$path as xs:string|xs:string}}
+
|<pre>file:name(
 +
  $path as xs:string
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
Line 446: Line 568:
  
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:parent|$path as xs:string|xs:string?}}<br />
+
|<pre>file:parent(
 +
  $path as xs:string
 +
) as xs:string?</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the absolute path to the parent directory of a file or directory specified by {{Code|$path}}. An empty sequence is returned if the path points to a root directory.<br/>The inverse function is {{Function||file:children}}.<br />
+
|Returns the absolute path to the parent directory of a file or directory specified by {{Code|$path}}. An empty sequence is returned if the path points to a root directory.<br/>The inverse function is {{Function||file:children}}.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
Line 461: Line 585:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:path-to-native|$path as xs:string|xs:string}}<br />
+
|<pre>file:path-to-native(
 +
  $path as xs:string
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Transforms the {{Code|$path}} argument to its native representation on the operating system.<br />
+
|Transforms the {{Code|$path}} argument to its native representation on the operating system.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|not-found|#Errors}} the specified file does not exist.<br />{{Error|io-error|#Errors}} the specified path cannot be transformed to its native representation.<br />
+
|{{Error|not-found|#Errors}} the specified file does not exist.<br/>{{Error|io-error|#Errors}} the specified path cannot be transformed to its native representation.<br/>
 
|}
 
|}
  
Line 475: Line 601:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:resolve-path|$path as xs:string|xs:string}}<br />{{Func|file:resolve-path|$path as xs:string, $base as xs:string|xs:string}}<br />
+
|<pre>file:resolve-path(
 +
  $path as xs:string,
 +
  $base as xs:string := ()
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Transforms the {{Code|$path}} argument to an absolute operating system path.<br />If the path is relative, and if an absolute {{Code|$base}} path is specified, it will be resolved against this path.
+
|Transforms the {{Code|$path}} argument to an absolute operating system path.<br/>If the path is relative, and if an absolute {{Code|$base}} path is specified, it will be resolved against this path.
 
|- valign="top"
 
|- valign="top"
 
| '''Errors'''
 
| '''Errors'''
|{{Error|is-relative|#Errors}} the specified base path is relative.<br />
+
|{{Error|is-relative|#Errors}} the specified base path is relative.<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Examples'''
 
| '''Examples'''
Line 495: Line 624:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:path-to-uri|$path as xs:string|xs:string}}<br />
+
|<pre>file:path-to-uri(
 +
  $path as xs:string
 +
) as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Transforms the path specified by {{Code|$path}} into a URI with the {{Code|file://}} scheme.<br />
+
|Transforms the path specified by {{Code|$path}} into a URI with the {{Code|file://}} scheme.<br/>
 
|}
 
|}
  
Line 508: Line 639:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Code|'''file:dir-separator'''() as xs:string}}<br />
+
|{{Code|'''file:dir-separator'''() as xs:string}}<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the directory separator used by the operating system, such as {{Code|/}} or {{Code|\}}.<br />
+
|Returns the directory separator used by the operating system, such as {{Code|/}} or {{Code|\}}.<br/>
 
|}
 
|}
  
Line 519: Line 650:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Code|'''file:path-separator'''() as xs:string}}<br />
+
|{{Code|'''file:path-separator'''() as xs:string}}<br/>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the path separator used by the operating system, such as {{Code|;}} or {{Code|:}}.<br />
+
|Returns the path separator used by the operating system, such as {{Code|;}} or {{Code|:}}.<br/>
 
|}
 
|}
  
Line 530: Line 661:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:line-separator||xs:string}}
+
|<pre>file:line-separator() as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the line separator used by the operating system, such as {{Code|&amp;#10;}}, {{Code|&amp;#13;&amp;#10;}} or {{Code|&amp;#13;}}.<br />
+
|Returns the line separator used by the operating system, such as {{Code|&amp;#10;}}, {{Code|&amp;#13;&amp;#10;}} or {{Code|&amp;#13;}}.<br/>
 
|}
 
|}
  
Line 541: Line 672:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:temp-dir||xs:string}}
+
|<pre>file:temp-dir() as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the system’s default temporary-file directory.<br />
+
|Returns the system’s default temporary-file directory.<br/>
 
|}
 
|}
  
Line 552: Line 683:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:current-dir||xs:string}}
+
|<pre>file:current-dir() as xs:string</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the current working directory. This function returns the same result as the function call <code>file:resolve-path("")</code>.
+
|Returns the ''current working directory'', i.e., the directory from which the query processor was started. This function returns the same result as the function call <code>file:resolve-path("")</code>.
 
|}
 
|}
  
Line 563: Line 694:
 
{| width='100%'
 
{| width='100%'
 
|- valign="top"
 
|- valign="top"
| width='120' | '''Signatures'''
+
| width='120' | '''Signature'''
|{{Func|file:base-dir||xs:string?}}
+
|<pre>file:base-dir() as xs:string?</pre>
 
|- valign="top"
 
|- valign="top"
 
| '''Summary'''
 
| '''Summary'''
|Returns the parent directory of the static base URI. If the Base URI property is undefined, the empty sequence is returned. - If a static base URI exists, and if points to a local file path, this function returns the same result as the expression {{Code|file:parent(static-base-uri())}}.
+
|Returns the parent directory of the static base URI.<br/>If the static base URI is undefined or does not point to a local resource, it returns the empty sequence. Otherwise, it returns the same result as {{Code|file:parent(static-base-uri())}}.
 
|}
 
|}
  

Latest revision as of 18:20, 26 March 2024

This XQuery Module contains functions related to file system operations, such as listing, reading, or writing files.

This module is based on the EXPath File Module. The following enhancements have not been added to the specification yet:

Function Description
file:descendants new function
file:is-absolute new function
file:read-text, file:read-text-lines $fallback argument added
file:read-text-lines $offset and $length arguments added
file:resolve-path $base argument added

Conventions[edit]

All functions and errors in this module are assigned to the http://expath.org/ns/file namespace, which is statically bound to the file prefix.

For serialization parameters, the http://www.w3.org/2010/xslt-xquery-serialization namespace is used, which is statically bound to the output prefix.

The error invalid-path is raised if a path is invalid.

File Paths[edit]

  • All file paths are resolved against the current working directory (the directory from which BaseX or, more generally, the Java Virtual Machine, was started). This directory can be retrieved via file:base-dir.
  • A path can be specified as local filesystem path or as file URI.
  • Returned strings that refer to existing directories are suffixed with a directory separator.

Read Operations[edit]

file:list[edit]

Signature
file:list(
  $dir        as xs:string,
  $recursive  as xs:boolean?  := false(),
  $pattern    as xs:string    := ()
) as xs:string*
Summary Lists all files and directories found in the specified $dir. The returned paths are relative to the provided path.
If $recursive is set to true, subdirectories will be traversed.
The optional parameter $pattern defines a file name pattern in the Glob Syntax. If present, only those files and directories are returned that correspond to the pattern. Several patterns can be separated with a comma (,).
Errors not-found: the specified file does not exist.
no-dir: the specified path does not point to a directory.
io-error: the operation fails for some other reason.
Examples Return the contents of large .txt files located in a specific directory and its subdirectories:
let $root := 'path/to/files/'
for $file in file:list($root, true(), '*.txt')
let $path := $root || $file
where file:size($path) > 1000000
return file:read-text($path)

file:children[edit]

Signature
file:children(
  $dir  as xs:string
) as xs:string*
Summary Returns the full paths to all files and directories found in the specified $dir.
The inverse function is file:parent. The returned paths start with the specified directory. The related function file:list returns relative file paths.
Errors not-found: the specified file does not exist.
no-dir: the specified path does not point to a directory.
io-error: the operation fails for some other reason.
Examples Return the contents of large .txt files located in a specific directory:
for $file in file:children('path/to/files/')
where matches($file, '.txt', 'i') and file:size($file) > 1000000
return file:read-text($$file)

file:descendants[edit]

Signature
file:descendants(
  $dir  as xs:string
) as xs:string*
Summary Returns the full paths to all files and directories found in the specified $dir and its subdirectories.
. The returned paths start with the specified directory. The related function file:list creates relative file paths.
Errors not-found: the specified file does not exist.
no-dir: the specified path does not point to a directory.
io-error: the operation fails for some other reason.
Examples Return the contents of all .txt files located in a specific directory and its subdirectories:
for $file in file:descendants('path/to/files/')
where matches($file, '.txt', 'i') and file:size($file) > 1000000
return file:read-text($$file)

file:read-binary[edit]

Signature
file:read-binary(
  $path    as xs:string,
  $offset  as xs:integer  := (),
  $length  as xs:integer  := ()
) as xs:base64Binary
Summary Reads the binary content of the file specified by $path and returns it as lazy xs:base64Binary item.
The optional parameters $offset and $length can be used to read chunks of a file.
Errors not-found: the specified file does not exist.
is-dir: the specified path is a directory.
out-of-range: the offset or length is negative, or the chosen values would exceed the file bounds.
io-error: the operation fails for some other reason.
Examples
  • lazy:cache(file:read-binary("config.data")) enforces the file access (otherwise, it will be delayed until requested first).

file:read-text[edit]

Signature
file:read-text(
  $path      as xs:string,
  $encoding  as xs:string   := (),
  $fallback  as xs:boolean?  := false()
) as xs:string
Summary Reads the textual contents of the file specified by $path and returns it as lazy xs:string item:
  • The UTF-8 default encoding can be overwritten with the optional $encoding argument.
  • By default, invalid XML characters will be rejected. If $fallback is enabled, the characters will be replaced with the Unicode replacement character FFFD (�).
Errors not-found: the specified file does not exist.
is-dir: the specified path is a directory.
unknown-encoding: the specified encoding is not supported, or unknown.
io-error: the operation fails for some other reason.
Examples
  • lazy:cache(file:read-text("ids.txt")) enforces the file access (otherwise, it will be delayed until requested first).

file:read-text-lines[edit]

Signature
file:read-text-lines(
  $path      as xs:string,
  $encoding  as xs:string    := (),
  $fallback  as xs:boolean?  := false(),
  $offset    as xs:integer?  := (),
  $length    as xs:integer?  := ()
) as xs:string*
Summary Reads the textual contents of the file specified by $path and returns it as a sequence of xs:string items:
  • The UTF-8 default encoding can be overwritten with the optional $encoding argument.
  • By default, invalid characters will be rejected. If $fallback is set to true, these characters will be replaced with the Unicode replacement character FFFD (�).

The lines to be read can be restricted with the optional parameters $offset and $length.

Errors not-found: the specified file does not exist.
is-dir: the specified path is a directory.
unknown-encoding: the specified encoding is not supported, or unknown.
io-error: the operation fails for some other reason.

Write Operations[edit]

file:create-dir[edit]

Signature
file:create-dir(
  $dir  as xs:string
) as empty-sequence()
Summary Creates the directory specified by $dir if it does not already exist. Non-existing parent directories will be created as well.
Errors exists: the specified target exists, but is no directory.
io-error: the operation fails for some other reason.

file:create-temp-dir[edit]

Signature
file:create-temp-dir(
  $prefix  as xs:string,
  $suffix  as xs:string,
  $dir     as xs:string  := ()
) as xs:string
Summary Creates a new temporary directory that did not exist before this function was called, and returns its full file path. The directory name begins and ends with the specified $prefix and $suffix. If no directory is specified via $dir, the directory will be placed in the system’s default temporary directory. The operation will create all non-existing parent directories.
Errors no-dir: the specified directory points to a file.
io-error: the directory could not be created.

file:create-temp-file[edit]

Signature
file:create-temp-file(
  $prefix  as xs:string,
  $suffix  as xs:string,
  $dir     as xs:string  := ()
) as xs:string
Summary Creates a new temporary file that did not exist before this function was called, and returns its full file path. The file name begins and ends with the specified $prefix and $suffix. If no directory is specified via $dir, the file will be placed in the system’s default temporary directory. The operation will create all non-existing parent directories.
Errors no-dir: the specified directory points to a file.
io-error: the directory could not be created.

file:delete[edit]

Signature
file:delete(
  $path       as xs:string,
  $recursive  as xs:boolean?  := false()
) as empty-sequence()
Summary Recursively deletes a file or directory specified by $path.
The optional parameter $recursive specifies whether subdirectories will be deleted, too.
Errors not-found: the specified path does not exist.
io-error: the operation fails for some other reason.

file:write[edit]

Signature
file:write(
  $path     as xs:string,
  $input    as item()*,
  $options  as map(*)?    := map { }
) as empty-sequence()
Summary Writes serialized $input to the specified file. If the file already exists, it will be overwritten.
The $options argument contains serialization parameters. As with fn:serialize(), the parameters can be specified
  • either as children of an <output:serialization-parameters/> element:
<output:serialization-parameters>
  <output:method value='xml'/>
  <output:cdata-section-elements value="div"/>
  ...
</output:serialization-parameters>
  • or as map, which contains all key/value pairs:
map { "method": "xml", "cdata-section-elements": "div", ... }
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
io-error: the operation fails for some other reason.
Examples
  • file:write('data.bin', xs:hexBinary('414243')) writes a hex representation to the specified file.
  • file:write('data.bin', xs:hexBinary('414243'), map { 'method': 'basex') writes binary data to the specified file (see Serialization for more details).

file:write-binary[edit]

Signature
file:write-binary(
  $path    as xs:string,
  $value   as xs:anyAtomicType,
  $offset  as xs:integer        := ()
) as empty-sequence()
Summary Writes a binary item (xs:base64Binary, xs:hexBinary) to the specified file. If the file already exists, it will be overwritten.
If $offset is specified, data will be written at this file position. An existing file may be resized by that operation.
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
out-of-range: the offset is negative, or it exceeds the current file size.
io-error: the operation fails for some other reason.

file:write-text[edit]

Signature
file:write-text(
  $path      as xs:string,
  $value     as xs:string,
  $encoding  as xs:string  := ()
) as empty-sequence()
Summary Writes a string to the specified file. If the file already exists, it will be overwritten.
The optional parameter $encoding defines the output encoding (default: UTF-8).
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
unknown-encoding: the specified encoding is not supported, or unknown.
io-error: the operation fails for some other reason.

file:write-text-lines[edit]

Signature
file:write-text-lines(
  $path      as xs:string,
  $values    as xs:string*,
  $encoding  as xs:string   := ()
) as empty-sequence()
Summary Writes a sequence of strings to the specified file, each followed by the system specific newline character. If the file already exists, it will be overwritten.
The optional parameter $encoding defines the output encoding (default: UTF-8).
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
unknown-encoding: the specified encoding is not supported, or unknown.
io-error: the operation fails for some other reason.

file:append[edit]

Signature
file:append(
  $path     as xs:string,
  $input    as item()*,
  $options  as map(*)?    := map { }
) as empty-sequence()
Summary Appends a serialized sequence of $input to the specified file, with the supplied $options as serialization parameters. If the file does not exist, a new file is created.
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
io-error: the operation fails for some other reason.

file:append-binary[edit]

Signature
file:append-binary(
  $path   as xs:string,
  $value  as xs:anyAtomicType
) as empty-sequence()
Summary Appends a binary item (xs:base64Binary, xs:hexBinary) to the specified file. If the file does not exists, a new one is created.
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
io-error: the operation fails for some other reason.

file:append-text[edit]

Signature
file:append-text(
  $path      as xs:string,
  $value     as xs:string,
  $encoding  as xs:string  := ()
) as empty-sequence()
Summary Appends a string to a file specified by $path. If the specified file does not exists, a new file is created.
The optional parameter $encoding defines the output encoding (default: UTF-8).
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
unknown-encoding: the specified encoding is not supported, or unknown.
io-error: the operation fails for some other reason.

file:append-text-lines[edit]

Signature
file:append-text-lines(
  $path      as xs:string,
  $values    as xs:string*,
  $encoding  as xs:string   := ()
) as empty-sequence()
Summary Appends a sequence of strings to the specified file, each followed by the system specific newline character. If the specified file does not exists, a new file is created.
The optional parameter $encoding defines the output encoding (default: UTF-8).
Errors no-dir: the parent of specified path is no directory.
is-dir: the specified path is a directory.
unknown-encoding: the specified encoding is not supported, or unknown.
io-error: the operation fails for some other reason.

file:copy[edit]

Signature
file:copy(
  $source  as xs:string,
  $target  as xs:string
) as empty-sequence()
Summary Copies a file or directory specified by $source to the file or directory specified by $target. If the target file already exists, it will be overwritten. No operation will be performed if the source and target path are equal.
Errors not-found: the specified source does not exist.
exists: the specified source is a directory and the target is a file.
no-dir: the parent of the specified target is no directory.
io-error: the operation fails for some other reason.

file:move[edit]

Signature
file:move(
  $source  as xs:string,
  $target  as xs:string
) as empty-sequence()
Summary Moves or renames the file or directory specified by $source to the path specified by $target. If the target file already exists, it will be overwritten. No operation will be performed if the source and target path are equal.
Errors not-found: the specified source does not exist.
exists: the specified source is a directory and the target is a file.
no-dir: the parent of the specified target is no directory.
io-error: the operation fails for some other reason.
Examples When renaming a file, remember that relative file paths are resolved against the current working directory. Some ways to rename:
file:move('/projects/new/octopus', '/projects/new/septimus')
$path ! file:move(., file:parent(.)||$newName)

File Properties[edit]

file:exists[edit]

Signature
file:exists(
  $path  as xs:string
) as xs:boolean
Summary Returns an xs:boolean indicating whether a file or directory specified by $path exists in the file system.

file:is-dir[edit]

Signature
file:is-dir(
  $path  as xs:string
) as xs:boolean
Summary Returns an xs:boolean indicating whether the argument $path points to an existing directory.

file:is-absolute[edit]

Signature
file:is-absolute(
  $path  as xs:string
) as xs:boolean
Summary Returns an xs:boolean indicating whether the argument $path is absolute.
The behavior of this function depends on the operating system: On Windows, an absolute path starts with the drive letter and a colon, whereas on Linux it starts with a slash.

file:is-file[edit]

Signature
file:is-file(
  $path  as xs:string
) as xs:boolean
Summary Returns an xs:boolean indicating whether the argument $path points to an existing file.

file:last-modified[edit]

Signature
file:last-modified(
  $path  as xs:string
) as xs:dateTime
Summary Retrieves the timestamp of the last modification of the file or directory specified by $path.
Errors not-found: the specified path does not exist.

file:size[edit]

Signature
file:size(
  $path  as xs:string
) as xs:integer
Summary Returns the size, in bytes, of the file specified by $path, or 0 for directories.
Errors not-found: the specified file does not exist.

Path Functions[edit]

file:name[edit]

Signature
file:name(
  $path  as xs:string
) as xs:string
Summary Returns the name of a file or directory specified by $path. An empty string is returned if the path points to the root directory.

file:parent[edit]

Signature
file:parent(
  $path  as xs:string
) as xs:string?
Summary Returns the absolute path to the parent directory of a file or directory specified by $path. An empty sequence is returned if the path points to a root directory.
The inverse function is file:children.
Examples
  • file:parent(static-base-uri()) returns the directory of the current XQuery module.

file:path-to-native[edit]

Signature
file:path-to-native(
  $path  as xs:string
) as xs:string
Summary Transforms the $path argument to its native representation on the operating system.
Errors not-found: the specified file does not exist.
io-error: the specified path cannot be transformed to its native representation.

file:resolve-path[edit]

Signature
file:resolve-path(
  $path  as xs:string,
  $base  as xs:string  := ()
) as xs:string
Summary Transforms the $path argument to an absolute operating system path.
If the path is relative, and if an absolute $base path is specified, it will be resolved against this path.
Errors is-relative: the specified base path is relative.
Examples The following examples apply to Windows:
  • file:resolve-path('file.txt', 'C:/Temp/') returns C:/Temp/file.txt.
  • file:resolve-path('file.txt', 'C:/Temp') returns C:/file.txt.
  • file:resolve-path('file.txt', 'Temp') raises an error.

file:path-to-uri[edit]

Signature
file:path-to-uri(
  $path  as xs:string
) as xs:string
Summary Transforms the path specified by $path into a URI with the file:// scheme.

System Properties[edit]

file:dir-separator[edit]

Signature file:dir-separator() as xs:string
Summary Returns the directory separator used by the operating system, such as / or \.

file:path-separator[edit]

Signature file:path-separator() as xs:string
Summary Returns the path separator used by the operating system, such as ; or :.

file:line-separator[edit]

Signature
file:line-separator() as xs:string
Summary Returns the line separator used by the operating system, such as &#10;, &#13;&#10; or &#13;.

file:temp-dir[edit]

Signature
file:temp-dir() as xs:string
Summary Returns the system’s default temporary-file directory.

file:current-dir[edit]

Signature
file:current-dir() as xs:string
Summary Returns the current working directory, i.e., the directory from which the query processor was started. This function returns the same result as the function call file:resolve-path("").

file:base-dir[edit]

Signature
file:base-dir() as xs:string?
Summary Returns the parent directory of the static base URI.
If the static base URI is undefined or does not point to a local resource, it returns the empty sequence. Otherwise, it returns the same result as file:parent(static-base-uri()).

Errors[edit]

Code Description
exists A file with the same path already exists.
invalid-path A specified path is invalid.
io-error The operation fails for some other reason specific to the operating system.
is-dir The specified path is a directory.
is-relative The specified path is relative (and must be absolute).
no-dir The specified path does not point to a directory.
not-found A specified path does not exist.
out-of-range The specified offset or length is negative, or the chosen values would exceed the file bounds.
unknown-encoding The specified encoding is not supported, or unknown.

Changelog[edit]

Version 9.3
Version 9.0
Version 8.5
Version 8.2
Version 8.0
Version 7.8
Version 7.7
Version 7.3
Version 7.2.1
  • Updated: file:delete: $recursive parameter added to prevent subdirectories from being accidentally deleted.
  • Fixed: file:list now returns relative instead of absolute paths.