http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/table-builder-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/table-builder-classes.html b/docs/c_glib/table-builder-classes.html new file mode 100644 index 0000000..9e63547 --- /dev/null +++ b/docs/c_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.25 (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.25</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/table-builder.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/table-builder.html b/docs/c_glib/table-builder.html new file mode 100644 index 0000000..f7f0998 --- /dev/null +++ b/docs/c_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.25 (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.25</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/table.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/table.html b/docs/c_glib/table.html index 1be1f6e..4455fe7 100644 --- a/docs/c_glib/table.html +++ b/docs/c_glib/table.html @@ -2,17 +2,17 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Table</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<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.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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="10"><tr valign="middle"> +<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> @@ -38,7 +38,6 @@ </dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/tensor.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/tensor.html b/docs/c_glib/tensor.html index f54ce8e..0c6bc8f 100644 --- a/docs/c_glib/tensor.html +++ b/docs/c_glib/tensor.html @@ -2,17 +2,17 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Tensor</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<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="compute-classes.html" title="Classes for computation"> <link rel="next" href="GArrowTensor.html" title="GArrowTensor"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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="10"><tr valign="middle"> +<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> @@ -27,7 +27,6 @@ </dt></dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/type.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/type.html b/docs/c_glib/type.html index 7803008..4ab339b 100644 --- a/docs/c_glib/type.html +++ b/docs/c_glib/type.html @@ -2,17 +2,17 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Type</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<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.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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="10"><tr valign="middle"> +<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> @@ -35,7 +35,6 @@ </dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/up-insensitive.png ---------------------------------------------------------------------- diff --git a/docs/c_glib/up-insensitive.png b/docs/c_glib/up-insensitive.png index bda3ce2..9c8bec1 100644 Binary files a/docs/c_glib/up-insensitive.png and b/docs/c_glib/up-insensitive.png differ http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/writer-classes.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/writer-classes.html b/docs/c_glib/writer-classes.html index 6b048f7..7ca7f2a 100644 --- a/docs/c_glib/writer-classes.html +++ b/docs/c_glib/writer-classes.html @@ -2,21 +2,21 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Writer classes</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<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="object-tree.html" title="Object Hierarchy"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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="10"><tr valign="middle"> +<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="#" 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> @@ -35,7 +35,7 @@ </tr></table></div> <div class="refsect1"> <a name="writer-classes.functions"></a><h2>Functions</h2> -<div class="informaltable"><table width="100%" border="0"> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="functions_return"> <col class="functions_name"> @@ -54,6 +54,14 @@ <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> @@ -118,7 +126,7 @@ </div> <div class="refsect1"> <a name="writer-classes.properties"></a><h2>Properties</h2> -<div class="informaltable"><table border="0"> +<div class="informaltable"><table class="informaltable" border="0"> <colgroup> <col width="150px" class="properties_type"> <col width="300px" class="properties_name"> @@ -140,7 +148,7 @@ </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 width="100%" border="0"> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> <col width="150px" class="name"> <col class="description"> @@ -169,11 +177,8 @@ <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> <a class="link" href="writer-classes.html#GArrowRecordBatchWriter">GArrowRecordBatchWriter</a> - <span class="lineart">â</span> <span class="lineart">â°ââ</span> GArrowRecordBatchStreamWriter - <span class="lineart">â</span> <span class="lineart">â°ââ</span> <a class="link" href="writer-classes.html#GArrowRecordBatchFileWriter">GArrowRecordBatchFileWriter</a> <span class="lineart">â°ââ</span> GArrowRecordBatchWriter - <span class="lineart">â°ââ</span> <a class="link" href="writer-classes.html#GArrowRecordBatchStreamWriter">GArrowRecordBatchStreamWriter</a> + <span class="lineart">â°ââ</span> GArrowRecordBatchStreamWriter <span class="lineart">â°ââ</span> GArrowRecordBatchFileWriter </pre> </div> @@ -203,8 +208,8 @@ garrow_record_batch_writer_write_record_batch <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="id-1.4.4.2.13.2.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -224,17 +229,57 @@ garrow_record_batch_writer_write_record_batch <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">[nullable]</span></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="id-1.4.4.2.13.2.5"></a><h4>Returns</h4> +<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> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<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"> @@ -243,8 +288,8 @@ garrow_record_batch_writer_write_record_batch 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="id-1.4.4.2.13.3.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -259,17 +304,16 @@ garrow_record_batch_writer_close (<em class="parameter"><code><a class="link" hr <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">[nullable]</span></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="id-1.4.4.2.13.3.5"></a><h4>Returns</h4> +<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> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<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"> @@ -279,8 +323,8 @@ garrow_record_batch_stream_writer_new (<em class="parameter"><code><a class="lin <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="id-1.4.4.2.13.4.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -300,18 +344,18 @@ garrow_record_batch_stream_writer_new (<em class="parameter"><code><a class="lin <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">[nullable]</span></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="id-1.4.4.2.13.4.5"></a><h4>Returns</h4> +<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">[nullable]</span></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 0.4.0</p> +<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"> @@ -321,8 +365,8 @@ garrow_record_batch_file_writer_new (<em class="parameter"><code><a class="link" <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="id-1.4.4.2.13.5.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -342,18 +386,18 @@ garrow_record_batch_file_writer_new (<em class="parameter"><code><a class="link" <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">[nullable]</span></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="id-1.4.4.2.13.5.5"></a><h4>Returns</h4> +<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">[nullable]</span></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 0.4.0</p> +<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"> @@ -362,8 +406,8 @@ or <GTKDOCLINK HREF="NULL:CAPS"><code class="literal">NULL</code></GTKDOCLINK> o 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="id-1.4.4.2.13.6.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -378,18 +422,18 @@ garrow_feather_file_writer_new (<em class="parameter"><code><a class="link" href <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">[nullable]</span></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="id-1.4.4.2.13.6.5"></a><h4>Returns</h4> +<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">[nullable]</span></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 0.4.0</p> +<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"> @@ -399,8 +443,8 @@ 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="id-1.4.4.2.13.7.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -420,7 +464,7 @@ garrow_feather_file_writer_set_description </tbody> </table></div> </div> -<p class="since">Since 0.4.0</p> +<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"> @@ -429,8 +473,8 @@ garrow_feather_file_writer_set_description 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="id-1.4.4.2.13.8.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -450,7 +494,7 @@ garrow_feather_file_writer_set_n_rows (<em class="parameter"><code><a class="lin </tbody> </table></div> </div> -<p class="since">Since 0.4.0</p> +<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"> @@ -458,11 +502,11 @@ garrow_feather_file_writer_set_n_rows (<em class="parameter"><code><a class="lin <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="array-classes.html#GArrowArray"><span class="type">GArrowArray</span></a> *array</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="id-1.4.4.2.13.9.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -487,17 +531,16 @@ garrow_feather_file_writer_append (<em class="parameter"><code><a class="link" h <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">[nullable]</span></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="id-1.4.4.2.13.9.5"></a><h4>Returns</h4> +<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> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<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"> @@ -506,8 +549,8 @@ garrow_feather_file_writer_append (<em class="parameter"><code><a class="link" h 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="id-1.4.4.2.13.10.4"></a><h4>Parameters</h4> -<div class="informaltable"><table width="100%" border="0"> +<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"> @@ -522,17 +565,16 @@ garrow_feather_file_writer_close (<em class="parameter"><code><a class="link" hr <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">[nullable]</span></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="id-1.4.4.2.13.10.5"></a><h4>Returns</h4> +<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> -<p></p> </div> -<p class="since">Since 0.4.0</p> +<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"> @@ -579,7 +621,6 @@ garrow_feather_file_writer_close (<em class="parameter"><code><a class="link" hr </div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/c_glib/writer.html ---------------------------------------------------------------------- diff --git a/docs/c_glib/writer.html b/docs/c_glib/writer.html index ea5d730..423ce45 100644 --- a/docs/c_glib/writer.html +++ b/docs/c_glib/writer.html @@ -2,17 +2,17 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title> Reference Manual: Writer</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> -<link rel="home" href="index.html" title="Reference Manual"> +<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="reader-classes.html" title="Reader classes"> <link rel="next" href="writer-classes.html" title="Writer classes"> -<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.25 (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="10"><tr valign="middle"> +<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> @@ -27,7 +27,6 @@ </dt></dl></div> </div> <div class="footer"> -<hr> - Generated by GTK-Doc V1.20</div> +<hr>Generated by GTK-Doc V1.25</div> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/cpp/_h_d_f_s_8md.html ---------------------------------------------------------------------- diff --git a/docs/cpp/_h_d_f_s_8md.html b/docs/cpp/_h_d_f_s_8md.html index 1bd3fc6..31610a7 100644 --- a/docs/cpp/_h_d_f_s_8md.html +++ b/docs/cpp/_h_d_f_s_8md.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Apache Arrow (C++): HDFS.md File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -30,18 +30,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -68,7 +71,7 @@ $(function() { <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html";> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.13 +</a> 1.8.14 </small></address> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/cpp/_windows_8md.html ---------------------------------------------------------------------- diff --git a/docs/cpp/_windows_8md.html b/docs/cpp/_windows_8md.html index a730c1c..d002443 100644 --- a/docs/cpp/_windows_8md.html +++ b/docs/cpp/_windows_8md.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Apache Arrow (C++): Windows.md File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -30,18 +30,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.13 --> +<!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -</script> +/* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -68,7 +71,7 @@ $(function() { <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html";> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.13 +</a> 1.8.14 </small></address> </body> </html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/cpp/adapter_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/adapter_8h.html b/docs/cpp/adapter_8h.html new file mode 100644 index 0000000..5ac8299 --- /dev/null +++ b/docs/cpp/adapter_8h.html @@ -0,0 +1,112 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/adapters/orc/adapter.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_280217092a2d22f888c6591dfff78c57.html">adapters</a></li><li class="navelem"><a class="el" href="dir_1b858e9799a28845385d815f228929e5.html">orc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> </div> + <div class="headertitle"> +<div class="title">adapter.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <cstdint></code><br /> +<code>#include <memory></code><br /> +<code>#include <vector></code><br /> +<code>#include "<a class="el" href="interfaces_8h_source.html">arrow/io/interfaces.h</a>"</code><br /> +<code>#include "<a class="el" href="memory__pool_8h_source.html">arrow/memory_pool.h</a>"</code><br /> +<code>#include "<a class="el" href="record__batch_8h_source.html">arrow/record_batch.h</a>"</code><br /> +<code>#include "<a class="el" href="status_8h_source.html">arrow/status.h</a>"</code><br /> +<code>#include "<a class="el" href="type_8h_source.html">arrow/type.h</a>"</code><br /> +<code>#include "<a class="el" href="visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +</div> +<p><a href="adapter_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">arrow::adapters::orc::ORCFileReader</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Read an Arrow <a class="el" href="classarrow_1_1_table.html" title="Logical table as sequence of chunked arrays. ">Table</a> or <a class="el" href="classarrow_1_1_record_batch.html" title="Collection of equal-length arrays matching a particular Schema. ">RecordBatch</a> from an ORC file. <a href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespacearrow"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr> +<tr class="memdesc:namespacearrow"><td class="mdescLeft"> </td><td class="mdescRight">Top-level namespace for Apache Arrow C++ API. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1adapters"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1adapters.html">arrow::adapters</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1adapters_1_1orc"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1adapters_1_1orc.html">arrow::adapters::orc</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.14 +</small></address> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/a6214c73/docs/cpp/adapter_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/adapter_8h_source.html b/docs/cpp/adapter_8h_source.html new file mode 100644 index 0000000..2194b1a --- /dev/null +++ b/docs/cpp/adapter_8h_source.html @@ -0,0 +1,91 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml";> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /apache-arrow/arrow/cpp/src/arrow/adapters/orc/adapter.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_280217092a2d22f888c6591dfff78c57.html">adapters</a></li><li class="navelem"><a class="el" href="dir_1b858e9799a28845385d815f228929e5.html">orc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">adapter.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="adapter_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a><span class ="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software distributed u nder the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef ARROW_ORC_CONVERTER_H</span></div><div class="line"><a name="l00019"></a><span class="lineno "> 19</span> <span class="preprocessor">#define ARROW_ORC_CONVERTER_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#incl ude "<a class="code" href="memory__pool_8h.html">arrow/memory_pool.h</a>"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="record__batch_8h.html">arrow/record_batch.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="status_8h.html">arrow/status.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "<a class="code" href="type_8h.html">arrow/type.h</a>"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "<a class="code" href="visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="lin e"><a name="l00032"></a><span class="lineno"><a class="line" href="namespacearrow.html"> 32</a></span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="namespacearrow_1_1adapters.html"> 34</a></span> <span class="keyword">namespace </span>adapters {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="namespacearrow_1_1adapters_1_1orc.html"> 36</a></span> <span class="keyword">namespace </span>orc {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html"> 40</a>< /span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">ORCFileReader</a> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ~<a class="code" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">ORCFileReader</a>();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::ReadableFileInterface>& file,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classarrow_1_1_memory_pool.html">Memo ryPool</a>* pool, std::unique_ptr<ORCFileReader>* reader);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadSchema(std::shared_ptr<Schema>* out);</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(std::shared_ptr<Table>* out);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(<span class="keyword">const</span> std::vector<int>& include_indices, std::shared_ptr<Table>* out);</div><div class="line"><a name=" l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadStripe(int64_t stripe, std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadStripe(int64_t stripe, <span class="keyword">const</span> std::vector<int>& include_indices,</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  int64_t NumberOfStripes();</div><div class="line"><a name="l00089"></a><span cl ass="lineno"> 89</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  int64_t NumberOfRows();</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keyword">class </span>Impl;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::unique_ptr<Impl> impl_;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">ORCFileReader</a>();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> };</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><spa n class="lineno"> 99</span> } <span class="comment">// namespace orc</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> } <span class="comment">// namespace adapters</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif // ARROW_ORC_CONVERTER_H</span></div><div class="ttc" id="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader_html"><div class="ttname"><a href="classarrow_1_1adapters_1_1orc_1_1_o_r_c_file_reader.html">arrow::adapters::orc::ORCFileReader</a></div><div class="ttdoc">Read an Arrow Table or RecordBatch from an ORC file. </div><div class="ttdef"><b>Definition:</b> adapter.h:40</div></div> +<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:106</div></div> +<div class="ttc" id="interfaces_8h_html"><div class="ttname"><a href="interfaces_8h.html">interfaces.h</a></div></div> +<div class="ttc" id="visibility_8h_html"><div class="ttname"><a href="visibility_8h.html">visibility.h</a></div></div> +<div class="ttc" id="memory__pool_8h_html"><div class="ttname"><a href="memory__pool_8h.html">memory_pool.h</a></div></div> +<div class="ttc" id="record__batch_8h_html"><div class="ttname"><a href="record__batch_8h.html">record_batch.h</a></div></div> +<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> +<div class="ttc" id="status_8h_html"><div class="ttname"><a href="status_8h.html">status.h</a></div></div> +<div class="ttc" id="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:34</div></div> +<div class="ttc" id="type_8h_html"><div class="ttname"><a href="type_8h.html">type.h</a></div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html";> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.14 +</small></address> +</body> +</html>
