Difference between revisions of "File Module"
(30 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
This [[Module Library|XQuery Module]] contains functions related to file system operations, such as listing, reading, or writing files. | This [[Module Library|XQuery Module]] contains functions related to file system operations, such as listing, reading, or writing files. | ||
− | This module is based on the [http://expath.org/spec/file EXPath File Module]. | + | This module is based on the [http://expath.org/spec/file EXPath File Module]. The following enhancements have not been added to the specification yet: |
+ | |||
+ | {| class="wikitable" | ||
+ | |- valign="top" | ||
+ | ! Function | ||
+ | ! Description | ||
+ | |- valign="top" | ||
+ | | [[#file:descendants|file:descendants]] | ||
+ | | new function | ||
+ | |- valign="top" | ||
+ | | [[#file:is-absolute|file:is-absolute]] | ||
+ | | new function | ||
+ | |- valign="top" | ||
+ | | [[#file:read-text|file:read-text]], [[#file:read-text-lines|file:read-text-lines]] | ||
+ | | <code>$fallback</code> argument added | ||
+ | |- valign="top" | ||
+ | | [[#file:read-text-lines|file:read-text-lines]] | ||
+ | | <code>$offset</code> and <code>$length</code> arguments added | ||
+ | |- valign="top" | ||
+ | | [[#file:resolve-path|file:resolve-path]] | ||
+ | | <code>$base</code> argument added | ||
+ | |} | ||
=Conventions= | =Conventions= | ||
Line 9: | Line 30: | ||
For serialization parameters, the <code><nowiki>http://www.w3.org/2010/xslt-xquery-serialization</nowiki></code> namespace is used, which is statically bound to the {{Code|output}} prefix.<br/> | For serialization parameters, the <code><nowiki>http://www.w3.org/2010/xslt-xquery-serialization</nowiki></code> namespace is used, which is statically bound to the {{Code|output}} prefix.<br/> | ||
− | + | The error <code>[[#Errors|invalid-path]]</code> is raised if a path is invalid. | |
+ | |||
+ | ==File Paths== | ||
+ | |||
+ | * 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|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= | =Read Operations= | ||
==file:list== | ==file:list== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 35: | Line 65: | ||
| '''Summary''' | | '''Summary''' | ||
|Returns the full paths to all files and directories found in the specified {{Code|$dir}}.<br/>The inverse function is [[#file:parent|file:parent]]. The related function [[#file:list|file:list]] returns relative file paths. | |Returns the full paths to all files and directories found in the specified {{Code|$dir}}.<br/>The inverse function is [[#file:parent|file:parent]]. The related function [[#file:list|file:list]] returns relative file paths. | ||
+ | |- | ||
+ | | '''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 /> | ||
+ | |} | ||
+ | |||
+ | ==file:descendants== | ||
+ | |||
+ | {| width='100%' | ||
+ | |- | ||
+ | | width='120' | '''Signatures''' | ||
+ | |{{Func|file:descendants|$dir as xs:string|xs:string*}} | ||
+ | |- | ||
+ | | '''Summary''' | ||
+ | |Returns the full paths to all files and directories found in the specified {{Code|$dir}} and its sub-directories.<br/>. The related function [[#file:list|file:list]] returns relative file paths. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 48: | Line 92: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Reads the binary content of the file specified by {{Code|$path}} and returns it as [[ | + | |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. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 55: | Line 99: | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * <code><nowiki> | + | * <code><nowiki>lazy:cache(file:read-binary("config.data"))</nowiki></code> enforces the file access (otherwise, it will be delayed until requested first). |
|} | |} | ||
==file:read-text== | ==file:read-text== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{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|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 /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Reads the textual contents of the file specified by {{Code|$path}} and returns it as [[ | + | |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. | ||
+ | * 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> (�). | ||
|- | |- | ||
| '''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. |
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * <code><nowiki> | + | * <code><nowiki>lazy:cache(file:read-text("ids.txt"))</nowiki></code> enforces the file access (otherwise, it will be delayed until requested first). |
|} | |} | ||
==file:read-text-lines== | ==file:read-text-lines== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{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|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 /> |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Reads the textual contents of the file specified by {{Code|$path}} and returns it as a sequence of {{Code|xs:string}} items.< | + | |Reads the textual contents of the file specified by {{Code|$path}} and returns it as a sequence of {{Code|xs:string}} items: |
+ | * 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> (�). | ||
+ | The lines to be read can be restricted with the optional parameters {{Code|$offset}} and {{Code|$length}}. | ||
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 98: | Line 149: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Creates the directory specified by {{Code|$dir}} | + | |Creates the directory specified by {{Code|$dir}} if it does not already exist. Non-existing parent directories will be created as well.<br /> |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
− | |{{Error|exists|#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 /> |
|} | |} | ||
Line 133: | Line 184: | ||
==file:delete== | ==file:delete== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 146: | Line 198: | ||
==file:write== | ==file:write== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 152: | Line 205: | ||
|- | |- | ||
| '''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 | + | |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 /> |
− | * as children of an {{Code|<output:serialization-parameters/>}} element | + | * either as children of an {{Code|<output:serialization-parameters/>}} element: |
− | < | + | <syntaxhighlight lang="xml"> |
<output:serialization-parameters> | <output:serialization-parameters> | ||
<output:method value='xml'/> | <output:method value='xml'/> | ||
Line 160: | Line 213: | ||
... | ... | ||
</output:serialization-parameters> | </output:serialization-parameters> | ||
− | </ | + | </syntaxhighlight> |
− | * as map, which contains all key/value pairs: | + | * or as map, which contains all key/value pairs: |
− | < | + | <syntaxhighlight lang="xquery"> |
map { "method": "xml", "cdata-section-elements": "div", ... } | map { "method": "xml", "cdata-section-elements": "div", ... } | ||
− | </ | + | </syntaxhighlight> |
|- | |- | ||
| '''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 /> | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | | | ||
+ | * <code><nowiki>file:write('data.bin', xs:hexBinary('414243'))</nowiki></code> writes a hex representation to the specified file. | ||
+ | * <code><nowiki>file:write('data.bin', xs:hexBinary('414243'), map { 'method': 'basex')</nowiki></code> writes binary data to the specified file (see [[XQuery_Extensions#Serialization|Serialization]] for more details). | ||
|} | |} | ||
Line 213: | Line 271: | ||
==file:append== | ==file:append== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 267: | Line 326: | ||
|} | |} | ||
+ | ==file:copy== | ||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 282: | Line 341: | ||
==file:move== | ==file:move== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 297: | Line 357: | ||
==file:exists== | ==file:exists== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 329: | Line 390: | ||
==file:is-file== | ==file:is-file== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 339: | Line 401: | ||
==file:last-modified== | ==file:last-modified== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 352: | Line 415: | ||
==file:size== | ==file:size== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 367: | Line 431: | ||
==file:name== | ==file:name== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 379: | Line 444: | ||
{| width='100%' | {| width='100%' | ||
+ | |||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
Line 392: | Line 458: | ||
==file:path-to-native== | ==file:path-to-native== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 405: | Line 472: | ||
==file:resolve-path== | ==file:resolve-path== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 418: | Line 483: | ||
| '''Errors''' | | '''Errors''' | ||
|{{Error|is-relative|#Errors}} the specified base path is relative.<br /> | |{{Error|is-relative|#Errors}} the specified base path is relative.<br /> | ||
+ | |- | ||
+ | | '''Examples''' | ||
+ | |The following examples apply to Windows: | ||
+ | * {{Code|file:resolve-path('file.txt', 'C:/Temp/')}} returns {{Code|C:/Temp/file.txt}}. | ||
+ | * {{Code|file:resolve-path('file.txt', 'C:/Temp')}} returns {{Code|C:/file.txt}}. | ||
+ | * {{Code|file:resolve-path('file.txt', 'Temp')}} raises an error. | ||
|} | |} | ||
==file:path-to-uri== | ==file:path-to-uri== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 433: | Line 505: | ||
==file:dir-separator== | ==file:dir-separator== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 443: | Line 516: | ||
==file:path-separator== | ==file:path-separator== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 453: | Line 527: | ||
==file:line-separator== | ==file:line-separator== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 481: | Line 556: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns the current working directory. | + | |Returns the current working directory. This function returns the same result as the function call <code>file:resolve-path("")</code>. |
|} | |} | ||
Line 501: | Line 576: | ||
|Description | |Description | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|exists}} |
− | |A | + | |A file with the same path already exists. |
|- | |- | ||
|{{Code|invalid-path}} | |{{Code|invalid-path}} | ||
|A specified path is invalid. | |A specified path is invalid. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|io-error}} |
− | + | |The operation fails for some other reason specific to the operating system. | |
− | |||
− | |||
− | |The | ||
|- | |- | ||
|{{Code|is-dir}} | |{{Code|is-dir}} | ||
Line 519: | Line 591: | ||
|The specified path is relative (and must be absolute). | |The specified path is relative (and must be absolute). | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|no-dir}} |
− | |The specified | + | |The specified path does not point to a directory. |
+ | |- | ||
+ | |{{Code|not-found}} | ||
+ | |A specified path does not exist. | ||
|- | |- | ||
|{{Code|out-of-range}} | |{{Code|out-of-range}} | ||
|The specified offset or length is negative, or the chosen values would exceed the file bounds. | |The specified offset or length is negative, or the chosen values would exceed the file bounds. | ||
|- | |- | ||
− | |{{Code| | + | |{{Code|unknown-encoding}} |
− | |The | + | |The specified encoding is not supported, or unknown. |
|} | |} | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.3 | ||
+ | * Added: [[#file:descendants|file:descendants]] | ||
+ | |||
+ | ;Version 9.0 | ||
+ | * Updated: [[#file:read-text-lines|file:read-text-lines]]: <code>$offset</code> and <code>$length</code> arguments added. | ||
+ | |||
+ | ;Version 8.5 | ||
+ | * Updated: [[#file:read-text|file:read-text]], [[#file:read-text-lines|file:read-text-lines]]: <code>$fallback</code> argument added. | ||
;Version 8.2 | ;Version 8.2 | ||
Line 555: | Line 639: | ||
* Updated: [[#file:delete|file:delete]]: {{Code|$recursive}} parameter added to prevent sub-directories from being accidentally deleted. | * Updated: [[#file:delete|file:delete]]: {{Code|$recursive}} parameter added to prevent sub-directories from being accidentally deleted. | ||
* Fixed: [[#file:list|file:list]] now returns relative instead of absolute paths. | * Fixed: [[#file:list|file:list]] now returns relative instead of absolute paths. | ||
− | |||
− |
Revision as of 09:23, 29 July 2020
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
|
Contents
Conventions
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
- 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
file:list
Signatures | file:list($dir as xs:string) as xs:string* file:list($dir as xs:string, $recursive as xs:boolean) as xs:string* file:list($dir as xs:string, $recursive as xs:boolean, $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.The optional parameter $recursive specifies whether sub-directories will be traversed, too.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. |
file:children
Signatures | 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 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. |
file:descendants
Signatures | 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 sub-directories.. 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. |
file:read-binary
Signatures | file:read-binary($path as xs:string) as xs:base64Binary file:read-binary($path as xs:string, $offset as xs:integer) as xs:base64Binary 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 |
|
file:read-text
Signatures | file:read-text($path as xs:string) as xs:string file:read-text($path as xs:string, $encoding as xs:string) as xs:string file:read-text($path as xs:string, $encoding as xs:string, $fallback as xs:boolean) as xs:string |
Summary | Reads the textual contents of the file specified by $path and returns it as lazy xs:string item:
|
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 |
|
file:read-text-lines
Signatures | file:read-text-lines($path as xs:string) as xs:string* file:read-text-lines($path as xs:string, $encoding as xs:string) as xs:string* file:read-text-lines($path as xs:string, $encoding as xs:string, $fallback as xs:boolean) as xs:string* file:read-text-lines($path as xs:string, $encoding as xs:string, $fallback as xs:boolean, $offset as xs:integer) as xs:string* file:read-text-lines($path as xs:string, $encoding as xs:string, $fallback as xs:boolean, $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 lines to be read can be restricted with the optional parameters |
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
file:create-dir
Signatures | 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
Signatures | file:create-temp-dir($prefix as xs:string, $suffix as xs:string) as xs:string 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
Signatures | file:create-temp-file($prefix as xs:string, $suffix as xs:string) as xs:string 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
Signatures | file:delete($path as xs:string) as empty-sequence() file:delete($path as xs:string, $recursive as xs:boolean) as empty-sequence() |
Summary | Recursively deletes a file or directory specified by $path .The optional parameter $recursive specifies whether sub-directories will be deleted, too. |
Errors | not-found : the specified path does not exist.io-error : the operation fails for some other reason. |
file:write
Signatures | file:write($path as xs:string, $items as item()*) as empty-sequence() file:write($path as xs:string, $items as item()*, $params as item()) as empty-sequence() |
Summary | Writes a serialized sequence of items to the specified file. If the file already exists, it will be overwritten. The $params argument contains serialization parameters. As with fn:serialize(), the parameters can be specified
<syntaxhighlight lang="xml"> <output:serialization-parameters> <output:method value='xml'/> <output:cdata-section-elements value="div"/> ... </output:serialization-parameters> </syntaxhighlight>
<syntaxhighlight lang="xquery"> map { "method": "xml", "cdata-section-elements": "div", ... } </syntaxhighlight> |
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-binary
Signatures | file:write-binary($path as xs:string, $value as xs:anyAtomicType) as empty-sequence() 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
Signatures | file:write-text($path as xs:string, $value as xs:string) as empty-sequence() 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
Signatures | file:write-text-lines($path as xs:string, $values as xs:string*) as empty-sequence() 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
Signatures | file:append($path as xs:string, $items as item()*) as empty-sequence() file:append($path as xs:string, $items as item()*, $params as item()) as empty-sequence() |
Summary | Appends a serialized sequence of items to the specified file. If the file does not exists, 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
Signatures | 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
Signatures | file:append-text($path as xs:string, $value as xs:string) as empty-sequence() 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
Signatures | file:append-text-lines($path as xs:string, $values as xs:string*) as empty-sequence() 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
Signatures | 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
Signatures | 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. |
File Properties
file:exists
Signatures | 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
Signatures | 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
Signatures | 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
Signatures | 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
Signatures | 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
Signatures | file:size($file 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
file:name
Signatures | 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
Signatures | 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:path-to-native
Signatures | 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
Signatures | file:resolve-path($path as xs:string) as xs:string 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:path-to-uri
Signatures | 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
file:dir-separator
Signatures | file:dir-separator() as xs:string |
Summary | Returns the directory separator used by the operating system, such as / or \ . |
file:path-separator
Signatures | file:path-separator() as xs:string |
Summary | Returns the path separator used by the operating system, such as ; or : . |
file:line-separator
Signatures | file:line-separator() as xs:string
|
Summary | Returns the line separator used by the operating system, such as , or . |
file:temp-dir
Signatures | file:temp-dir() as xs:string
|
Summary | Returns the system’s default temporary-file directory. |
file:current-dir
Signatures | file:current-dir() as xs:string
|
Summary | Returns the current working directory. This function returns the same result as the function call file:resolve-path("") .
|
file:base-dir
Signatures | file:base-dir() as xs:string?
|
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 file:parent(static-base-uri()) .
|
Errors
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
- Version 9.3
- Added: file:descendants
- Version 9.0
- Updated: file:read-text-lines:
$offset
and$length
arguments added.
- Version 8.5
- Updated: file:read-text, file:read-text-lines:
$fallback
argument added.
- Version 8.2
- Added: file:is-absolute
- Updated: file:resolve-path: base argument added
- Version 8.0
- Added: file:current-dir, file:base-dir, file:children
- Version 7.8
- Added: file:parent, file:name
- Updated: error codes; file:read-binary, file:write-binary:
$offset
and$length
arguments added. - Deleted: file:base-name, file:dir-name
- Version 7.7
- Added: file:create-temp-dir, file:create-temp-file, file:temp-dir
- Updated: all returned strings that refer to existing directories will be suffixed with a directory separator.
- Version 7.3
- Added: file:append-text, file:write-text, file:append-text-lines, file:write-text-lines, file:line-separator
- Aligned with latest specification: $file:directory-separator → file:dir-separator, $file:path-separator → file:path-separator, file:is-directory → file:is-dir, file:create-directory → file:create-dir
- Updated: file:write-binary, file:append-binary: output limited to a single value
- Version 7.2.1
- Updated: file:delete:
$recursive
parameter added to prevent sub-directories from being accidentally deleted. - Fixed: file:list now returns relative instead of absolute paths.