Google Git
Sign in
apache/incubator-graphar-website/refs/heads/asf-site/./docs/cpp/classgraphar_1_1_writer_options.html
blob: 044e380d3f94d55235e0fa652940088e6ed80204 [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache GraphAr C++ Library: graphar::WriterOptions Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache GraphAr C++ Library
</div>
<div id="projectbrief">The C++ Library for Apache GraphAr</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>graphar</b></li><li class="navelem"><a class="el" href="classgraphar_1_1_writer_options.html">WriterOptions</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classgraphar_1_1_writer_options-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">graphar::WriterOptions Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr. A <a class="el" href="classgraphar_1_1_writer_options.html" title="Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr....">WriterOptions</a> instance can simultaneously contain options for all three formats (CSV, Parquet, ORC). The actual file format used for writing is determined by the FileType specified in the graph_Info.
<a href="classgraphar_1_1_writer_options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="writer__util_8h_source.html">writer_util.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_writer_options_1_1_c_s_v_option_builder.html">CSVOptionBuilder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_writer_options_1_1_o_r_c_option_builder.html">ORCOptionBuilder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgraphar_1_1_writer_options_1_1_parquet_option_builder.html">ParquetOptionBuilder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0e867c7ec1f67382959a63645228ac18"><td class="memItemLeft" align="right" valign="top"><a id="a0e867c7ec1f67382959a63645228ac18"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>WriterOptions</b> (std::shared_ptr&lt; CSVOption &gt; csv, std::shared_ptr&lt; ParquetOption &gt; parquet, std::shared_ptr&lt; ORCOption &gt; orc)</td></tr>
<tr class="separator:a0e867c7ec1f67382959a63645228ac18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad71e20a37e7f9182133efb6ba64774e7"><td class="memItemLeft" align="right" valign="top"><a id="ad71e20a37e7f9182133efb6ba64774e7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setCsvOption</b> (std::shared_ptr&lt; CSVOption &gt; csv_option)</td></tr>
<tr class="separator:ad71e20a37e7f9182133efb6ba64774e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3d1de5a8f0fa63272a8ad6209480507"><td class="memItemLeft" align="right" valign="top"><a id="ac3d1de5a8f0fa63272a8ad6209480507"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setParquetOption</b> (std::shared_ptr&lt; ParquetOption &gt; parquet_option)</td></tr>
<tr class="separator:ac3d1de5a8f0fa63272a8ad6209480507"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ec05b762a69f04355610e0a5026add8"><td class="memItemLeft" align="right" valign="top"><a id="a7ec05b762a69f04355610e0a5026add8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setOrcOption</b> (std::shared_ptr&lt; ORCOption &gt; orc_option)</td></tr>
<tr class="separator:a7ec05b762a69f04355610e0a5026add8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af25a35e2ee01637cfa5539e6742ef2fc"><td class="memItemLeft" align="right" valign="top"><a id="af25a35e2ee01637cfa5539e6742ef2fc"></a>
arrow::csv::WriteOptions&#160;</td><td class="memItemRight" valign="bottom"><b>getCsvOption</b> () const</td></tr>
<tr class="separator:af25a35e2ee01637cfa5539e6742ef2fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e8bff8153c421d063cc7425891f30a5"><td class="memItemLeft" align="right" valign="top"><a id="a2e8bff8153c421d063cc7425891f30a5"></a>
std::shared_ptr&lt; parquet::WriterProperties &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>getParquetWriterProperties</b> () const</td></tr>
<tr class="separator:a2e8bff8153c421d063cc7425891f30a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72ce07810ce7023306747e143c0d53f1"><td class="memItemLeft" align="right" valign="top"><a id="a72ce07810ce7023306747e143c0d53f1"></a>
std::shared_ptr&lt; parquet::ArrowWriterProperties &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>getArrowWriterProperties</b> () const</td></tr>
<tr class="separator:a72ce07810ce7023306747e143c0d53f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a9f934f626f13da83fc0d3bdb9f8bd178"><td class="memItemLeft" align="right" valign="top"><a id="a9f934f626f13da83fc0d3bdb9f8bd178"></a>
static std::shared_ptr&lt; <a class="el" href="classgraphar_1_1_writer_options.html">WriterOptions</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>DefaultWriterOption</b> ()</td></tr>
<tr class="separator:a9f934f626f13da83fc0d3bdb9f8bd178"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr. A <a class="el" href="classgraphar_1_1_writer_options.html" title="Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr....">WriterOptions</a> instance can simultaneously contain options for all three formats (CSV, Parquet, ORC). The actual file format used for writing is determined by the FileType specified in the graph_Info. </p>
<p>The configuration parameters and their default values are aligned with those in Arrow.</p>
<p><a class="el" href="classgraphar_1_1_writer_options_1_1_c_s_v_option_builder.html">CSVOptionBuilder</a>, <a class="el" href="classgraphar_1_1_writer_options_1_1_parquet_option_builder.html">ParquetOptionBuilder</a>, and <a class="el" href="classgraphar_1_1_writer_options_1_1_o_r_c_option_builder.html">ORCOptionBuilder</a> are used to construct format-specific options for CSV, Parquet, and ORC, respectively. An existing <a class="el" href="classgraphar_1_1_writer_options.html" title="Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr....">WriterOptions</a> instance can be passed to a builder’s constructor to incrementally add or combine options across different formats. Example: <a class="el" href="classgraphar_1_1_writer_options_1_1_c_s_v_option_builder.html">CSVOptionBuilder</a> csvBuilder; auto wopt = csvBuilder.build(); <a class="el" href="classgraphar_1_1_writer_options_1_1_parquet_option_builder.html">ParquetOptionBuilder</a> parquetBuilder(wopt); wopt = parquetBuilder.build(); </p>
<p class="definition">Definition at line <a class="el" href="writer__util_8h_source.html#l00059">59</a> of file <a class="el" href="writer__util_8h_source.html">writer_util.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>src/graphar/<a class="el" href="writer__util_8h_source.html">writer_util.h</a></li>
<li>src/graphar/<a class="el" href="writer__util_8cc_source.html">writer_util.cc</a></li>
</ul>
</div><!-- contents -->
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!-- disclaimer_footer.html -->
<footer style="text-align: center; font-size: 12px;">
<div>
<p>
Apache GraphAr is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
</p>
<p>
Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. <br/>
Apache, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of the Apache Software Foundation in the United States and/or other countries.
</p>
</div>
</footer>