| <!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: 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="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 <span class="returnvalue">gchar</span> * |
| </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"> |
| <span class="returnvalue">gboolean</span> |
| </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"> |
| <span class="returnvalue">gboolean</span> |
| </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"> |
| <span class="returnvalue">gchar</span> * |
| </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"> |
| <a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *</td> |
| <td class="property_name"><a class="link" href="GArrowField.html#GArrowField--data-type" title="The “data-type” property">data-type</a></td> |
| <td class="property_flags">Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><span class="type">gpointer</span></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="define_keyword">#define</td> |
| <td class="function_name"><a class="link" href="GArrowField.html#GARROW-TYPE-FIELD:CAPS" title="GARROW_TYPE_FIELD">GARROW_TYPE_FIELD</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">struct</td> |
| <td class="function_name"><a class="link" href="GArrowField.html#GArrowFieldClass" title="struct GArrowFieldClass">GArrowFieldClass</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GArrowField.html#GArrowField-struct" title="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"> GObject |
| <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 <span class="type">gchar</span> *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 <span class="type">gchar</span> *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><span class="type">gboolean</span> 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 <span class="returnvalue">gchar</span> * |
| 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="Don't free data after the code is done."><span class="acronym">transfer none</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"><span class="returnvalue">gboolean</span> |
| 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"><span class="returnvalue">gboolean</span> |
| 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> <code class="literal">TRUE</code> if both of them have the same data, <code class="literal">FALSE</code> |
| otherwise.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="garrow-field-to-string"></a><h3>garrow_field_to_string ()</h3> |
| <pre class="programlisting"><span class="returnvalue">gchar</span> * |
| 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="GARROW-TYPE-FIELD:CAPS"></a><h3>GARROW_TYPE_FIELD</h3> |
| <pre class="programlisting">#define GARROW_TYPE_FIELD (garrow_field_get_type()) |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowFieldClass"></a><h3>struct GArrowFieldClass</h3> |
| <pre class="programlisting">struct GArrowFieldClass { |
| GObjectClass parent_class; |
| }; |
| </pre> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowField-struct"></a><h3>GArrowField</h3> |
| <pre class="programlisting">typedef struct _GArrowField GArrowField;</pre> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GArrowField.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GArrowField--data-type"></a><h3>The <code class="literal">“data-type”</code> property</h3> |
| <pre class="programlisting"> “data-type” <a class="link" href="basic-data-type-classes.html#GArrowDataType"><span class="type">GArrowDataType</span></a> *</pre> |
| <p>The data type.</p> |
| <p>Flags: Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GArrowField--field"></a><h3>The <code class="literal">“field”</code> property</h3> |
| <pre class="programlisting"> “field” <span class="type">gpointer</span></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> |
| <script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body> |
| </html> |
