# YAML Input

## ![](/files/qq7Gmkut9pgfrtEdiPkw) YAML Input

### Description <a href="#description" id="description"></a>

The YAML Input transform reads data from YAML structures, files or incoming fields.

| Hop Engine | <sup>✓</sup> |
| ---------- | ------------ |
| Spark      | ?            |
| Flink      | ?            |
| Dataflow   | ?            |

### Options

#### File Tab

| Option                        | Description                                                        |
| ----------------------------- | ------------------------------------------------------------------ |
| Transform name                | Name of the transform.                                             |
| Source is defined in a field? | Whether or not the source is in a field from a previous transform. |
| Source is a filename          | Whether or not the source is a filename, else a directory.         |
| get source from a field       | The field containing the filename or directory.                    |
| File or directory             | The file or directory path.                                        |
| Add                           | Adds the file or directory to the Selected files list.             |
| Browse                        | Browses the local filesystem for a file or directory.              |
| Regular Expression            |                                                                    |
| Selected files                | The selected files or directories.                                 |
| Delete                        | Deletes selected lines from the list.                              |
| Edit                          | Moved the selected line for editing.                               |
| Show filename(s)              | Previews the filename.                                             |

#### Content Tab

| Option                            | Description                                                  |
| --------------------------------- | ------------------------------------------------------------ |
| Ignore empty file                 | Whether or not to ignore empty files.                        |
| Do not raise an error if no files | Whether or not the raise an error if no files are available. |
| Limit                             | Sets a limit to be read.                                     |
| Include filename in output?       | Adds the filename to the output rows.                        |
| Filename fieldname                | The field containing the filename.                           |
| Rownum in output?                 | Adds the row number to the output rows.                      |
| Rownum fieldname                  | The field containing the row number.                         |
| Add files to result filesname     |                                                              |

#### Fields Tab

| Option     | Description                                                       |
| ---------- | ----------------------------------------------------------------- |
| Name       | The name of the output field.                                     |
| Key        | The key to the element.                                           |
| Type       | The data type to convert to.                                      |
| Format     | The format or conversion mask to use in the data type conversion. |
| Length     | The length of the output data type.                               |
| Precision  | The precision of the output data type.                            |
| Currency   | The currency symbol to use during data type conversion.           |
| Decimal    | The numeric decimal symbol to use during data type conversion.    |
| Group      | The numeric grouping symbol to use during data type conversion.   |
| Trim type  | The type of trimming to use during data type conversion.          |
| Get fields | Approximates fields from the input.                               |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/yamlinput.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
