# files: OS File System Files ## Documentation: Scan file system for files matching the specifications. - Catalog: `FileSystem` - Label: File System Files - Retrieve: True ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `files`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `all_directories` | `char` | ☑ | | Whether to recurse into folders. Defaults to false. | | `ignore_case` | `char` | ☑ | | Ignore case. | | `ignore_unauthorized_exception` | `char` | ☑ | | Whether to ignore unauthorized exceptions. | | `path` | `varchar2` | ☑ | | Root of folder structure to search. | | `search_pattern` | `varchar2` | ☑ | | File name match pattern. Use '*' to signal text of arbitrary length and '?' as any single character. | ## Columns of Table Function The columns of the table function `files` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `file_path` | `varchar2` | Filename and Path | ☑ | |