http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/GArrowField.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/GArrowField.html b/docs/c_glib/arrow-glib/GArrowField.html new file mode 100644 index 0000000..03dec0a --- /dev/null +++ b/docs/c_glib/arrow-glib/GArrowField.html @@ -0,0 +1,372 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowField: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="schema.html" title="Schema"> +<link rel="prev" href="schema.html" title="Schema"> +<link rel="next" href="GArrowSchema.html" title="GArrowSchema"> +<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="#GArrowField.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowField.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#GArrowField.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="schema.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="schema.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowSchema.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowField"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowField.top_of_page"></a>GArrowField</span></h2> +<p>GArrowField â Field class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowField.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"> +<a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-new" title="garrow_field_new ()">garrow_field_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-new-full" title="garrow_field_new_full ()">garrow_field_new_full</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-get-name" title="garrow_field_get_name ()">garrow_field_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-get-data-type" title="garrow_field_get_data_type ()">garrow_field_get_data_type</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-is-nullable" title="garrow_field_is_nullable ()">garrow_field_is_nullable</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-equal" title="garrow_field_equal ()">garrow_field_equal</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowField.html#garrow-field-to-string" title="garrow_field_to_string ()">garrow_field_to_string</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowField.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"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="GArrowField.html#GArrowField--field" title="The âfieldâ property">field</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowField.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="GArrowField.html#GArrowField-struct" title="struct GArrowField">GArrowField</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowField.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowField +</pre> +</div> +<div class="refsect1"> +<a name="GArrowField.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> is a class for field. Field is metadata of a +column. It has name, data type (<a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a>) and nullable +information of the column.</p> +</div> +<div class="refsect1"> +<a name="GArrowField.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-field-new"></a><h3>garrow_field_new ()</h3> +<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +garrow_field_new (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *name</code></em>, + <em class="parameter"><code><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-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>name</p></td> +<td class="parameter_description"><p>The name of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data_type</p></td> +<td class="parameter_description"><p>The data type of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-new-full"></a><h3>garrow_field_new_full ()</h3> +<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> * +garrow_field_new_full (<em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *name</code></em>, + <em class="parameter"><code><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *data_type</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gboolean"><span class="type">gboolean</span></GTKDOCLINK> nullable</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-new-full.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>name</p></td> +<td class="parameter_description"><p>The name of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data_type</p></td> +<td class="parameter_description"><p>The data type of the field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nullable</p></td> +<td class="parameter_description"><p>Whether null may be included or not.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-new-full.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-get-name"></a><h3>garrow_field_get_name ()</h3> +<pre class="programlisting">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_field_get_name (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-get-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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-get-name.returns"></a><h4>Returns</h4> +<p> The name of the field.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-get-data-type"></a><h3>garrow_field_get_data_type ()</h3> +<pre class="programlisting"><a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="returnvalue">GArrowDataType</span></a> * +garrow_field_get_data_type (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-get-data-type.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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-get-data-type.returns"></a><h4>Returns</h4> +<p>The data type of the field. </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-field-is-nullable"></a><h3>garrow_field_is_nullable ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_field_is_nullable (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-is-nullable.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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-is-nullable.returns"></a><h4>Returns</h4> +<p> Whether the filed may include null or not.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-equal"></a><h3>garrow_field_equal ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_field_equal (<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="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *other_field</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>other_field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> to be compared.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-equal.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> +otherwise.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-field-to-string"></a><h3>garrow_field_to_string ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_field_to_string (<em class="parameter"><code><a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a> *field</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-field-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>field</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowField.html" title="GArrowField"><span class="type">GArrowField</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-field-to-string.returns"></a><h4>Returns</h4> +<p> The string representation of the field.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowField.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowField-struct"></a><h3>struct GArrowField</h3> +<pre class="programlisting">struct GArrowField;</pre> +<p>It wraps <code class="literal">arrow::Field</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowField.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowField--field"></a><h3>The <code class="literal">âfieldâ</code> property</h3> +<pre class="programlisting"> âfieldâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::Field> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/GArrowFile.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/GArrowFile.html b/docs/c_glib/arrow-glib/GArrowFile.html new file mode 100644 index 0000000..e07fb8d --- /dev/null +++ b/docs/c_glib/arrow-glib/GArrowFile.html @@ -0,0 +1,180 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowFile: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="input-output.html" title="Input and output"> +<link rel="prev" href="input-output.html" title="Input and output"> +<link rel="next" href="ipc.html" title="Part III. IPC"> +<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="#GArrowFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowFile.object-hierarchy" class="shortcut">Object Hierarchy</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="input-output.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="input-output.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="ipc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowFile"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowFile.top_of_page"></a>GArrowFile</span></h2> +<p>GArrowFile â File interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowFile.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"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowFile.html#garrow-file-close" title="garrow_file_close ()">garrow_file_close</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowFile.html#garrow-file-tell" title="garrow_file_tell ()">garrow_file_tell</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="returnvalue">GArrowFileMode</span></a> +</td> +<td class="function_name"> +<a class="link" href="GArrowFile.html#garrow-file-get-mode" title="garrow_file_get_mode ()">garrow_file_get_mode</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowFile.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowFile +</pre> +</div> +<div class="refsect1"> +<a name="GArrowFile.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> is an interface for file.</p> +</div> +<div class="refsect1"> +<a name="GArrowFile.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-file-close"></a><h3>garrow_file_close ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_file_close (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-file-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>file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-file-close.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> on success, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> if there was an error.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-tell"></a><h3>garrow_file_tell ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_file_tell (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-file-tell.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>file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-file-tell.returns"></a><h4>Returns</h4> +<p> The current offset on success, -1 if there was an error.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-file-get-mode"></a><h3>garrow_file_get_mode ()</h3> +<pre class="programlisting"><a class="link" href="arrow-glib-GArrowFileMode.html#GArrowFileMode" title="enum GArrowFileMode"><span class="returnvalue">GArrowFileMode</span></a> +garrow_file_get_mode (<em class="parameter"><code><a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a> *file</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-file-get-mode.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>file</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowFile.html" title="GArrowFile"><span class="type">GArrowFile</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-file-get-mode.returns"></a><h4>Returns</h4> +<p> The mode of the file.</p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GArrowFile.other_details"></a><h2>Types and Values</h2> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/GArrowReadable.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/GArrowReadable.html b/docs/c_glib/arrow-glib/GArrowReadable.html new file mode 100644 index 0000000..80063a2 --- /dev/null +++ b/docs/c_glib/arrow-glib/GArrowReadable.html @@ -0,0 +1,113 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowReadable: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="input.html" title="Input"> +<link rel="prev" href="input.html" title="Input"> +<link rel="next" href="input-stream-classes.html" title="Input stream classes"> +<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="#GArrowReadable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowReadable.object-hierarchy" class="shortcut">Object Hierarchy</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="input.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="input.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="input-stream-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowReadable"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowReadable.top_of_page"></a>GArrowReadable</span></h2> +<p>GArrowReadable â Input interface</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowReadable.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"> +<a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowReadable.html#garrow-readable-read" title="garrow_readable_read ()">garrow_readable_read</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowReadable.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GInterface">GInterface</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowReadable +</pre> +</div> +<div class="refsect1"> +<a name="GArrowReadable.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowReadable.html" title="GArrowReadable"><span class="type">GArrowReadable</span></a> is an interface for input. Input must be +readable.</p> +</div> +<div class="refsect1"> +<a name="GArrowReadable.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-readable-read"></a><h3>garrow_readable_read ()</h3> +<pre class="programlisting"><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="returnvalue">GArrowBuffer</span></a> * +garrow_readable_read (<em class="parameter"><code><a class="link" href="GArrowReadable.html" title="GArrowReadable"><span class="type">GArrowReadable</span></a> *readable</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_bytes</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-readable-read.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>readable</p></td> +<td class="parameter_description"><p>A <a class="link" href="GArrowReadable.html" title="GArrowReadable"><span class="type">GArrowReadable</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>n_bytes</p></td> +<td class="parameter_description"><p>The number of bytes to be read.</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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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-readable-read.returns"></a><h4>Returns</h4> +<p><a class="link" href="buffer-classes.html#GArrowBuffer"><span class="type">GArrowBuffer</span></a> that has read +data on success, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> if there was 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> +</div> +</div> +<div class="refsect1"> +<a name="GArrowReadable.other_details"></a><h2>Types and Values</h2> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/GArrowRecordBatch.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/GArrowRecordBatch.html b/docs/c_glib/arrow-glib/GArrowRecordBatch.html new file mode 100644 index 0000000..130a925 --- /dev/null +++ b/docs/c_glib/arrow-glib/GArrowRecordBatch.html @@ -0,0 +1,639 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GArrowRecordBatch: arrow-glib Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="index.html" title="arrow-glib Reference Manual"> +<link rel="up" href="table.html" title="Table"> +<link rel="prev" href="GArrowTable.html" title="GArrowTable"> +<link rel="next" href="GArrowColumn.html" title="GArrowColumn"> +<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="#GArrowRecordBatch.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#GArrowRecordBatch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#GArrowRecordBatch.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="GArrowColumn.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GArrowRecordBatch"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GArrowRecordBatch.top_of_page"></a>GArrowRecordBatch</span></h2> +<p>GArrowRecordBatch â Record batch class</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GArrowRecordBatch.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"> +<a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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 class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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="GArrowRecordBatch.html#garrow-record-batch-get-column" title="garrow_record_batch_get_column ()">garrow_record_batch_get_column</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.html#garrow-record-batch-get-columns" title="garrow_record_batch_get_columns ()">garrow_record_batch_get_columns</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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"> +<GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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"> +<GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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"> +<GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GArrowRecordBatch.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> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.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"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="GArrowRecordBatch.html#GArrowRecordBatch--record-batch" title="The ârecord-batchâ property">record-batch</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.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="GArrowRecordBatch.html#GArrowRecordBatch-struct" title="struct GArrowRecordBatch">GArrowRecordBatch</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowRecordBatch +</pre> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.description"></a><h2>Description</h2> +<p><a class="link" href="GArrowRecordBatch.html" title="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> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-record-batch-new"></a><h3>garrow_record_batch_new ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="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><GTKDOCLINK HREF="guint32"><span class="type">guint32</span></GTKDOCLINK> n_rows</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GList"><span class="type">GList</span></GTKDOCLINK> *columns</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> 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-equal"></a><h3>garrow_record_batch_equal ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_record_batch_equal (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if both of them have the same data, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> +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-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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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"></a><h3>garrow_record_batch_get_column ()</h3> +<pre class="programlisting"><a class="link" href="basic-array-classes.html#GArrowArray"><span class="returnvalue">GArrowArray</span></a> * +garrow_record_batch_get_column (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> i</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-get-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="GArrowRecordBatch.html" title="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.returns"></a><h4>Returns</h4> +<p>The i-th column in the record batch +on success, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> 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> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-get-columns"></a><h3>garrow_record_batch_get_columns ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="GList"><span class="returnvalue">GList</span></GTKDOCLINK> * +garrow_record_batch_get_columns (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-get-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="GArrowRecordBatch.html" title="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-columns.returns"></a><h4>Returns</h4> +<p>The columns in the record batch. </p> +<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowArray][<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-name"></a><h3>garrow_record_batch_get_column_name ()</h3> +<pre class="programlisting">const <GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_record_batch_get_column_name (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint"><span class="type">gint</span></GTKDOCLINK> 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="GArrowRecordBatch.html" title="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, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> 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"><GTKDOCLINK HREF="guint"><span class="returnvalue">guint</span></GTKDOCLINK> +garrow_record_batch_get_n_columns (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_record_batch_get_n_rows (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_slice (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> offset</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> 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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> shares values with the base +<a class="link" href="GArrowRecordBatch.html" title="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"><GTKDOCLINK HREF="gchar"><span class="returnvalue">gchar</span></GTKDOCLINK> * +garrow_record_batch_to_string (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **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="GArrowRecordBatch.html" title="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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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 <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error.</p> +<p> The returned string should be freed when with <GTKDOCLINK HREF="g-free"><code class="function">g_free()</code></GTKDOCLINK> 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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_add_column (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> 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><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **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="GArrowRecordBatch.html" title="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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> that has a new column or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> 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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_remove_column (<em class="parameter"><code><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> *record_batch</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="guint"><span class="type">guint</span></GTKDOCLINK> i</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **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="GArrowRecordBatch.html" title="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 <GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK>. </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="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> that doesn't have the column or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> 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> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowRecordBatch-struct"></a><h3>struct GArrowRecordBatch</h3> +<pre class="programlisting">struct GArrowRecordBatch;</pre> +<p>It wraps <code class="literal">arrow::RecordBatch</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="GArrowRecordBatch.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â <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::RecordBatch> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
