File Store

File Store (file-store)

Write to a local file system object store bucket.

Contents

• Fields
• Object Properties

Fields

Field	Type	Required	Description
retry	Retry		Retry on failure.
batch	Batch		Write events as batches.
path	path (string)	✅	Select filesystem path as root of store.
object-name	file_store_output:object-name	✅	File Name (may contain slashes).
mode	Mode		Specify whether we’re putting or deleting.
input-field	event-field (string)		Use the specified field as the content for the file line.
preprocessors	Preprocessors		Preprocessors (process data before making it available for upload) these processors will be run in the order they are specified.
track-schema	boolean (bool)		Check the schema of the written data and update __SCHEMA_NUMBER (written data must be JSON).

Object properties

Object Properties

Field	Type	Required	Description
disable-object-name-guid	boolean (bool)		Disable the GUID prefix if you want object name to be treated literally (off for deletes).
guid-prefix	string		GUID Prefix, will be prepended to the GUID, the default value is ”/”.
guid-suffix	string		GUID Suffix, will be appended to the GUID if specified.

Retry Fields

Field	Type	Required	Description
count	integer		The number of retry attempts. If unspecified, retries will continue indefinitely.
pause	string		How long to pause before re-trying.

Batch Fields

Field	Type	Required	Description
fixed-size	integer		maximum number of events in an output batch.
mode	symbol	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
timeout	string	✅	interval after which the batch is sent, to keep throughput going (default 100ms).
header	string		put a header line before the batch.
footer	string		put a header line after the last line of the batch.
use-document-marker	bool		Enrich the job metadata with a document marker (for document handling in batch mode).
wrap-as-json	bool		Format the output batch as a JSON array.

Mode Options

Value	Name	Description
put	put	Put Objects
delete	delete	Delete Objects

Preprocessors Options

Value	Name	Description
gzip	gzip	Gzip the output data
parquet	parquet	Extract the received data as JSON rows from a parquet file
base64	base64	Decode base64 as binary