Tests if a file or directory exists.
Returns true if $path points to a file or directory,
false otherwise.
On UNIX-based systems the root and the volume roots are considered directories.
Tests if $path points to a directory.
Returns true if $path points to a directory,
false otherwise.
On UNIX-based systems the root and the volume roots are considered directories.
Tests if $path points to a file.
Returns true if $path points to a existing file.
Returns false if $path points to a existing directory.
Otherwise returns false
Returns the last modification time of a file or directory.
Returns the last modification time of a file or directory.
$path does not
exist.
Returns the byte size of a file, or the value 0 for directories.
Returns 0 if $file points to a directory.
Returns the byte size of the file $file, if it exists.
$path does not
exist.
Appends a sequence of items to a file. If the file pointed by $file does
not exist, a new file will be created.
Appends a sequence of items to a file.
If the file pointed by $file does not exist, a new file will be
created.
$params, if not an empty sequence, controls the way the
$items items are serialized. The semantics of $params are
those of the same argument of output:serialization-parameters element whose format
is defined in fn:serialize, the
encoding stage will not be skipped by this function.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
Appends a Base64 item as binary data to a file.
Appends a Base64 item as binary data to a file.
If the file pointed to by $file does not exist, a new file will be
created.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
Appends a string to a file.
Appends a string to the file $file.
If the file pointed to by $file does not exist, a new file will be
created.
The optional parameter $encoding, if omitted or an empty sequence, is
considered to be UTF-8.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
$encoding
is invalid or not supported by the implementation.
Appends a sequence of strings to a file, each followed by the system-dependent newline character.
Appends a sequence of strings to a file, each followed by the system-dependent newline character.
If the file pointed to by $file does not exist, a new file will be
created.
The optional parameter $encoding, if omitted or an empty sequence, is
considered to be UTF-8.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
$encoding
is invalid or not supported by the implementation.
Copies a file or a directory given a source and a target path/URI.
Copies a file or a directory given a source and a target path/URI. The following
cases may occur if $source points to a file:
if $target does not exist, it will be created.
if $target is a file, it will be overwritten.
if $target is a directory, the file will be created in that
directory with the name of the source file. If a file already exists, it
will be overwritten.
The following cases may occur if $source points to a directory:
if $target does not exist, it will be created as directory, and
all files of the source directory are copied to this directory with their
existing local names.
if $target is a directory, the source directory with all its
files will be copied into the target directory. At each level, if a file
already exists in the target with the same name as in the source, it is
overwritten. If a directory already exists in the target with the same name
as in the source, it is not removed, it is recursed in place (if it does not
exist, it is created before recursing).
Other cases will raise one of the errors listed below.
The function returns the empty sequence if the operation is successful. If an error occurs during the operation, no rollback to the original state will be possible
$source path
does not exist.
$source points to a
directory and $target points to an existing file.
$source does not exist.
$source points to a
file and $target points to a directory, in which a subdirectory exists
with the name of the source file.
Creates a directory if it does not already exist.
Creates a directory, or does nothing if the directory already exists. The operation will create all non-existing parent directories.
The function returns the empty sequence if the operation is successful.
Creates a temporary directory.
Creates a temporary directory and all non-existing parent directories and returns the full path to the created directory.
The temporary directory will not be automatically deleted after query execution. It is guaranteed to not already exist when the function is called.
If $dir is omitted or an empty sequence, the directory will be created
inside the system-dependent default temporary-file directory.
Creates a temporary file.
Creates a temporary file and all non-existing parent directories and returns the full path to the created file.
The temporary file will not be automatically deleted after query execution. It is guaranteed to not already exist when the function is called.
If $dir is omitted or an empty sequence, the file will be created inside
the system-dependent default temporary-file directory.
Deletes a file or a directory from the file system.
Deletes a file or a directory from the file system.
If the optional parameter $recursive is true,
sub-directories will be deleted as well.
The function returns the empty sequence if the operation is successful.
$path does not
exist.
$file points to a
non-empty directory.
Lists all files and directories in a given directory.
Lists all files and directories in a given directory. The order of the items in the
resulting sequence is not defined. The "." and ".." items are never returned. The
returned paths are relative to the provided directory $dir.
If the optional parameter $recursive is true, all
directories and files will be returned that are found while recursively traversing
the given directory. If $recursive is omitted or an empty sequence or
false only the contents of the specified directory will be returned.
The optional $pattern parameter defines a name pattern in the glob
syntax. If this is provided and is not an empty sequence, only the paths of the
files and directories whose names are matching the pattern will be returned.
An implementation must support at least the following glob syntax for the pattern:
* for matching any number of unknown characters
and? for matching one unknown character.
A related function is file:children.
$dir does not point
to an existing directory.
Moves a file or a directory.
Moves a file or a directory given a source and a target path/URI. The following cases
may occur if $source points to a file:
if $target does not exist, it will be created.
if $target is a file, it will be overwritten.
if $target is a directory, the file will be created in that
directory with the name of the source file. If a file already exists, it
will be overwritten.
The following cases may occur if $source points to a directory:
if $target does not exist, it will be created as directory, and
all files of the source directory are moved to this directory with their
existing local names.
if $target is a directory, the source directory with all its
files will be moved into the target directory. If the target directory
contains a directory with the same name as the source, the error
Other cases will raise one of the errors listed below.
The function returns the empty sequence if the operation is successful. If an error occurs during the operation, no rollback to the original state will be possible
$source path
does not exist.
$source points to a
directory and $target points to an existing file.
$source does not exist.
$target points to a
directory, in which a subdirectory exists with the name of the source.
Returns the content of a file in its Base64 representation.
Returns the content of a file in its Base64 representation.
The optional parameters $offset and $length can be used to
read chunks of a file.
$file does not
exist.
$file points to a
directory.
$offset or
$length is negative, or if the chosen values would exceed the file
bounds.
Returns the content of a file in its string representation.
Returns the content of a file in its string representation.
The optional parameter $encoding, if omitted or an empty sequence, is
considered to be UTF-8.
$file does not
exist.
$file points to a
directory.
$encoding
is invalid or not supported by the implementation.
Returns the contents of a file as a sequence of strings, separated at newline boundaries.
Returns the contents of a file as a sequence of strings, separated at newline boundaries.
The optional parameter $encoding, if omitted or an empty sequence, is
considered to be UTF-8.
The newline handling is the same as for
$file does not
exist.
$file points to a
directory.
$encoding
is invalid or not supported by the implementation.
Writes a sequence of items to a file.
Writes a sequence of items to a file.
If $file already exists, it will be overwritten; otherwise, it will be
created.
$params, if not an empty sequence, controls the way the
$items items are serialized. The semantics of $params are
those of the same argument of output:serialization-parameters element whose format
is defined in fn:serialize, the encoding stage will not
be skipped by this function.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
Writes a Base64 item as binary to a file.
Writes a Base64 item as binary to a file.
If $file already exists, it will be overwritten; otherwise, it will be
created.
If the optional parameter $offset is specified and not set to an empty
sequence, data will be written starting at this file position. An existing file may
be resized by such an operation.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
$offset is
negative, or if it exceeds the current file size.
Writes a string to a file.
Writes a strings to a file.
If $file already exists, it will be overwritten.
The optional parameter $encoding, if omitted or an empty sequence, is
considered to be UTF-8.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
$encoding
is invalid or not supported by the implementation.
Writes a sequence of strings to a file, each followed by the system-dependent newline character.
Writes a sequence of strings to a file, each followed by the system-dependent newline character.
If $file already exists, it will be overwritten; otherwise, it will be
created.
The optional parameter $encoding, if omitted or an empty sequence, is
considered to be UTF-8.
The function returns the empty sequence if the operation is successful.
$file does not exist.
$file points to a
directory.
$encoding
is invalid or not supported by the implementation.
Returns the name of a file or directory.
Returns the name of a file or directory.
An empty string is returned if the path points to the root directory, or if it contains no directory separators.
This function is
Returns the parent directory of a given path.
Transforms the given path into an absolute path, as specified by
The inverse function is
An empty sequence is returned if the path points to a root directory.
Returns the paths of all files and directories that are located in the given directory.
Returns the paths of all files and directories that are located in the given directory. The order of the items in the resulting sequence is not defined. The "." and ".." items are never returned.
The inverse function is
$path does not
point to an existing directory.
Transforms a URI, an absolute path, or relative path to a canonical, system-dependent path representation.
Transforms a URI, an absolute path, or relative path to a canonical, system-dependent path representation. A canonical path is both absolute and unique and thus contains no redirections such as references to parent directories or symbolic links.
If the resulting path points to a directory, it will be suffixed with the system-specific directory separator.
$path does not
exist.
Transforms a file system path into a URI.
Transforms a file system path into a URI with the file:// scheme. If the
path is relative, it is first resolved against the current working directory.
This function is
Transforms a relative path into an absolute operating system path.
Transforms a relative path into an absolute operating system path by resolving it against the current working directory.
If the resulting path points to a directory, it will be suffixed with the system-specific directory separator.
Returns the value of the operating system-specific directory separator.
Returns the value of the operating system-specific directory separator, which usually
is / on UNIX-based systems and \ on Windows systems.
Returns the value of the operating system-specific line separator.
Returns the value of the operating system-specific line separator, which usually is
on UNIX-based systems, on
Windows systems and on Mac systems.
Returns the value of the operating system-specific path separator.
Returns the value of the operating system-specific path separator, which usually is
: on UNIX-based systems and ; on Windows systems.
Returns the path to the default temporary-file directory of an operating system.
Returns the path to the default temporary-file directory of an operating system.
Returns the parent directory of the static base URI.
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()).
Returns the current working directory.
Returns the current working directory.