| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Writer classes: Apache Arrow GLib Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="Apache Arrow GLib Reference Manual"> |
| <link rel="up" href="writer.html" title="Writer"> |
| <link rel="prev" href="writer.html" title="Writer"> |
| <link rel="next" href="gpu.html" title="Part V. GPU"> |
| <meta name="generator" content="GTK-Doc V1.27 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#writer-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#writer-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#writer-classes.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="writer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="writer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="gpu.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="writer-classes"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="writer-classes.top_of_page"></a>Writer classes</span></h2> |
| <p>Writer classes</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="writer-classes.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="writer-classes.html#garrow-record-batch-writer-write-record-batch" title="garrow_record_batch_writer_write_record_batch ()">garrow_record_batch_writer_write_record_batch</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="writer-classes.html#garrow-record-batch-writer-write-table" title="garrow_record_batch_writer_write_table ()">garrow_record_batch_writer_write_table</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">gboolean</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="writer-classes.html#garrow-record-batch-writer-close" title="garrow_record_batch_writer_close ()">garrow_record_batch_writer_close</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="returnvalue">GArrowRecordBatchStreamWriter</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="writer-classes.html#garrow-record-batch-stream-writer-new" title="garrow_record_batch_stream_writer_new ()">garrow_record_batch_stream_writer_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="returnvalue">GArrowRecordBatchFileWriter</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="writer-classes.html#garrow-record-batch-file-writer-new" title="garrow_record_batch_file_writer_new ()">garrow_record_batch_file_writer_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody><tr> |
| <td class="property_type"><span class="type">gpointer</span></td> |
| <td class="property_name"><a class="link" href="writer-classes.html#GArrowRecordBatchWriter--record-batch-writer" title="The “record-batch-writer” property">record-batch-writer</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <a name="GArrowRecordBatchWriter"></a><a name="GArrowRecordBatchStreamWriter"></a><a name="GArrowRecordBatchFileWriter"></a><div class="refsect1"> |
| <a name="writer-classes.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="writer-classes.html#GArrowRecordBatchWriter-struct" title="struct GArrowRecordBatchWriter">GArrowRecordBatchWriter</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter-struct" title="struct GArrowRecordBatchStreamWriter">GArrowRecordBatchStreamWriter</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter-struct" title="struct GArrowRecordBatchFileWriter">GArrowRecordBatchFileWriter</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> GObject |
| <span class="lineart">╰──</span> GArrowRecordBatchWriter |
| <span class="lineart">╰──</span> GArrowRecordBatchStreamWriter |
| <span class="lineart">╰──</span> GArrowRecordBatchFileWriter |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.description"></a><h2>Description</h2> |
| <p><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> is a base class for writing record batches |
| in stream format into output.</p> |
| <p><a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="type">GArrowRecordBatchStreamWriter</span></a> is a base class for writing record |
| batches in stream format into output synchronously.</p> |
| <p><a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="type">GArrowRecordBatchFileWriter</span></a> is a class for writing record |
| batches in file format into output.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-writer-write-record-batch"></a><h3>garrow_record_batch_writer_write_record_batch ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_record_batch_writer_write_record_batch |
| (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> *writer</code></em>, |
| <em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-writer-write-record-batch.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>writer</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>record_batch</p></td> |
| <td class="parameter_description"><p>The record batch to be written.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-writer-write-record-batch.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if there was an error.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-writer-write-table"></a><h3>garrow_record_batch_writer_write_table ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_record_batch_writer_write_table |
| (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> *writer</code></em>, |
| <em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-writer-write-table.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>writer</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>table</p></td> |
| <td class="parameter_description"><p>The table to be written.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-writer-write-table.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if there was an error.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-writer-close"></a><h3>garrow_record_batch_writer_close ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gboolean</span> |
| garrow_record_batch_writer_close (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> *writer</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-writer-close.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>writer</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-writer-close.returns"></a><h4>Returns</h4> |
| <p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if there was an error.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-stream-writer-new"></a><h3>garrow_record_batch_stream_writer_new ()</h3> |
| <pre class="programlisting"><a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="returnvalue">GArrowRecordBatchStreamWriter</span></a> * |
| garrow_record_batch_stream_writer_new (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *sink</code></em>, |
| <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-stream-writer-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>sink</p></td> |
| <td class="parameter_description"><p>The output of the writer.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>schema</p></td> |
| <td class="parameter_description"><p>The schema of the writer.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-stream-writer-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="type">GArrowRecordBatchStreamWriter</span></a> |
| or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-file-writer-new"></a><h3>garrow_record_batch_file_writer_new ()</h3> |
| <pre class="programlisting"><a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="returnvalue">GArrowRecordBatchFileWriter</span></a> * |
| garrow_record_batch_file_writer_new (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *sink</code></em>, |
| <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, |
| <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-writer-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>sink</p></td> |
| <td class="parameter_description"><p>The output of the writer.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>schema</p></td> |
| <td class="parameter_description"><p>The schema of the writer.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-file-writer-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="type">GArrowRecordBatchFileWriter</span></a> |
| or <code class="literal">NULL</code> on error. </p> |
| <p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchWriter-struct"></a><h3>struct GArrowRecordBatchWriter</h3> |
| <pre class="programlisting">struct GArrowRecordBatchWriter;</pre> |
| <p>It wraps <code class="literal">arrow::ipc::RecordBatchWriter</code>.</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchStreamWriter-struct"></a><h3>struct GArrowRecordBatchStreamWriter</h3> |
| <pre class="programlisting">struct GArrowRecordBatchStreamWriter;</pre> |
| <p>It wraps <code class="literal">arrow::ipc::RecordBatchStreamWriter</code>.</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchFileWriter-struct"></a><h3>struct GArrowRecordBatchFileWriter</h3> |
| <pre class="programlisting">struct GArrowRecordBatchFileWriter;</pre> |
| <p>It wraps <code class="literal">arrow::ipc::RecordBatchFileWriter</code>.</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="writer-classes.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchWriter--record-batch-writer"></a><h3>The <code class="literal">“record-batch-writer”</code> property</h3> |
| <pre class="programlisting"> “record-batch-writer” <span class="type">gpointer</span></pre> |
| <p>The raw std::shared<arrow::ipc::RecordBatchWriter> *.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.27</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
