Skip to content
Search

DSL References

DSL stands for Domain Specific Language. In Flow, the DSL is a set of small functions that wrap object construction so pipelines read top-to-bottom. See the examples for usage in context.

EXTRACTOR

/**
 * @param Path|string $path
 */
from_floe(Path|string $path, Codec $codec, int $chunk_size, FloeEngine $engine) : FloeExtractor

HELPER

/**
 * Merges several Floe files (same or append-compatible evolving schema) into one, on the local
 * filesystem. Byte-splices frame regions by default (O(bytes), no re-encode); compact re-encodes
 * all rows into fewer sections. For non-local filesystems use FloeMerger directly.
 *
 * @param array<int, Path|string> $sources
 */
merge_floe(array $sources, Path|string $dest, bool $compact, ?Metadata $metadata) : void

LOADER

/**
 * @param Path|string $path
 */
to_floe(Path|string $path, ?Metadata $metadata, Options $options, FloeEngine $engine) : FloeLoader
Contributors

Built in the open.

Join us on GitHub
scroll back to top