greptimedb/servers/postgres/copy_in/csv/index.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="The `csv` format — currently the only implemented COPY FROM STDIN format."><title>servers::postgres::copy_in::csv - 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-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="servers" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-f7c3ffd8.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"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[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 csv</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../../servers/index.html">servers</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module csv</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In servers::<wbr>postgres::<wbr>copy_<wbr>in</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" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">servers</a>::<wbr><a href="../../index.html">postgres</a>::<wbr><a href="../index.html">copy_in</a></div><h1>Module <span>csv</span>&nbsp;<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/servers/postgres/copy_in/csv.rs.html#15-703">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <code>csv</code> format — currently the only implemented COPY FROM STDIN
format.</p>
<p>Parsing and typed conversion both reuse arrow-csv’s incremental
<a href="arrow::csv::reader::Decoder"><code>Decoder</code></a> — the same engine backing
GreptimeDB’s file-based <code>COPY ... FROM 'file.csv'</code> (see
<code>common-datasource</code>‘s <code>csv</code> file format) — so both COPY routes accept
identical data. The decoder splits records (quoting, escaped quotes,
custom delimiters, <code>\n</code>/<code>\r\n</code> separators, optional headers) and
converts fields against the targeted columns’ schema in one pass.</p>
<p>Consequences of sharing the engine: JSON and Binary columns are
rejected, timestamps must be date/time strings (offset-free ones
parse in the session timezone), and an empty field — quoted or not —
is NULL, exactly like file-based COPY.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CsvCodec.html" title="struct servers::postgres::copy_in::csv::CsvCodec">CsvCodec</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The validated <code>csv</code> format configuration.</dd><dt><a class="struct" href="struct.CsvRecordParser.html" title="struct servers::postgres::copy_in::csv::CsvRecordParser">CsvRecord<wbr>Parser</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Incremental parser backed by arrow-csv’s decoder.</dd></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.build_csv_codec.html" title="fn servers::postgres::copy_in::csv::build_csv_codec">build_<wbr>csv_<wbr>codec</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Builds the CSV codec from the parsed options.</dd><dt><a class="fn" href="fn.decode_error.html" title="fn servers::postgres::copy_in::csv::decode_error">decode_<wbr>error</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.parse_pg_bool.html" title="fn servers::postgres::copy_in::csv::parse_pg_bool">parse_<wbr>pg_<wbr>bool</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Parses PostgreSQL’s boolean spellings: <code>true</code>/<code>false</code>, <code>t</code>/<code>f</code>,
<code>yes</code>/<code>no</code>, <code>on</code>/<code>off</code> and <code>1</code>/<code>0</code>, case-insensitive with surrounding
whitespace allowed (see the BOOLEAN type’s input grammar). COPY OUT
emits <code>t</code>/<code>f</code>, so accepting them keeps both COPY directions
round-trippable.</dd></dl></section></div></main></body></html>