Expand description
Local file sink for faucet-stream: JSON Lines, JSON arrays, CSV, XML,
Excel, Avro, Parquet and raw text to one file or a directory of rolled
files — the write-side counterpart of faucet-source-file.
The format comes from the path’s extension unless one is set; .gz /
.zst select compression. Every file is written beside its final name and
renamed into place on flush, so a crashed run never leaves a
complete-looking partial file, and write_mode: overwrite replaces the
whole output set only when the run succeeds.
Experimental (PRINCIPLES.md §3): this block’s shape may change in a minor release; any change is called out in the changelog.
Re-exports§
pub use config::FileSinkConfig;
Modules§
- config
- Local file sink configuration.
Structs§
- File
Sink - Writes records to local files. See the crate docs.
- Json
Lines Options - JSON Lines write options.
- Parquet
Field - One column of an explicit Parquet schema.
- Parquet
Options - Parquet write options.
Enums§
- Faucet
Error - All possible errors returned by faucet-stream.
- File
Sink Format - Which format a file is in: resolved from its extension (
auto) or fixed. - File
Write Mode - Pipeline-level write mode (
write_mode). - IfExists
- What happens when a file this run writes already exists (
if_exists). - Parquet
Codec - Parquet column-chunk compression.
- Parquet
Type - A column type of an explicit Parquet schema.
Constants§
- DESCRIPTOR
- The connector’s static descriptor (RFC 0013): its capabilities, answered from config alone.
- PART_
TOKEN - The placeholder a path template uses for the rollover part number.
Traits§
- Sink
- A sink writes records to an external system.