| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Record batch related 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="table.html" title="Table"> |
| <link rel="prev" href="GArrowTable.html" title="GArrowTable"> |
| <link rel="next" href="GArrowChunkedArray.html" title="GArrowChunkedArray"> |
| <meta name="generator" content="GTK-Doc V1.32 (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="#record-batch.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#record-batch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#record-batch.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="table.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="GArrowTable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="GArrowChunkedArray.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="record-batch"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="record-batch.top_of_page"></a>Record batch related classes</span></h2> |
| <p>Record batch related classes</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="record-batch.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_proto_type"> |
| <col class="functions_proto_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-import" title="garrow_record_batch_import ()">garrow_record_batch_import</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-new" title="garrow_record_batch_new ()">garrow_record_batch_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-export" title="garrow_record_batch_export ()">garrow_record_batch_export</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-equal" title="garrow_record_batch_equal ()">garrow_record_batch_equal</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-equal-metadata" title="garrow_record_batch_equal_metadata ()">garrow_record_batch_equal_metadata</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-get-schema" title="garrow_record_batch_get_schema ()">garrow_record_batch_get_schema</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-get-column-data" title="garrow_record_batch_get_column_data ()">garrow_record_batch_get_column_data</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-get-column-name" title="garrow_record_batch_get_column_name ()">garrow_record_batch_get_column_name</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-get-n-columns" title="garrow_record_batch_get_n_columns ()">garrow_record_batch_get_n_columns</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-get-n-rows" title="garrow_record_batch_get_n_rows ()">garrow_record_batch_get_n_rows</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-slice" title="garrow_record_batch_slice ()">garrow_record_batch_slice</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-to-string" title="garrow_record_batch_to_string ()">garrow_record_batch_to_string</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-add-column" title="garrow_record_batch_add_column ()">garrow_record_batch_add_column</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-remove-column" title="garrow_record_batch_remove_column ()">garrow_record_batch_remove_column</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-serialize" title="garrow_record_batch_serialize ()">garrow_record_batch_serialize</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="returnvalue">GArrowRecordBatchIterator</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-iterator-new" title="garrow_record_batch_iterator_new ()">garrow_record_batch_iterator_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-iterator-next" title="garrow_record_batch_iterator_next ()">garrow_record_batch_iterator_next</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-iterator-equal" title="garrow_record_batch_iterator_equal ()">garrow_record_batch_iterator_equal</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="record-batch.html#garrow-record-batch-iterator-to-list" title="garrow_record_batch_iterator_to_list ()">garrow_record_batch_iterator_to_list</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.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"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> |
| <td class="property_name"><a class="link" href="record-batch.html#GArrowRecordBatch--record-batch" title="The “record-batch” property">record-batch</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td> |
| <td class="property_name"><a class="link" href="record-batch.html#GArrowRecordBatchIterator--iterator" title="The “iterator” property">iterator</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <a name="GArrowRecordBatch"></a><a name="GArrowRecordBatchIterator"></a><div class="refsect1"> |
| <a name="record-batch.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="other_proto_type"> |
| <col class="other_proto_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="record-batch.html#GARROW-TYPE-RECORD-BATCH:CAPS" title="GARROW_TYPE_RECORD_BATCH">GARROW_TYPE_RECORD_BATCH</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="record-batch.html#GArrowRecordBatchClass" title="struct GArrowRecordBatchClass">GArrowRecordBatchClass</a></td> |
| </tr> |
| <tr> |
| <td class="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="record-batch.html#GARROW-TYPE-RECORD-BATCH-ITERATOR:CAPS" title="GARROW_TYPE_RECORD_BATCH_ITERATOR">GARROW_TYPE_RECORD_BATCH_ITERATOR</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="record-batch.html#GArrowRecordBatchIteratorClass" title="struct GArrowRecordBatchIteratorClass">GArrowRecordBatchIteratorClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="record-batch.html#GArrowRecordBatch-struct" title="GArrowRecordBatch">GArrowRecordBatch</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="record-batch.html#GArrowRecordBatchIterator-struct" title="GArrowRecordBatchIterator">GArrowRecordBatchIterator</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> |
| <span class="lineart">├──</span> GArrowRecordBatch |
| <span class="lineart">╰──</span> GArrowRecordBatchIterator |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <arrow-glib/arrow-glib.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.description"></a><h2>Description</h2> |
| <p><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> is a class for record batch. Record batch is |
| similar to <a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a>. Record batch also has also zero or more |
| columns and zero or more records.</p> |
| <p>Record batch is used for shared memory IPC.</p> |
| <p><a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a> is a class for iterating record |
| batches.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-import"></a><h3>garrow_record_batch_import ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_import (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> c_abi_array</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><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-import.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>c_abi_array</p></td> |
| <td class="parameter_description"><p>A <code class="literal">struct ArrowArray *</code>. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL must not be passed as the value in, out, in-out; or as a return value."><span class="acronym">not nullable</span></acronym>]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>schema</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> of the C ABI array.</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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-import.returns"></a><h4>Returns</h4> |
| <p>An imported <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> |
| on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p> |
| <p> You don't need to release the passed <code class="literal">struct ArrowArray *</code>, |
| even if this function reports an error. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<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-6-0-0.html#api-index-6.0.0">6.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-new"></a><h3>garrow_record_batch_new ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_new (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> n_rows</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *columns</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-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>schema</p></td> |
| <td class="parameter_description"><p>The schema of the record batch.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>n_rows</p></td> |
| <td class="parameter_description"><p>The number of the rows in the record batch.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>columns</p></td> |
| <td class="parameter_description"><p>The columns in the record batch. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowArray]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-new.returns"></a><h4>Returns</h4> |
| <p>A newly created <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-export"></a><h3>garrow_record_batch_export ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| garrow_record_batch_export (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *c_abi_array</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *c_abi_schema</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-export.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>c_abi_array</p></td> |
| <td class="parameter_description"><p>Return location for a <code class="literal">struct ArrowArray *</code>. |
| It should be freed with the <code class="literal">ArrowArray::release</code> callback then |
| <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>c_abi_schema</p></td> |
| <td class="parameter_description"><p>Return location for a |
| <code class="literal">struct ArrowSchema *</code> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. |
| It should be freed with the <code class="literal">ArrowSchema::release</code> callback then |
| <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<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> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-export.returns"></a><h4>Returns</h4> |
| <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-6-0-0.html#api-index-6.0.0">6.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-equal"></a><h3>garrow_record_batch_equal ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| garrow_record_batch_equal (<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><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *other_record_batch</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-equal.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>other_record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> to be compared.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-equal.returns"></a><h4>Returns</h4> |
| <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if both of them have the same data, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> |
| otherwise.</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-equal-metadata"></a><h3>garrow_record_batch_equal_metadata ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| garrow_record_batch_equal_metadata (<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><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *other_record_batch</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> check_metadata</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-equal-metadata.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>other_record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> to be compared.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>check_metadata</p></td> |
| <td class="parameter_description"><p>Whether to compare metadata.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-equal-metadata.returns"></a><h4>Returns</h4> |
| <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if both of them have the same data, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> |
| otherwise.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-get-schema"></a><h3>garrow_record_batch_get_schema ()</h3> |
| <pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * |
| garrow_record_batch_get_schema (<em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-schema.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-schema.returns"></a><h4>Returns</h4> |
| <p>The schema of the record batch. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-get-column-data"></a><h3>garrow_record_batch_get_column_data ()</h3> |
| <pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * |
| garrow_record_batch_get_column_data (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-column-data.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the target column. If it's negative, index is |
| counted backward from the end of the columns. <code class="literal">-1</code> means the last |
| column.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-column-data.returns"></a><h4>Returns</h4> |
| <p>The i-th column in the record batch |
| on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on out of index. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<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-15-0.html#api-index-0.15.0">0.15.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-get-column-name"></a><h3>garrow_record_batch_get_column_name ()</h3> |
| <pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| garrow_record_batch_get_column_name (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-column-name.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the target column. If it's negative, index is |
| counted backward from the end of the columns. <code class="literal">-1</code> means the last |
| column.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-column-name.returns"></a><h4>Returns</h4> |
| <p>The name of the i-th column in the record batch |
| on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on out of index. </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> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-get-n-columns"></a><h3>garrow_record_batch_get_n_columns ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> |
| garrow_record_batch_get_n_columns (<em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-n-columns.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-n-columns.returns"></a><h4>Returns</h4> |
| <p> The number of columns in the record batch.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-get-n-rows"></a><h3>garrow_record_batch_get_n_rows ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> |
| garrow_record_batch_get_n_rows (<em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-n-rows.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-get-n-rows.returns"></a><h4>Returns</h4> |
| <p> The number of rows in the record batch.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-slice"></a><h3>garrow_record_batch_slice ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_slice (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> offset</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> length</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-slice.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>offset</p></td> |
| <td class="parameter_description"><p>The offset of sub <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>length</p></td> |
| <td class="parameter_description"><p>The length of sub <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-slice.returns"></a><h4>Returns</h4> |
| <p>The sub <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>. It covers |
| only from <code class="literal">offset</code> to <code class="literal">offset + length</code> range. The sub |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> shares values with the base |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>. </p> |
| <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-to-string"></a><h3>garrow_record_batch_to_string ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * |
| garrow_record_batch_to_string (<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><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-to-string.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-to-string.returns"></a><h4>Returns</h4> |
| <p>The formatted record batch content or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p> |
| <p> It should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a> when no longer needed. </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-add-column"></a><h3>garrow_record_batch_add_column ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_add_column (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>, |
| <em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>, |
| <em class="parameter"><code><a class="link" href="basic-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *column</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-add-column.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the new column.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>field</p></td> |
| <td class="parameter_description"><p>The field to be added.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>column</p></td> |
| <td class="parameter_description"><p>The column to be added.</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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-add-column.returns"></a><h4>Returns</h4> |
| <p>The newly allocated |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> that has a new column or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-9-0.html#api-index-0.9.0">0.9.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-remove-column"></a><h3>garrow_record_batch_remove_column ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_remove_column (<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><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-remove-column.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>i</p></td> |
| <td class="parameter_description"><p>The index of the new column.</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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-remove-column.returns"></a><h4>Returns</h4> |
| <p>The newly allocated |
| <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> that doesn't have the column or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-9-0.html#api-index-0.9.0">0.9.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-serialize"></a><h3>garrow_record_batch_serialize ()</h3> |
| <pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * |
| garrow_record_batch_serialize (<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><a class="link" href="ipc-options-classes.html#GArrowWriteOptions"><span class="type">GArrowWriteOptions</span></a> *options</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-serialize.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>record_batch</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>options</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="ipc-options-classes.html#GArrowWriteOptions"><span class="type">GArrowWriteOptions</span></a>. </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> |
| <tr> |
| <td class="parameter_name"><p>error</p></td> |
| <td class="parameter_description"><p>Return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-serialize.returns"></a><h4>Returns</h4> |
| <p>The newly allocated |
| <a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> that contains a serialized record batch or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> 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>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-1-0-0.html#api-index-1.0.0">1.0.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-iterator-new"></a><h3>garrow_record_batch_iterator_new ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="returnvalue">GArrowRecordBatchIterator</span></a> * |
| garrow_record_batch_iterator_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *record_batches</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-iterator-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>record_batches</p></td> |
| <td class="parameter_description"><p>The record batches. </p></td> |
| <td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowRecordBatch]</span></td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-iterator-new.returns"></a><h4>Returns</h4> |
| <p> A newly created <a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-iterator-next"></a><h3>garrow_record_batch_iterator_next ()</h3> |
| <pre class="programlisting"><a class="link" href="record-batch.html#GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * |
| garrow_record_batch_iterator_next (<em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a> *iterator</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-iterator-next.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>iterator</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-iterator-next.returns"></a><h4>Returns</h4> |
| <p>The next <a class="link" href="record-batch.html#GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when the iterator is completed. </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>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-iterator-equal"></a><h3>garrow_record_batch_iterator_equal ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> |
| garrow_record_batch_iterator_equal (<em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a> *iterator</code></em>, |
| <em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a> *other_iterator</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-iterator-equal.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>iterator</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a>.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>other_iterator</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a> to be compared.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-iterator-equal.returns"></a><h4>Returns</h4> |
| <p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if both iterators are the same, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-record-batch-iterator-to-list"></a><h3>garrow_record_batch_iterator_to_list ()</h3> |
| <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> * |
| garrow_record_batch_iterator_to_list (<em class="parameter"><code><a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</span></a> *iterator</code></em>, |
| <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> |
| <div class="refsect3"> |
| <a name="garrow-record-batch-iterator-to-list.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>iterator</p></td> |
| <td class="parameter_description"><p>A <a class="link" href="record-batch.html#GArrowRecordBatchIterator"><span class="type">GArrowRecordBatchIterator</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 <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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-iterator-to-list.returns"></a><h4>Returns</h4> |
| <p>A <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> contains every moved elements from the iterator. </p> |
| <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowRecordBatch][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-0-17-0.html#api-index-0.17.0">0.17.0</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-RECORD-BATCH:CAPS"></a><h3>GARROW_TYPE_RECORD_BATCH</h3> |
| <pre class="programlisting">#define GARROW_TYPE_RECORD_BATCH (garrow_record_batch_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchClass"></a><h3>struct GArrowRecordBatchClass</h3> |
| <pre class="programlisting">struct GArrowRecordBatchClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GARROW-TYPE-RECORD-BATCH-ITERATOR:CAPS"></a><h3>GARROW_TYPE_RECORD_BATCH_ITERATOR</h3> |
| <pre class="programlisting">#define GARROW_TYPE_RECORD_BATCH_ITERATOR</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchIteratorClass"></a><h3>struct GArrowRecordBatchIteratorClass</h3> |
| <pre class="programlisting">struct GArrowRecordBatchIteratorClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatch-struct"></a><h3>GArrowRecordBatch</h3> |
| <pre class="programlisting">typedef struct _GArrowRecordBatch GArrowRecordBatch;</pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchIterator-struct"></a><h3>GArrowRecordBatchIterator</h3> |
| <pre class="programlisting">typedef struct _GArrowRecordBatchIterator GArrowRecordBatchIterator;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="record-batch.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatch--record-batch"></a><h3>The <code class="literal">“record-batch”</code> property</h3> |
| <pre class="programlisting"> “record-batch” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> |
| <p>The raw std::shared<arrow::RecordBatch> *.</p> |
| <p>Owner: GArrowRecordBatch</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowRecordBatchIterator--iterator"></a><h3>The <code class="literal">“iterator”</code> property</h3> |
| <pre class="programlisting"> “iterator” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre> |
| <p>The raw arrow::RecordBatchIterator.</p> |
| <p>Owner: GArrowRecordBatchIterator</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.32</div> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
