Compression ArchiveDecompress
CertifiedExtract files from an archive
Compression ArchiveDecompress
Extract files from an archive
Reads an archive from internal storage, optionally decompresses the stream (for example GZIP over TAR), and writes each entry back to storage with metrics for total size and file count. Entry names with spaces are stored using underscores.
type: io.kestra.plugin.compress.ArchiveDecompressExamples
id: archive_decompress
namespace: company.team
inputs:
- id: file
description: Compressed file
type: FILE
tasks:
- id: archive_decompress
type: io.kestra.plugin.compress.ArchiveDecompress
from: "{{ inputs.file }}"
algorithm: ZIP
compression: GZIP
Properties
algorithm *string
ARARJCPIODUMPJARTARZIPArchive container format to create
Required archive format. Compression supports AR, CPIO, JAR, TAR, and ZIP; ARJ and DUMP are extract-only and will fail on compression.
from *string
Internal storage URI of the archive
Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150compression string
BROTLIBZIP2DEFLATEDEFLATE64GZIPLZ4BLOCKLZ4FRAMELZMASNAPPYSNAPPYFRAMEXZZZSTDOptional compressor applied to the archive stream
Use a single-file compressor such as GZIP alongside TAR. Leave null to store the archive uncompressed. Brotli, Deflate64, and Snappy variants are decode-only and will fail during compression.
Outputs
files object
URIs of decompressed files on Kestra's internal storage
Metrics
count counter
Number of files decompressed
size counter
Total size of decompressed files in bytes
