blob: 4811c7b6ae8624917ede7728fe40d22f5c4bd8c8 [file] [log] [blame]
<!--
SPDX-FileCopyrightText: The Apache Software Foundation
SPDX-License-Identifier: Apache-2.0
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Arrow.Table</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:title" content="Arrow.Table"/>
<meta property="og:description" content="Reference for Arrow.Table"/>
<meta name="twitter:title" content="Arrow.Table"/>
<meta name="twitter:description" content="Reference for Arrow.Table"/>
<meta name="twitter:card" content="summary"/>
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">Arrow</a></h3>
<p>API Version: 1.0</p>
<p>Library Version: 22.0.0.dev</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.Table.html#description">Table</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.Table.new_arrays.html">new_arrays</a>
<a class="ctor" href="ctor.Table.new_chunked_arrays.html">new_chunked_arrays</a>
<a class="ctor" href="ctor.Table.new_record_batches.html">new_record_batches</a>
<a class="ctor" href="ctor.Table.new_values.html">new_values</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.Table.add_column.html">add_column</a>
<a class="method" href="method.Table.combine_chunks.html">combine_chunks</a>
<a class="method" href="method.Table.concatenate.html">concatenate</a>
<a class="method" href="method.Table.equal.html">equal</a>
<a class="method" href="method.Table.equal_metadata.html">equal_metadata</a>
<a class="method" href="method.Table.filter.html">filter</a>
<a class="method" href="method.Table.filter_chunked_array.html">filter_chunked_array</a>
<a class="method" href="method.Table.get_column_data.html">get_column_data</a>
<a class="method" href="method.Table.get_n_columns.html">get_n_columns</a>
<a class="method" href="method.Table.get_n_rows.html">get_n_rows</a>
<a class="method" href="method.Table.get_schema.html">get_schema</a>
<a class="method" href="method.Table.remove_column.html">remove_column</a>
<a class="method" href="method.Table.replace_column.html">replace_column</a>
<a class="method" href="method.Table.slice.html">slice</a>
<a class="method" href="method.Table.sort_indices.html">sort_indices</a>
<a class="method" href="method.Table.take.html">take</a>
<a class="method" href="method.Table.take_chunked_array.html">take_chunked_array</a>
<a class="method" href="method.Table.to_string.html">to_string</a>
<a class="method" href="method.Table.validate.html">validate</a>
<a class="method" href="method.Table.validate_full.html">validate_full</a>
<a class="method" href="method.Table.write_as_feather.html">write_as_feather</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.Table.table.html">table</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.1</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">Arrow</a><span class="sep" role="presentation"></span>Table</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
</h4>
<pre><code>class Arrow.Table : GObject.Object {
parent_instance: GObject
}</pre></code>
<div class="docblock">
No description available.
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper constructors">
<h4 id="constructors">
Constructors
<a href="#constructors" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="ctor.Table.new_arrays.html">garrow_table_new_arrays</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.12.0</span></p>
</div>
</div>
<div class="">
<h6><a href="ctor.Table.new_chunked_arrays.html">garrow_table_new_chunked_arrays</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="ctor.Table.new_record_batches.html">garrow_table_new_record_batches</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.12.0</span></p>
</div>
</div>
<div class="">
<h6><a href="ctor.Table.new_values.html">garrow_table_new_values</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.12.0</span></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.Table.add_column.html">garrow_table_add_column</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.combine_chunks.html">garrow_table_combine_chunks</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.16.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.concatenate.html">garrow_table_concatenate</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.14.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.equal.html">garrow_table_equal</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.4.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.equal_metadata.html">garrow_table_equal_metadata</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.17.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.filter.html">garrow_table_filter</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.filter_chunked_array.html">garrow_table_filter_chunked_array</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.get_column_data.html">garrow_table_get_column_data</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.get_n_columns.html">garrow_table_get_n_columns</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.get_n_rows.html">garrow_table_get_n_rows</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.get_schema.html">garrow_table_get_schema</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.remove_column.html">garrow_table_remove_column</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.3.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.replace_column.html">garrow_table_replace_column</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.15.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.slice.html">garrow_table_slice</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.14.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.sort_indices.html">garrow_table_sort_indices</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 3.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.take.html">garrow_table_take</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.16.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.take_chunked_array.html">garrow_table_take_chunked_array</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.16.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.to_string.html">garrow_table_to_string</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.12.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.validate.html">garrow_table_validate</a></h6>
<div class="docblock">
<p>Validate the given table. This is a cheap&nbsp;validation.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 20.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.validate_full.html">garrow_table_validate_full</a></h6>
<div class="docblock">
<p>Validate the given table. This is an extensive&nbsp;validation.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 20.0.0</span></p>
</div>
</div>
<div class="">
<h6><a href="method.Table.write_as_feather.html">garrow_table_write_as_feather</a></h6>
<div class="docblock">
<p>Writes the <code>table</code> as Feather format data to the <code>sink</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.17.0</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.Table.table.html">Arrow.Table:table</a></h6>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>The notify signal is emitted on an object when one of its properties has
its value set through g_object_set_property(), g_object_set(), et&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ArrowTableClass {
GObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GObjectClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#constructors"><span class="link-text">Constructors</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>