Archive Parser Stage
The Archive parser stage can parse the majority of common archive and compressed file formats. They are parsed into their constituent documents, which can then be parsed further or sent straight to the index pipeline. The following archive formats are supported:
-
tar
-
zip
-
jar
-
7z
-
ar
-
arj
-
Unix dump
-
cpio
|
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
Decompress and extract common archive and compression formats, e.g. zip, tar, 7z, GZip, BZip2, etc
id - string
Default: 789e465a-77ed-4fe5-b0ca-566a0013d1e8
label - string
A label for this Parser Stage
<= 255 characters
enabled - boolean
Default: true
mediaTypes - array[string]
Documents with a media type on this list will be matched by this parser stage. See inheritMediaTypes / use default media types for more.
inheritMediaTypes - boolean
Each parser stage has a built-in list of media types it handles by default. If this setting is true, that list will be used along with any optional additional types provided in the mediaTypes list. If this setting is false, this stage will only be selected for media types in the mediaTypes list, and the mediaTypes list becomes a mandatory property which must have at least one valid media type.
Default: true
pathPatterns - array[object]
Specify a file name or pattern that must be matched for this parser stage to run. Forward slashes ("/") are used to join names of files inside archives with the archive name.
object attributes:{syntax : {
display name: Pattern type
type: string
}pattern : {
display name: File name or pattern
type: string
}}
errorHandling - string
Default: mark
Allowed values: ignorelogfailmark
outputFieldPrefix - string
Fields extracted by this parser will be prefixed with this string. The remainder of the field name will be as detected in the stream
<= 20 characters
Match pattern: ^$|^[A-Za-z_][A-Za-z0-9_\-\.]+$
alwaysDetect - boolean
Forces content-type detection. Most compression and archive formats use a magic byte to indicate their type. This can be more reliable than user input.
Default: true
type - stringrequired
Default: archive
Allowed values: archive