blob: 667ebf1c6ca318244c4e948a48432e9f0e6231d7 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GArrowSchema: 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="GArrowField.html" title="GArrowField">
<link rel="next" href="table.html" title="Table">
<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="#GArrowSchema.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GArrowSchema.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GArrowSchema.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="GArrowField.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="table.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GArrowSchema"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GArrowSchema.top_of_page"></a>GArrowSchema</span></h2>
<p>GArrowSchema — Schema class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GArrowSchema.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="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> *
</td>
<td class="function_name">
<a class="link" href="GArrowSchema.html#garrow-schema-new" title="garrow_schema_new ()">garrow_schema_new</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="GArrowSchema.html#garrow-schema-equal" title="garrow_schema_equal ()">garrow_schema_equal</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="GArrowSchema.html#garrow-schema-get-field" title="garrow_schema_get_field ()">garrow_schema_get_field</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="GArrowSchema.html#garrow-schema-get-field-by-name" title="garrow_schema_get_field_by_name ()">garrow_schema_get_field_by_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="GArrowSchema.html#garrow-schema-get-field-index" title="garrow_schema_get_field_index ()">garrow_schema_get_field_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="GArrowSchema.html#garrow-schema-n-fields" title="garrow_schema_n_fields ()">garrow_schema_n_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="GArrowSchema.html#garrow-schema-get-fields" title="garrow_schema_get_fields ()">garrow_schema_get_fields</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="GArrowSchema.html#garrow-schema-to-string" title="garrow_schema_to_string ()">garrow_schema_to_string</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="GArrowSchema.html#garrow-schema-to-string-metadata" title="garrow_schema_to_string_metadata ()">garrow_schema_to_string_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="GArrowSchema.html#garrow-schema-add-field" title="garrow_schema_add_field ()">garrow_schema_add_field</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="GArrowSchema.html#garrow-schema-remove-field" title="garrow_schema_remove_field ()">garrow_schema_remove_field</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="GArrowSchema.html#garrow-schema-replace-field" title="garrow_schema_replace_field ()">garrow_schema_replace_field</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GHashTable</span> *
</td>
<td class="function_name">
<a class="link" href="GArrowSchema.html#garrow-schema-get-metadata" title="garrow_schema_get_metadata ()">garrow_schema_get_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="GArrowSchema.html#garrow-schema-with-metadata" title="garrow_schema_with_metadata ()">garrow_schema_with_metadata</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GArrowSchema.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gpointer</span></td>
<td class="property_name"><a class="link" href="GArrowSchema.html#GArrowSchema--schema" title="The “schema” property">schema</a></td>
<td class="property_flags">Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GArrowSchema.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="GArrowSchema.html#GARROW-TYPE-SCHEMA:CAPS" title="GARROW_TYPE_SCHEMA">GARROW_TYPE_SCHEMA</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GArrowSchema.html#GArrowSchemaClass" title="struct GArrowSchemaClass">GArrowSchemaClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GArrowSchema.html#GArrowSchema-struct" title="GArrowSchema">GArrowSchema</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GArrowSchema.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GArrowSchema
</pre>
</div>
<div class="refsect1">
<a name="GArrowSchema.description"></a><h2>Description</h2>
<p><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> is a class for schema. Schema is metadata of a
table. It has zero or more <a href="GArrowField.html#GArrowField-struct"><span class="type">GArrowFields</span></a>.</p>
</div>
<div class="refsect1">
<a name="GArrowSchema.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="garrow-schema-new"></a><h3>garrow_schema_new ()</h3>
<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> *
garrow_schema_new (<em class="parameter"><code><span class="type">GList</span> *fields</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-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>fields</p></td>
<td class="parameter_description"><p>The fields of the schema. </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> GArrowField]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-new.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="garrow-schema-equal"></a><h3>garrow_schema_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
garrow_schema_equal (<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 class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *other_schema</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-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>schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>other_schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> to be compared.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-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>
<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-schema-get-field"></a><h3>garrow_schema_get_field ()</h3>
<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> *
garrow_schema_get_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>,
<em class="parameter"><code><span class="type">guint</span> i</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-get-field.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-get-field.returns"></a><h4>Returns</h4>
<p>The i-th field of the schema. </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-schema-get-field-by-name"></a><h3>garrow_schema_get_field_by_name ()</h3>
<pre class="programlisting"><a class="link" href="GArrowField.html" title="GArrowField"><span class="returnvalue">GArrowField</span></a> *
garrow_schema_get_field_by_name (<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>const <span class="type">gchar</span> *name</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-get-field-by-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>schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the field to be found.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-get-field-by-name.returns"></a><h4>Returns</h4>
<p>The found field or <code class="literal">NULL</code>. </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-schema-get-field-index"></a><h3>garrow_schema_get_field_index ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
garrow_schema_get_field_index (<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>const <span class="type">gchar</span> *name</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-get-field-index.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the field to be found.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-get-field-index.returns"></a><h4>Returns</h4>
<p> The index of the found field, -1 on not found.</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-schema-n-fields"></a><h3>garrow_schema_n_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
garrow_schema_n_fields (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-n-fields.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-n-fields.returns"></a><h4>Returns</h4>
<p> The number of fields of the schema.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="garrow-schema-get-fields"></a><h3>garrow_schema_get_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
garrow_schema_get_fields (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-get-fields.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-get-fields.returns"></a><h4>Returns</h4>
<p>The fields of the schema. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GArrowField][<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-schema-to-string"></a><h3>garrow_schema_to_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
garrow_schema_to_string (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-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>schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-to-string.returns"></a><h4>Returns</h4>
<p> The string representation of the schema.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="garrow-schema-to-string-metadata"></a><h3>garrow_schema_to_string_metadata ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
garrow_schema_to_string_metadata (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> show_metadata</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-to-string-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>schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_metadata</p></td>
<td class="parameter_description"><p>Whether include metadata or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-to-string-metadata.returns"></a><h4>Returns</h4>
<p> The string representation of the schema.</p>
<p> It should be freed with <code class="function">g_free()</code> when no longer needed.</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-schema-add-field"></a><h3>garrow_schema_add_field ()</h3>
<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> *
garrow_schema_add_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>,
<em class="parameter"><code><span class="type">guint</span> 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><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-add-field.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field.</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>error</p></td>
<td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-add-field.returns"></a><h4>Returns</h4>
<p>The newly allocated
<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that has a new field or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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-10-0.html#api-index-0.10.0">0.10.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="garrow-schema-remove-field"></a><h3>garrow_schema_remove_field ()</h3>
<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> *
garrow_schema_remove_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>,
<em class="parameter"><code><span class="type">guint</span> i</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-remove-field.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field to be removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-remove-field.returns"></a><h4>Returns</h4>
<p>The newly allocated
<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that doesn't have the field or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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-10-0.html#api-index-0.10.0">0.10.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="garrow-schema-replace-field"></a><h3>garrow_schema_replace_field ()</h3>
<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> *
garrow_schema_replace_field (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>,
<em class="parameter"><code><span class="type">guint</span> 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><span class="type">GError</span> **error</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-replace-field.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>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</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 field to be replaced.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>field</p></td>
<td class="parameter_description"><p>The newly added <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>error</p></td>
<td class="parameter_description"><p>Return location for a <span class="type">GError</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-replace-field.returns"></a><h4>Returns</h4>
<p>The newly allocated
<a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> that has <em class="parameter"><code>field</code></em>
as the <em class="parameter"><code>i</code></em>
-th field or <code class="literal">NULL</code> on error. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<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-10-0.html#api-index-0.10.0">0.10.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="garrow-schema-get-metadata"></a><h3>garrow_schema_get_metadata ()</h3>
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
garrow_schema_get_metadata (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-get-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>schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-get-metadata.returns"></a><h4>Returns</h4>
<p>The
metadata in the schema.</p>
<p> It should be freed with <code class="function">g_hash_table_unref()</code> when no longer needed. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<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-schema-with-metadata"></a><h3>garrow_schema_with_metadata ()</h3>
<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> *
garrow_schema_with_metadata (<em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>,
<em class="parameter"><code><span class="type">GHashTable</span> *metadata</code></em>);</pre>
<div class="refsect3">
<a name="garrow-schema-with-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>schema</p></td>
<td class="parameter_description"><p>A <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>metadata</p></td>
<td class="parameter_description"><p>A new associated metadata. </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> utf8 utf8]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="garrow-schema-with-metadata.returns"></a><h4>Returns</h4>
<p>The new schema with the given metadata. </p>
<p><span class="annotation">[<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="GArrowSchema.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GARROW-TYPE-SCHEMA:CAPS"></a><h3>GARROW_TYPE_SCHEMA</h3>
<pre class="programlisting">#define GARROW_TYPE_SCHEMA (garrow_schema_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GArrowSchemaClass"></a><h3>struct GArrowSchemaClass</h3>
<pre class="programlisting">struct GArrowSchemaClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="GArrowSchema-struct"></a><h3>GArrowSchema</h3>
<pre class="programlisting">typedef struct _GArrowSchema GArrowSchema;</pre>
</div>
</div>
<div class="refsect1">
<a name="GArrowSchema.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GArrowSchema--schema"></a><h3>The <code class="literal">“schema”</code> property</h3>
<pre class="programlisting"> “schema” <span class="type">gpointer</span></pre>
<p>The raw std::shared&lt;arrow::Schema&gt; *.</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>