0 ×

List Files/Folders

StreamableKNIME Filehandling Nodes version 4.3.1.v202101261632 by KNIME AG, Zurich, Switzerland

This node supports the path flow variable to specify the location to read from. To convert the created path column to a string column which is required by some nodes that have not been migrated yet you can use the Path to String node. For further information about file handling in general see the File Handling Guide.

List files and/or folders contained in the selected folder.

Options

Read from
Select a file system which stores the files/folders you want to list. There are three default file system options to choose from:
  • Local File System: Allows you to select a folder from your local system.
  • Mountpoint: Allows you to read from a mountpoint. When selected, a new drop-down menu appears to choose the mountpoint. Unconnected mountpoints are greyed out but can still be selected (note that browsing is disabled in this case). Go to the KNIME Explorer and connect to the mountpoint to enable browsing. A mountpoint is displayed in red if it was previously selected but is no longer available. You won't be able to save the dialog as long as you don't select a valid i.e. known mountpoint.
  • Relative to: Allows you to choose whether to resolve the path relative to the current mountpoint, current workflow or the current workflow's data area. When selected a new drop-down menu appears to choose which of the three options to use.
To list files/folders from other file systems, click on ... in the bottom left corner of the node icon followed by Add File System Connection port. Afterwards, connect the desired file system connector node to the newly added input port. The file system connection will then be shown in the drop-down menu. It is greyed out if the file system is not connected in which case you have to (re)execute the connector node first. Note: The default file systems listed above can't be selected if a file system is provided via the input port.
Mode
There are three different file/folder listing modes available:
  • Files in folder: Lists only files.
  • Folders: Lists only folders.
  • Files and folders: Lists both files and folders.
Filter options
Allows to specify which files/folders should be included according to their file extension and/or name. It is also possible to include hidden files/folders.
Include subfolders
If this option is checked, the node will include all files/folders from subfolders that satisfy the specified filter options. If left unchecked, only the files/folders in the selected folder will be included and all files/folders from subfolders are ignored.
Folder
Allows you to specify the folder whose contents should be listed. The required syntax of a path depends on the chosen file system, such as "C:\path\to\file" (Local File System on Windows) or "/path/to/file" (Local File System on Linux/MacOS and Mountpoint). For file systems connected via input port, the node description of the respective connector node describes the required path format. You can also choose a previously selected folder from the drop-down list, or select a location from the "Browse..." dialog. Note that browsing is disabled in some cases:
  • Mountpoint: Browsing is disabled if the selected mountpoint isn't connected. Go to the KNIME Explorer and connect to the mountpoint to enable browsing.
  • File systems provided via input port: Browsing is disabled if the connector node hasn't been executed since the workflow has been opened. (Re)execute the connector node to enable browsing.
The location can be exposed as or automatically set via a path flow variable.
Include parent folder
If selected the output contains the (selected) folder for which the files/folders are being listed.
Add folder identifier column
If selected the output contains an additional column indicating if the path points to a folder (true) or a file (false).

Output Ports

Icon
List of files/folders.

Workflows

Installation

To use this node in KNIME, install KNIME Base nodes from the following update site:

KNIME 4.3

A zipped version of the software site can be downloaded here.

You don't know what to do with this link? Read our NodePit Product and Node Installation Guide that explains you in detail how to install nodes to your KNIME Analytics Platform.

Wait a sec! You want to explore and install nodes even faster? We highly recommend our NodePit for KNIME extension for your KNIME Analytics Platform. Browse NodePit from within KNIME, install nodes with just one click and share your workflows with NodePit Space.

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.