Binary File Output transform Icon Binary File Output

Description

The Binary File Output transform writes raw binary content from a stream field to a file.

Use this transform when you need a byte-for-byte write of BLOB/binary data, for example:

  • Exporting a database BLOB column to individual files

  • Saving content loaded with Load file content in memory

  • Writing binary payloads received from HTTP/REST transforms

The target filename is read from an input field, so every row can be written to a different file.

Prefer this transform over Text File Output for binary data. Text File Output applies text encoding and formatting and can corrupt raw bytes.

Supported Engines

Hop Engine

Supported

Single Threaded

Supported

Native Spark

Maybe Supported

Beam Spark

Maybe Supported

Beam Flink

Maybe Supported

Beam Dataflow

Maybe Supported

Options

Option Description

Transform name

Name of the transform. This name has to be unique in a single pipeline.

Binary field

The input field that contains the binary content to write. A Binary data type is preferred.

Filename field

The input field that contains the target filename (local path or VFS URI) for the current row.

Create parent folder

Create the parent folder of the target file when it does not exist.

Overwrite existing file

Overwrite the target file when it already exists. When disabled, an existing file causes an error for that row.

Add filename to result

Add written filenames to the list of result filenames that can be used by the next workflow action.

Notes

  • Null binary content fails the row (or is sent to the error hop when error handling is configured).

  • An empty binary value (0 bytes) writes an empty file.

  • No character encoding is applied: bytes are written exactly as stored in the field.

  • Supports transform error handling so failed rows can be routed without stopping the pipeline.