Skip to content
PlaidCloud

Document Write Blob

Description

Section titled “Description”

The Document: Write Blob step is the counterpart of Document: Read Blob. It writes the base64 bytes in a column of each input row to a file in a Document account, one file per row. The output table holds the input rows unchanged.

The step form has three groups of options: Tables, Write, and Archive. Migrated KNIME and Alteryx workflows use this step for their binary-object and file writers.

Configuration

Section titled “Configuration”
  • Source Table (source) and Output Table (target_frame) — the table to read, and the table the input rows are written to unchanged. Source Columns (source_columns) lists the columns passed through.
  • Write — the write itself, One file per row, or The rows as one archive. The settings below are saved in alteryx_config.
    • Blob Column (blob_field) — the column holding the base64 bytes.
    • File Column (field) — the column naming each row’s file.
    • The File Column Holds (method) — A file name in the folder below (FileName, the default): the file column is a file name placed in the Folder (path). The whole destination path (Path): the file column is the whole destination path.
    • Folder (path) — the destination {account, path}.
    • A File That Exists (if_exists) — when a file is already there: Overwrite it (overwrite, the default), Fail the step (fail), or Leave it as it is (skip).
    • Compress (compress) — Gzip each file (gz) compresses the bytes of each file with gzip before it is written.
    • A blob that starts with < is XML or SVG text, not base64 (xml_text) — a value that starts with < is written as its UTF-8 bytes.

The rows as one archive writes the source rows as one archive instead of one file per row, from their Path and Blob columns (and Selected and EntryName where they name the entries). The output table then holds ArchivePath and Blob. The Archive group sets it, and the settings are saved in alteryx_config.archive:

  • Archive Document Path (destination) — where the archive is written.
  • Format (format) — zip (the default), jar, tar, tar.gz, tar.bz2 or cpio.
  • Name each entry by its file name alone (flatten), Entry Names (truncate) and Folder Prefix to Remove (prefix) — how entry names are built from the paths.
  • Keep the selected folder’s own name in the entry (root), Document the Entry Is Named For (file) and Name an entry by its EntryName where it has one (named) — further control over entry names.
  • Table of Empty Folders (folders) — a table with Path and Selected columns, naming empty folders to add as entries.
  • Merge Into an Existing Archive (append) — No, Abort on a clashing entry (abort) or Replace a clashing entry (overwrite).
Section titled “Related”