mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-23 06:30:05 +00:00
5 lines
7.5 KiB
HTML
5 lines
7.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `file_format` mod in crate `common_datasource`."><title>common_datasource::file_format - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_datasource" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module file_format</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_datasource/index.html">common_<wbr>datasource</a><span class="version">1.0.0-beta.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module file_<wbr>format</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate common_<wbr>datasource</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">common_datasource</a></div><h1>Module <span>file_<wbr>format</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/common_datasource/file_format.rs.html#15-333">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="csv/index.html" title="mod common_datasource::file_format::csv">csv</a></dt><dt><a class="mod" href="json/index.html" title="mod common_datasource::file_format::json">json</a></dt><dt><a class="mod" href="orc/index.html" title="mod common_datasource::file_format::orc">orc</a></dt><dt><a class="mod" href="parquet/index.html" title="mod common_datasource::file_format::parquet">parquet</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Format.html" title="enum common_datasource::file_format::Format">Format</a></dt></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.DATE_FORMAT.html" title="constant common_datasource::file_format::DATE_FORMAT">DATE_<wbr>FORMAT</a></dt><dt><a class="constant" href="constant.DEFAULT_SCHEMA_INFER_MAX_RECORD.html" title="constant common_datasource::file_format::DEFAULT_SCHEMA_INFER_MAX_RECORD">DEFAULT_<wbr>SCHEMA_<wbr>INFER_<wbr>MAX_<wbr>RECORD</a></dt><dt><a class="constant" href="constant.FILE_PATTERN.html" title="constant common_datasource::file_format::FILE_PATTERN">FILE_<wbr>PATTERN</a></dt><dt><a class="constant" href="constant.FORMAT_COMPRESSION_TYPE.html" title="constant common_datasource::file_format::FORMAT_COMPRESSION_TYPE">FORMAT_<wbr>COMPRESSION_<wbr>TYPE</a></dt><dt><a class="constant" href="constant.FORMAT_DELIMITER.html" title="constant common_datasource::file_format::FORMAT_DELIMITER">FORMAT_<wbr>DELIMITER</a></dt><dt><a class="constant" href="constant.FORMAT_HAS_HEADER.html" title="constant common_datasource::file_format::FORMAT_HAS_HEADER">FORMAT_<wbr>HAS_<wbr>HEADER</a></dt><dt><a class="constant" href="constant.FORMAT_SCHEMA_INFER_MAX_RECORD.html" title="constant common_datasource::file_format::FORMAT_SCHEMA_INFER_MAX_RECORD">FORMAT_<wbr>SCHEMA_<wbr>INFER_<wbr>MAX_<wbr>RECORD</a></dt><dt><a class="constant" href="constant.FORMAT_TYPE.html" title="constant common_datasource::file_format::FORMAT_TYPE">FORMAT_<wbr>TYPE</a></dt><dt><a class="constant" href="constant.TIMESTAMP_FORMAT.html" title="constant common_datasource::file_format::TIMESTAMP_FORMAT">TIMESTAMP_<wbr>FORMAT</a></dt><dt><a class="constant" href="constant.TIME_FORMAT.html" title="constant common_datasource::file_format::TIME_FORMAT">TIME_<wbr>FORMAT</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ArrowDecoder.html" title="trait common_datasource::file_format::ArrowDecoder">Arrow<wbr>Decoder</a></dt><dt><a class="trait" href="trait.FileFormat.html" title="trait common_datasource::file_format::FileFormat">File<wbr>Format</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.file_to_stream.html" title="fn common_datasource::file_format::file_to_stream">file_<wbr>to_<wbr>stream</a></dt><dd>Creates a [FileStream] for reading data from a file with optional column projection
|
|
and compression support.</dd><dt><a class="fn" href="fn.infer_schemas.html" title="fn common_datasource::file_format::infer_schemas">infer_<wbr>schemas</a></dt><dt><a class="fn" href="fn.open_with_decoder.html" title="fn common_datasource::file_format::open_with_decoder">open_<wbr>with_<wbr>decoder</a></dt><dt><a class="fn" href="fn.stream_to_file.html" title="fn common_datasource::file_format::stream_to_file">stream_<wbr>to_<wbr>file</a></dt><dd>Streams [SendableRecordBatchStream] to a file with optional compression support.
|
|
Data is buffered and flushed according to the given <code>threshold</code>.
|
|
Ensures that writer resources are cleanly released and that an empty file is not
|
|
created if no rows are written.</dd><dt><a class="fn" href="fn.write_to_compressed_writer.html" title="fn common_datasource::file_format::write_to_compressed_writer">write_<wbr>to_<wbr>compressed_<wbr>writer</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Writes data to a compressed writer if the data is not empty.</dd></dl></section></div></main></body></html> |