tweakstreet-logo
  • Enter search terms

Archive Files

Creates a compressed folder archive

Processing

For each input row, the step creates an archive file from a given directory.

Settings

Name Type Description
Folder to archive
 string

The folder to archive

Relative paths are interpreted as relative to the flow file.

Evaluated for each input row
Include Patterns
 list or string

A string or list of strings indicating a whitelist of folder contents to include in the archive.

If no include patterns are given, all folder contents are included.

If any include patterns are given, files to be included in the archive must match at least one pattern. The full path of each file is matched.

The pattern is a regular expression. PathMatcher syntax can also be used.

Examples:

  • .*\.xml$ matches file names ending in .xml
  • glob:**/*.csv matches file names ending in csv (using path matcher glob syntax)

Evaluated for each input row
Exclude Patterns
 list or string

A string or list of strings indicating a blacklist of folder contents to exclude from the archive.

Exclude patterns are processed after include patterns.

If no exclude patterns are given, no exclusions are made.

If any exclude patterns are given, files to be excluded from the archive must match at least one pattern. The full path of each file is matched.

The pattern is a regular expression. PathMatcher syntax can also be used.

Examples:

  • .*\.xml$ matches file names ending in .xml
  • glob:**/*.csv matches file names ending in csv (using path matcher glob syntax)

Evaluated for each input row
Filter
 function

A custom filter function of the form:

(string path, dict attributes) -> boolean

The filter function is applied to all remaining entries after inclusion and exclusion patterns.

If no filter function is given, all entries are included.

If a filter function is given, it is called for each candidate entry.

  • path contains the full path of the entry
  • attributes contains an attribute dict for the entry

Evaluated for each input row

The following attributes are always provided:

Key Type Value
name string file name
path string absolute path
parent string absolute path to parent directory, can be nil for fs root
size long size of file in bytes, can be nil if path is not a file
is_file boolean true if path points to a regular file, false otherwise
is_dir boolean true if path points to a directory, false otherwise
is_symlink boolean true if path is a symbolic link
is_other boolean true if path is not a file or directory (could be a pipe, socket, etc.)
mtime datetime time of last modification, can be nil if file system does not track mtime
ctime datetime time of creation, can be nil if file system does not track ctime

Additional attributes might be present if provided by the underlying filesystem.
Archive Format
 string

Determines what type of archive to create:

  • zip: creates a zip archive
  • 7z: creates a 7z archive

Evaluated for each input row
Archive File
 string

The archive file to create.

Relative paths are interpreted as relative to the flow file.

Evaluated for each input row
If Exists
 string

Determines the course of action when an archive file already exists:

  • error: throw an error
  • replace: replace exsting

Evaluated for each input row
Test Mode
 boolean

If checked, the step logs which files would be included in an archive, but does not actually create an archive file.

If unchecked, the step creates the archive file as configured.

Evaluated for each input row

Results

This step does not provide any results.

On this page