http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/table-builder-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/table-builder-classes.html b/docs/c_glib/arrow-glib/table-builder-classes.html new file mode 100644 index 0000000..140470d --- /dev/null +++ b/docs/c_glib/arrow-glib/table-builder-classes.html @@ -0,0 +1,414 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Table builder classes: 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-builder.html" title="Table builder"> +<link rel="prev" href="table-builder.html" title="Table builder"> +<link rel="next" href="buffer.html" title="Buffer"> +<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="#table-builder-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#table-builder-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#table-builder-classes.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="table-builder.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="table-builder.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="buffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="table-builder-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="table-builder-classes.top_of_page"></a>Table builder classes</span></h2> +<p>Table builder classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="table-builder-classes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="returnvalue">GArrowRecordBatchBuilder</span></a> * +</td> +<td class="function_name"> +<a class="link" href="table-builder-classes.html#garrow-record-batch-builder-new" title="garrow_record_batch_builder_new ()">garrow_record_batch_builder_new</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="table-builder-classes.html#garrow-record-batch-builder-get-initial-capacity" title="garrow_record_batch_builder_get_initial_capacity ()">garrow_record_batch_builder_get_initial_capacity</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="table-builder-classes.html#garrow-record-batch-builder-set-initial-capacity" title="garrow_record_batch_builder_set_initial_capacity ()">garrow_record_batch_builder_set_initial_capacity</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="table-builder-classes.html#garrow-record-batch-builder-get-schema" title="garrow_record_batch_builder_get_schema ()">garrow_record_batch_builder_get_schema</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="table-builder-classes.html#garrow-record-batch-builder-get-n-fields" title="garrow_record_batch_builder_get_n_fields ()">garrow_record_batch_builder_get_n_fields</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="array-builder-classes.html#GArrowArrayBuilder"><span class="returnvalue">GArrowArrayBuilder</span></a> * +</td> +<td class="function_name"> +<a class="link" href="table-builder-classes.html#garrow-record-batch-builder-get-field" title="garrow_record_batch_builder_get_field ()">garrow_record_batch_builder_get_field</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="table-builder-classes.html#garrow-record-batch-builder-flush" title="garrow_record_batch_builder_flush ()">garrow_record_batch_builder_flush</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="table-builder-classes.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody><tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder--record-batch-builder" title="The ârecord-batch-builderâ property">record-batch-builder</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr></tbody> +</table></div> +</div> +<a name="GArrowRecordBatchBuilder"></a><div class="refsect1"> +<a name="table-builder-classes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="table-builder-classes.html#GARROW-TYPE-RECORD-BATCH-BUILDER:CAPS" title="GARROW_TYPE_RECORD_BATCH_BUILDER">GARROW_TYPE_RECORD_BATCH_BUILDER</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilderClass" title="struct GArrowRecordBatchBuilderClass">GArrowRecordBatchBuilderClass</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder-struct" title="GArrowRecordBatchBuilder">GArrowRecordBatchBuilder</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="table-builder-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">â°ââ</span> GArrowRecordBatchBuilder +</pre> +</div> +<div class="refsect1"> +<a name="table-builder-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="table-builder-classes.description"></a><h2>Description</h2> +<p><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> is a class to create +new <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a>.</p> +</div> +<div class="refsect1"> +<a name="table-builder-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-record-batch-builder-new"></a><h3>garrow_record_batch_builder_new ()</h3> +<pre class="programlisting"><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="returnvalue">GArrowRecordBatchBuilder</span></a> * +garrow_record_batch_builder_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="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-builder-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>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>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-builder-new.returns"></a><h4>Returns</h4> +<p> A newly created <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> on success, +<GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-builder-get-initial-capacity"></a><h3>garrow_record_batch_builder_get_initial_capacity ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint64"><span class="returnvalue">gint64</span></GTKDOCLINK> +garrow_record_batch_builder_get_initial_capacity + (<em class="parameter"><code><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> *builder</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-builder-get-initial-capacity.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>builder</p></td> +<td class="parameter_description"><p>A <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-record-batch-builder-get-initial-capacity.returns"></a><h4>Returns</h4> +<p> The initial capacity for array builders.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-builder-set-initial-capacity"></a><h3>garrow_record_batch_builder_set_initial_capacity ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +garrow_record_batch_builder_set_initial_capacity + (<em class="parameter"><code><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> *builder</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> capacity</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-builder-set-initial-capacity.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>builder</p></td> +<td class="parameter_description"><p>A <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>capacity</p></td> +<td class="parameter_description"><p>The new initial capacity for array builders.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-builder-get-schema"></a><h3>garrow_record_batch_builder_get_schema ()</h3> +<pre class="programlisting"><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="returnvalue">GArrowSchema</span></a> * +garrow_record_batch_builder_get_schema + (<em class="parameter"><code><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> *builder</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-builder-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>builder</p></td> +<td class="parameter_description"><p>A <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-record-batch-builder-get-schema.returns"></a><h4>Returns</h4> +<p>The <a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> of the record batch builder. </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-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-builder-get-n-fields"></a><h3>garrow_record_batch_builder_get_n_fields ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gint"><span class="returnvalue">gint</span></GTKDOCLINK> +garrow_record_batch_builder_get_n_fields + (<em class="parameter"><code><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> *builder</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-builder-get-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>builder</p></td> +<td class="parameter_description"><p>A <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-record-batch-builder-get-n-fields.returns"></a><h4>Returns</h4> +<p> The number of fields.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-builder-get-field"></a><h3>garrow_record_batch_builder_get_field ()</h3> +<pre class="programlisting"><a class="link" href="array-builder-classes.html#GArrowArrayBuilder"><span class="returnvalue">GArrowArrayBuilder</span></a> * +garrow_record_batch_builder_get_field (<em class="parameter"><code><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> *builder</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-builder-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>builder</p></td> +<td class="parameter_description"><p>A <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</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 field index. If it's negative, index is counted backward +from the end of the fields. <code class="literal">-1</code> means the last field.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="garrow-record-batch-builder-get-field.returns"></a><h4>Returns</h4> +<p>The <a class="link" href="array-builder-classes.html#GArrowArrayBuilder"><span class="type">GArrowArrayBuilder</span></a> for +the <code class="literal">i</code>-th field on success, <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on out of index. </p> +<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> +</div> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-builder-flush"></a><h3>garrow_record_batch_builder_flush ()</h3> +<pre class="programlisting"><a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="returnvalue">GArrowRecordBatch</span></a> * +garrow_record_batch_builder_flush (<em class="parameter"><code><a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</span></a> *builder</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-builder-flush.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>builder</p></td> +<td class="parameter_description"><p>A <a class="link" href="table-builder-classes.html#GArrowRecordBatchBuilder"><span class="type">GArrowRecordBatchBuilder</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-builder-flush.returns"></a><h4>Returns</h4> +<p>The built <a class="link" href="GArrowRecordBatch.html" title="GArrowRecordBatch"><span class="type">GArrowRecordBatch</span></a> on success, +<GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> on error. </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-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="table-builder-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GARROW-TYPE-RECORD-BATCH-BUILDER:CAPS"></a><h3>GARROW_TYPE_RECORD_BATCH_BUILDER</h3> +<pre class="programlisting">#define GARROW_TYPE_RECORD_BATCH_BUILDER (garrow_record_batch_builder_get_type()) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchBuilderClass"></a><h3>struct GArrowRecordBatchBuilderClass</h3> +<pre class="programlisting">struct GArrowRecordBatchBuilderClass { + GObjectClass parent_class; +}; +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchBuilder-struct"></a><h3>GArrowRecordBatchBuilder</h3> +<pre class="programlisting">typedef struct _GArrowRecordBatchBuilder GArrowRecordBatchBuilder;</pre> +</div> +</div> +<div class="refsect1"> +<a name="table-builder-classes.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowRecordBatchBuilder--record-batch-builder"></a><h3>The <code class="literal">ârecord-batch-builderâ</code> property</h3> +<pre class="programlisting"> ârecord-batch-builderâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw arrow::RecordBatchBuilder *.</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/table-builder.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/table-builder.html b/docs/c_glib/arrow-glib/table-builder.html new file mode 100644 index 0000000..7033dc6 --- /dev/null +++ b/docs/c_glib/arrow-glib/table-builder.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Table builder: 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="data.html" title="Part I. Data"> +<link rel="prev" href="GArrowChunkedArray.html" title="GArrowChunkedArray"> +<link rel="next" href="table-builder-classes.html" title="Table builder 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"></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="data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowChunkedArray.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="table-builder-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="table-builder"></a>Table builder</h2></div></div></div> +<div class="toc"><dl class="toc"><dt> +<span class="refentrytitle"><a href="table-builder-classes.html">Table builder classes</a></span><span class="refpurpose"></span> +</dt></dl></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/table.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/table.html b/docs/c_glib/arrow-glib/table.html new file mode 100644 index 0000000..9218736 --- /dev/null +++ b/docs/c_glib/arrow-glib/table.html @@ -0,0 +1,43 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Table: 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="data.html" title="Part I. Data"> +<link rel="prev" href="GArrowSchema.html" title="GArrowSchema"> +<link rel="next" href="GArrowTable.html" title="GArrowTable"> +<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"></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="data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowSchema.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowTable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="table"></a>Table</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="GArrowTable.html">GArrowTable</a></span><span class="refpurpose"> â Table class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GArrowRecordBatch.html">GArrowRecordBatch</a></span><span class="refpurpose"> â Record batch class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GArrowColumn.html">GArrowColumn</a></span><span class="refpurpose"> â Column class</span> +</dt> +<dt> +<span class="refentrytitle"><a href="GArrowChunkedArray.html">GArrowChunkedArray</a></span><span class="refpurpose"> â Chunked array class</span> +</dt> +</dl></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/tensor.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/tensor.html b/docs/c_glib/arrow-glib/tensor.html new file mode 100644 index 0000000..0616d42 --- /dev/null +++ b/docs/c_glib/arrow-glib/tensor.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Tensor: 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="data.html" title="Part I. Data"> +<link rel="prev" href="GArrowDecimal128.html" title="Decimal classes"> +<link rel="next" href="GArrowTensor.html" title="GArrowTensor"> +<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"></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="data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowDecimal128.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="GArrowTensor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="tensor"></a>Tensor</h2></div></div></div> +<div class="toc"><dl class="toc"><dt> +<span class="refentrytitle"><a href="GArrowTensor.html">GArrowTensor</a></span><span class="refpurpose"> â Tensor class</span> +</dt></dl></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/type.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/type.html b/docs/c_glib/arrow-glib/type.html new file mode 100644 index 0000000..34288a7 --- /dev/null +++ b/docs/c_glib/arrow-glib/type.html @@ -0,0 +1,40 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Type: 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="data.html" title="Part I. Data"> +<link rel="prev" href="GArrowTensor.html" title="GArrowTensor"> +<link rel="next" href="arrow-glib-GArrowType.html" title="GArrowType"> +<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"></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="data.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="GArrowTensor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="arrow-glib-GArrowType.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="type"></a>Type</h2></div></div></div> +<div class="toc"><dl class="toc"> +<dt> +<span class="refentrytitle"><a href="arrow-glib-GArrowType.html">GArrowType</a></span><span class="refpurpose"> â Type mapping between Arrow and arrow-glib</span> +</dt> +<dt> +<span class="refentrytitle"><a href="basic-data-type-classes.html">Basic data type classes</a></span><span class="refpurpose"></span> +</dt> +<dt> +<span class="refentrytitle"><a href="composite-data-type-classes.html">Composite data type classes</a></span><span class="refpurpose"></span> +</dt> +</dl></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/up-insensitive.png ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/up-insensitive.png b/docs/c_glib/arrow-glib/up-insensitive.png new file mode 100644 index 0000000..674be9c Binary files /dev/null and b/docs/c_glib/arrow-glib/up-insensitive.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/up.png ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/up.png b/docs/c_glib/arrow-glib/up.png new file mode 100644 index 0000000..ae83f66 Binary files /dev/null and b/docs/c_glib/arrow-glib/up.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/c_glib/arrow-glib/version-macros.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/version-macros.html b/docs/c_glib/arrow-glib/version-macros.html new file mode 100644 index 0000000..e8b3b07 --- /dev/null +++ b/docs/c_glib/arrow-glib/version-macros.html @@ -0,0 +1,292 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Version related macros: 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="version.html" title="Version"> +<link rel="prev" href="version.html" title="Version"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<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="#version-macros.description" class="shortcut">Description</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="version.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="version.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="version-macros"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="version-macros.top_of_page"></a>Version related macros</span></h2> +<p>Version related macros</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="version-macros.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="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="version-macros.html#GARROW-VERSION-CHECK:CAPS" title="GARROW_VERSION_CHECK()">GARROW_VERSION_CHECK</a><span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="version-macros.html#GARROW-DEPRECATED-FOR:CAPS" title="GARROW_DEPRECATED_FOR()">GARROW_DEPRECATED_FOR</a><span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="version-macros.html#GARROW-UNAVAILABLE:CAPS" title="GARROW_UNAVAILABLE()">GARROW_UNAVAILABLE</a><span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"> +<a class="link" href="version-macros.html#GARROW-DEPRECATED-IN-0-10-FOR:CAPS" title="GARROW_DEPRECATED_IN_0_10_FOR()">GARROW_DEPRECATED_IN_0_10_FOR</a><span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="version-macros.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="version-macros.html#GARROW-VERSION-MAJOR:CAPS" title="GARROW_VERSION_MAJOR">GARROW_VERSION_MAJOR</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-VERSION-MINOR:CAPS" title="GARROW_VERSION_MINOR">GARROW_VERSION_MINOR</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-VERSION-MICRO:CAPS" title="GARROW_VERSION_MICRO">GARROW_VERSION_MICRO</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-VERSION-TAG:CAPS" title="GARROW_VERSION_TAG">GARROW_VERSION_TAG</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-DEPRECATED:CAPS" title="GARROW_DEPRECATED">GARROW_DEPRECATED</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-VERSION-0-10:CAPS" title="GARROW_VERSION_0_10">GARROW_VERSION_0_10</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-VERSION-MIN-REQUIRED:CAPS" title="GARROW_VERSION_MIN_REQUIRED">GARROW_VERSION_MIN_REQUIRED</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-VERSION-MAX-ALLOWED:CAPS" title="GARROW_VERSION_MAX_ALLOWED">GARROW_VERSION_MAX_ALLOWED</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-AVAILABLE-IN-ALL:CAPS" title="GARROW_AVAILABLE_IN_ALL">GARROW_AVAILABLE_IN_ALL</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-DEPRECATED-IN-0-10:CAPS" title="GARROW_DEPRECATED_IN_0_10">GARROW_DEPRECATED_IN_0_10</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="version-macros.html#GARROW-AVAILABLE-IN-0-10:CAPS" title="GARROW_AVAILABLE_IN_0_10">GARROW_AVAILABLE_IN_0_10</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="version-macros.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="version-macros.description"></a><h2>Description</h2> +<p>Apache Arrow GLib provides macros that can be used by C pre-processor. +They are useful to check version related things at compile time.</p> +</div> +<div class="refsect1"> +<a name="version-macros.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="GARROW-VERSION-CHECK:CAPS"></a><h3>GARROW_VERSION_CHECK()</h3> +<pre class="programlisting">#define GARROW_VERSION_CHECK(major, minor, micro)</pre> +<p>You can use this macro in C pre-processor.</p> +<div class="refsect3"> +<a name="GARROW-VERSION-CHECK.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>major</p></td> +<td class="parameter_description"><p>A major version to check for.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>minor</p></td> +<td class="parameter_description"><p>A minor version to check for.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>micro</p></td> +<td class="parameter_description"><p>A micro version to check for.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="GARROW-VERSION-CHECK.returns"></a><h4>Returns</h4> +<p> <GTKDOCLINK HREF="TRUE:CAPS"><code class="literal">TRUE</code></GTKDOCLINK> if the compile time Apache Arrow GLib version is the +same as or newer than the passed version, <GTKDOCLINK HREF="FALSE:CAPS"><code class="literal">FALSE</code></GTKDOCLINK> otherwise.</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-DEPRECATED-FOR:CAPS"></a><h3>GARROW_DEPRECATED_FOR()</h3> +<pre class="programlisting"># define GARROW_DEPRECATED_FOR(function) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-UNAVAILABLE:CAPS"></a><h3>GARROW_UNAVAILABLE()</h3> +<pre class="programlisting"># define GARROW_UNAVAILABLE(major, minor) +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-DEPRECATED-IN-0-10-FOR:CAPS"></a><h3>GARROW_DEPRECATED_IN_0_10_FOR()</h3> +<pre class="programlisting"># define GARROW_DEPRECATED_IN_0_10_FOR(function) GARROW_DEPRECATED_FOR(function) +</pre> +</div> +</div> +<div class="refsect1"> +<a name="version-macros.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GARROW-VERSION-MAJOR:CAPS"></a><h3>GARROW_VERSION_MAJOR</h3> +<pre class="programlisting">#define GARROW_VERSION_MAJOR (0) +</pre> +<p>The major version.</p> +<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-VERSION-MINOR:CAPS"></a><h3>GARROW_VERSION_MINOR</h3> +<pre class="programlisting">#define GARROW_VERSION_MINOR (12) +</pre> +<p>The minor version.</p> +<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-VERSION-MICRO:CAPS"></a><h3>GARROW_VERSION_MICRO</h3> +<pre class="programlisting">#define GARROW_VERSION_MICRO (0) +</pre> +<p>The micro version.</p> +<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-VERSION-TAG:CAPS"></a><h3>GARROW_VERSION_TAG</h3> +<pre class="programlisting">#define GARROW_VERSION_TAG "SNAPSHOT" +</pre> +<p>The version tag. Normally, it's an empty string. It's "SNAPSHOT" +for snapshot version.</p> +<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-DEPRECATED:CAPS"></a><h3>GARROW_DEPRECATED</h3> +<pre class="programlisting"># define GARROW_DEPRECATED +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-VERSION-0-10:CAPS"></a><h3>GARROW_VERSION_0_10</h3> +<pre class="programlisting">#define GARROW_VERSION_0_10 G_ENCODE_VERSION(0, 10) +</pre> +<p>You can use this macro value for compile time API version check.</p> +<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-VERSION-MIN-REQUIRED:CAPS"></a><h3>GARROW_VERSION_MIN_REQUIRED</h3> +<pre class="programlisting">#define GARROW_VERSION_MIN_REQUIRED</pre> +<p>You can use this macro for compile time API version check.</p> +<p>This macro value must be one of the predefined version macros such +as <a class="link" href="version-macros.html#GARROW-VERSION-0-10:CAPS" title="GARROW_VERSION_0_10"><code class="literal">GARROW_VERSION_0_10</code></a>.</p> +<p>If you use any functions that is defined by newer version than +<a class="link" href="version-macros.html#GARROW-VERSION-MIN-REQUIRED:CAPS" title="GARROW_VERSION_MIN_REQUIRED"><code class="literal">GARROW_VERSION_MIN_REQUIRED</code></a>, deprecated warnings are produced at +compile time.</p> +<p>You must define this macro before including the +arrow-glib/arrow-glib.h header.</p> +<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-VERSION-MAX-ALLOWED:CAPS"></a><h3>GARROW_VERSION_MAX_ALLOWED</h3> +<pre class="programlisting">#define GARROW_VERSION_MAX_ALLOWED</pre> +<p>You can use this macro for compile time API version check.</p> +<p>This macro value must be one of the predefined version macros such +as <a class="link" href="version-macros.html#GARROW-VERSION-0-10:CAPS" title="GARROW_VERSION_0_10"><code class="literal">GARROW_VERSION_0_10</code></a>.</p> +<p>If you use any functions that is defined by newer version than +<a class="link" href="version-macros.html#GARROW-VERSION-MAX-ALLOWED:CAPS" title="GARROW_VERSION_MAX_ALLOWED"><code class="literal">GARROW_VERSION_MAX_ALLOWED</code></a>, deprecated warnings are produced at +compile time.</p> +<p>You must define this macro before including the +arrow-glib/arrow-glib.h header.</p> +<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-AVAILABLE-IN-ALL:CAPS"></a><h3>GARROW_AVAILABLE_IN_ALL</h3> +<pre class="programlisting">#define GARROW_AVAILABLE_IN_ALL +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-DEPRECATED-IN-0-10:CAPS"></a><h3>GARROW_DEPRECATED_IN_0_10</h3> +<pre class="programlisting"># define GARROW_DEPRECATED_IN_0_10 GARROW_DEPRECATED +</pre> +</div> +<hr> +<div class="refsect2"> +<a name="GARROW-AVAILABLE-IN-0-10:CAPS"></a><h3>GARROW_AVAILABLE_IN_0_10</h3> +<pre class="programlisting"># define GARROW_AVAILABLE_IN_0_10 GARROW_UNAVAILABLE(0, 10) +</pre> +</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/version.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/version.html b/docs/c_glib/arrow-glib/version.html new file mode 100644 index 0000000..fe0ad51 --- /dev/null +++ b/docs/c_glib/arrow-glib/version.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Version: 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="misc.html" title="Part V. Misc"> +<link rel="prev" href="misc.html" title="Part V. Misc"> +<link rel="next" href="version-macros.html" title="Version related macros"> +<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"></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="misc.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="misc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="version-macros.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="version"></a>Version</h2></div></div></div> +<div class="toc"><dl class="toc"><dt> +<span class="refentrytitle"><a href="version-macros.html">Version related macros</a></span><span class="refpurpose"></span> +</dt></dl></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/writer-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/writer-classes.html b/docs/c_glib/arrow-glib/writer-classes.html new file mode 100644 index 0000000..03c4b3a --- /dev/null +++ b/docs/c_glib/arrow-glib/writer-classes.html @@ -0,0 +1,626 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Writer classes: 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="writer.html" title="Writer"> +<link rel="prev" href="writer.html" title="Writer"> +<link rel="next" href="gpu.html" title="Part IV. GPU"> +<meta name="generator" content="GTK-Doc V1.27 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> + <a href="#writer-classes.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> + <a href="#writer-classes.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> + <a href="#writer-classes.properties" class="shortcut">Properties</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="writer.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="writer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="gpu.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="writer-classes"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="writer-classes.top_of_page"></a>Writer classes</span></h2> +<p>Writer classes</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="writer-classes.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-record-batch-writer-write-record-batch" title="garrow_record_batch_writer_write_record_batch ()">garrow_record_batch_writer_write_record_batch</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-record-batch-writer-write-table" title="garrow_record_batch_writer_write_table ()">garrow_record_batch_writer_write_table</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-record-batch-writer-close" title="garrow_record_batch_writer_close ()">garrow_record_batch_writer_close</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="returnvalue">GArrowRecordBatchStreamWriter</span></a> * +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-record-batch-stream-writer-new" title="garrow_record_batch_stream_writer_new ()">garrow_record_batch_stream_writer_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="returnvalue">GArrowRecordBatchFileWriter</span></a> * +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-record-batch-file-writer-new" title="garrow_record_batch_file_writer_new ()">garrow_record_batch_file_writer_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="returnvalue">GArrowFeatherFileWriter</span></a> * +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-feather-file-writer-new" title="garrow_feather_file_writer_new ()">garrow_feather_file_writer_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-feather-file-writer-set-description" title="garrow_feather_file_writer_set_description ()">garrow_feather_file_writer_set_description</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +</td> +<td class="function_name"> +<a class="link" href="writer-classes.html#garrow-feather-file-writer-set-n-rows" title="garrow_feather_file_writer_set_n_rows ()">garrow_feather_file_writer_set_n_rows</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="writer-classes.html#garrow-feather-file-writer-append" title="garrow_feather_file_writer_append ()">garrow_feather_file_writer_append</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="writer-classes.html#garrow-feather-file-writer-close" title="garrow_feather_file_writer_close ()">garrow_feather_file_writer_close</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="writer-classes.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="writer-classes.html#GArrowRecordBatchWriter--record-batch-writer" title="The ârecord-batch-writerâ property">record-batch-writer</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +<tr> +<td class="property_type"><GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></td> +<td class="property_name"><a class="link" href="writer-classes.html#GArrowFeatherFileWriter--feather-table-writer" title="The âfeather-table-writerâ property">feather-table-writer</a></td> +<td class="property_flags">Write / Construct Only</td> +</tr> +</tbody> +</table></div> +</div> +<a name="GArrowRecordBatchWriter"></a><a name="GArrowRecordBatchStreamWriter"></a><a name="GArrowRecordBatchFileWriter"></a><a name="GArrowFeatherFileWriter"></a><div class="refsect1"> +<a name="writer-classes.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="writer-classes.html#GArrowRecordBatchWriter-struct" title="struct GArrowRecordBatchWriter">GArrowRecordBatchWriter</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter-struct" title="struct GArrowRecordBatchStreamWriter">GArrowRecordBatchStreamWriter</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter-struct" title="struct GArrowRecordBatchFileWriter">GArrowRecordBatchFileWriter</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="writer-classes.html#GArrowFeatherFileWriter-struct" title="struct GArrowFeatherFileWriter">GArrowFeatherFileWriter</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="writer-classes.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <GTKDOCLINK HREF="GObject">GObject</GTKDOCLINK> + <span class="lineart">âââ</span> GArrowFeatherFileWriter + <span class="lineart">â°ââ</span> GArrowRecordBatchWriter + <span class="lineart">â°ââ</span> GArrowRecordBatchStreamWriter + <span class="lineart">â°ââ</span> GArrowRecordBatchFileWriter +</pre> +</div> +<div class="refsect1"> +<a name="writer-classes.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <arrow-glib/arrow-glib.h> +</pre> +</div> +<div class="refsect1"> +<a name="writer-classes.description"></a><h2>Description</h2> +<p><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> is a base class for writing record batches +in stream format into output.</p> +<p><a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="type">GArrowRecordBatchStreamWriter</span></a> is a base class for writing record +batches in stream format into output synchronously.</p> +<p><a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="type">GArrowRecordBatchFileWriter</span></a> is a class for writing record +batches in file format into output.</p> +<p><a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a> is a class for writing arrays +in Feather file format into output.</p> +</div> +<div class="refsect1"> +<a name="writer-classes.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="garrow-record-batch-writer-write-record-batch"></a><h3>garrow_record_batch_writer_write_record_batch ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_record_batch_writer_write_record_batch + (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> *writer</code></em>, + <em class="parameter"><code><a class="link" href="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-writer-write-record-batch.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>record_batch</p></td> +<td class="parameter_description"><p>The record batch to be written.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-writer-write-record-batch.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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-writer-write-table"></a><h3>garrow_record_batch_writer_write_table ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_record_batch_writer_write_table + (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> *writer</code></em>, + <em class="parameter"><code><a class="link" href="GArrowTable.html" title="GArrowTable"><span class="type">GArrowTable</span></a> *table</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-writer-write-table.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>table</p></td> +<td class="parameter_description"><p>The table to be written.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-writer-write-table.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> +<p class="since">Since: <a class="link" href="api-index-0-8-0.html#api-index-0.8.0">0.8.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-writer-close"></a><h3>garrow_record_batch_writer_close ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_record_batch_writer_close (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a> *writer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-writer-close.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowRecordBatchWriter"><span class="type">GArrowRecordBatchWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-writer-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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-stream-writer-new"></a><h3>garrow_record_batch_stream_writer_new ()</h3> +<pre class="programlisting"><a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="returnvalue">GArrowRecordBatchStreamWriter</span></a> * +garrow_record_batch_stream_writer_new (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *sink</code></em>, + <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-stream-writer-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>sink</p></td> +<td class="parameter_description"><p>The output of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>schema</p></td> +<td class="parameter_description"><p>The schema of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-stream-writer-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter"><span class="type">GArrowRecordBatchStreamWriter</span></a> +or <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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="garrow-record-batch-file-writer-new"></a><h3>garrow_record_batch_file_writer_new ()</h3> +<pre class="programlisting"><a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="returnvalue">GArrowRecordBatchFileWriter</span></a> * +garrow_record_batch_file_writer_new (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *sink</code></em>, + <em class="parameter"><code><a class="link" href="GArrowSchema.html" title="GArrowSchema"><span class="type">GArrowSchema</span></a> *schema</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-record-batch-file-writer-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>sink</p></td> +<td class="parameter_description"><p>The output of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>schema</p></td> +<td class="parameter_description"><p>The schema of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-file-writer-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter"><span class="type">GArrowRecordBatchFileWriter</span></a> +or <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> +<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-feather-file-writer-new"></a><h3>garrow_feather_file_writer_new ()</h3> +<pre class="programlisting"><a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="returnvalue">GArrowFeatherFileWriter</span></a> * +garrow_feather_file_writer_new (<em class="parameter"><code><a class="link" href="output-stream-classes.html#GArrowOutputStream"><span class="type">GArrowOutputStream</span></a> *sink</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="GError"><span class="type">GError</span></GTKDOCLINK> **error</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-feather-file-writer-new.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>sink</p></td> +<td class="parameter_description"><p>The output of the writer.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-feather-file-writer-new.returns"></a><h4>Returns</h4> +<p>A newly created <a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</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> +<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-feather-file-writer-set-description"></a><h3>garrow_feather_file_writer_set_description ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +garrow_feather_file_writer_set_description + (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a> *writer</code></em>, + <em class="parameter"><code>const <GTKDOCLINK HREF="gchar"><span class="type">gchar</span></GTKDOCLINK> *description</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-feather-file-writer-set-description.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a>.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>description</p></td> +<td class="parameter_description"><p>The description of the file.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</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-feather-file-writer-set-n-rows"></a><h3>garrow_feather_file_writer_set_n_rows ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="void"><span class="returnvalue">void</span></GTKDOCLINK> +garrow_feather_file_writer_set_n_rows (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a> *writer</code></em>, + <em class="parameter"><code><GTKDOCLINK HREF="gint64"><span class="type">gint64</span></GTKDOCLINK> n_rows</code></em>);</pre> +<div class="refsect3"> +<a name="garrow-feather-file-writer-set-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>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a>.</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 rows in the file.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</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-feather-file-writer-append"></a><h3>garrow_feather_file_writer_append ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_feather_file_writer_append (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a> *writer</code></em>, + <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-array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *array</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-feather-file-writer-append.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</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 array to be appended.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>array</p></td> +<td class="parameter_description"><p>The array to be appended.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>Return locatipcn 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-feather-file-writer-append.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> +<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-feather-file-writer-close"></a><h3>garrow_feather_file_writer_close ()</h3> +<pre class="programlisting"><GTKDOCLINK HREF="gboolean"><span class="returnvalue">gboolean</span></GTKDOCLINK> +garrow_feather_file_writer_close (<em class="parameter"><code><a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</span></a> *writer</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-feather-file-writer-close.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>writer</p></td> +<td class="parameter_description"><p>A <a class="link" href="writer-classes.html#GArrowFeatherFileWriter"><span class="type">GArrowFeatherFileWriter</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 locatipcn 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-feather-file-writer-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> +<p class="since">Since: <a class="link" href="api-index-0-4-0.html#api-index-0.4.0">0.4.0</a></p> +</div> +</div> +<div class="refsect1"> +<a name="writer-classes.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GArrowRecordBatchWriter-struct"></a><h3>struct GArrowRecordBatchWriter</h3> +<pre class="programlisting">struct GArrowRecordBatchWriter;</pre> +<p>It wraps <code class="literal">arrow::ipc::RecordBatchWriter</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchStreamWriter-struct"></a><h3>struct GArrowRecordBatchStreamWriter</h3> +<pre class="programlisting">struct GArrowRecordBatchStreamWriter;</pre> +<p>It wraps <code class="literal">arrow::ipc::RecordBatchStreamWriter</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowRecordBatchFileWriter-struct"></a><h3>struct GArrowRecordBatchFileWriter</h3> +<pre class="programlisting">struct GArrowRecordBatchFileWriter;</pre> +<p>It wraps <code class="literal">arrow::ipc::RecordBatchFileWriter</code>.</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowFeatherFileWriter-struct"></a><h3>struct GArrowFeatherFileWriter</h3> +<pre class="programlisting">struct GArrowFeatherFileWriter;</pre> +<p>It wraps <code class="literal">arrow::ipc::feather::TableWriter</code>.</p> +</div> +</div> +<div class="refsect1"> +<a name="writer-classes.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GArrowRecordBatchWriter--record-batch-writer"></a><h3>The <code class="literal">ârecord-batch-writerâ</code> property</h3> +<pre class="programlisting"> ârecord-batch-writerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ipc::RecordBatchWriter> *.</p> +<p>Flags: Write / Construct Only</p> +</div> +<hr> +<div class="refsect2"> +<a name="GArrowFeatherFileWriter--feather-table-writer"></a><h3>The <code class="literal">âfeather-table-writerâ</code> property</h3> +<pre class="programlisting"> âfeather-table-writerâ <GTKDOCLINK HREF="gpointer"><span class="type">gpointer</span></GTKDOCLINK></pre> +<p>The raw std::shared<arrow::ipc::feather::TableWriter> *.</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/writer.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/arrow-glib/writer.html b/docs/c_glib/arrow-glib/writer.html new file mode 100644 index 0000000..25a6caf --- /dev/null +++ b/docs/c_glib/arrow-glib/writer.html @@ -0,0 +1,32 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Writer: 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="ipc.html" title="Part III. IPC"> +<link rel="prev" href="orc-file-reader.html" title="ORC reader"> +<link rel="next" href="writer-classes.html" title="Writer 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"></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="ipc.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="orc-file-reader.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="writer-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="chapter"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="writer"></a>Writer</h2></div></div></div> +<div class="toc"><dl class="toc"><dt> +<span class="refentrytitle"><a href="writer-classes.html">Writer classes</a></span><span class="refpurpose"></span> +</dt></dl></div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.27</div> +</body> +</html>
