blob: 425fbc024ca8627fcc628acde01479a39eb3592b [file]
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Arrays and Scalars &mdash; Apache Arrow v2.0.0</title>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<link rel="canonical" href="https://arrow.apache.org/docs/python/api/arrays.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="pyarrow.array" href="../generated/pyarrow.array.html" />
<link rel="prev" title="pyarrow.types.is_dictionary" href="../generated/pyarrow.types.is_dictionary.html" />
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(["setDoNotTrack", true]);
_paq.push(["disableCookies"]);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '20']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> Apache Arrow
</a>
<div class="version">
2.0.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Specifications and Protocols</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../format/Versioning.html">Format Versioning and Stability</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Columnar.html">Arrow Columnar Format</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Flight.html">Arrow Flight RPC</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Integration.html">Integration Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/CDataInterface.html">The Arrow C data interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/CStreamInterface.html">The Arrow C stream interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../format/Other.html">Other Data Structures</a></li>
</ul>
<p class="caption"><span class="caption-text">Libraries</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../status.html">Implementation Status</a></li>
<li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/c_glib/">C/GLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cpp/index.html">C++</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/csharp/README.md">C#</a></li>
<li class="toctree-l1"><a class="reference external" href="https://godoc.org/github.com/apache/arrow/go/arrow">Go</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../java/index.html">Java</a></li>
<li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/js/">JavaScript</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/matlab/README.md">MATLAB</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Python</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../install.html">Installing PyArrow</a></li>
<li class="toctree-l2"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li>
<li class="toctree-l2"><a class="reference internal" href="../data.html">Data Types and In-Memory Data Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="../compute.html">Compute Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="../ipc.html">Streaming, Serialization, and IPC</a></li>
<li class="toctree-l2"><a class="reference internal" href="../filesystems.html">Filesystem Interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="../filesystems_deprecated.html">Filesystem Interface (legacy)</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plasma.html">The Plasma In-Memory Object Store</a></li>
<li class="toctree-l2"><a class="reference internal" href="../numpy.html">NumPy Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../pandas.html">Pandas Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../timestamps.html">Timestamps</a></li>
<li class="toctree-l2"><a class="reference internal" href="../csv.html">Reading CSV files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../feather.html">Feather File Format</a></li>
<li class="toctree-l2"><a class="reference internal" href="../json.html">Reading JSON files</a></li>
<li class="toctree-l2"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li>
<li class="toctree-l2"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../cuda.html">CUDA Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extending_types.html">Extending pyarrow</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extending.html">Using pyarrow from C++ and Cython Code</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="datatypes.html">Data Types and Schemas</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Arrays and Scalars</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#factory-functions">Factory Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="#array-types">Array Types</a></li>
<li class="toctree-l4"><a class="reference internal" href="#scalars">Scalars</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="memory.html">Buffers and Memory</a></li>
<li class="toctree-l3"><a class="reference internal" href="compute.html">Compute Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="files.html">Streams and File Access</a></li>
<li class="toctree-l3"><a class="reference internal" href="tables.html">Tables and Tensors</a></li>
<li class="toctree-l3"><a class="reference internal" href="ipc.html">Serialization and IPC</a></li>
<li class="toctree-l3"><a class="reference internal" href="flight.html">Arrow Flight</a></li>
<li class="toctree-l3"><a class="reference internal" href="formats.html">Tabular File Formats</a></li>
<li class="toctree-l3"><a class="reference internal" href="filesystems.html">Filesystems</a></li>
<li class="toctree-l3"><a class="reference internal" href="dataset.html">Dataset</a></li>
<li class="toctree-l3"><a class="reference internal" href="plasma.html">Plasma In-Memory Object Store</a></li>
<li class="toctree-l3"><a class="reference internal" href="cuda.html">CUDA Integration</a></li>
<li class="toctree-l3"><a class="reference internal" href="misc.html">Miscellaneous</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li>
<li class="toctree-l2"><a class="reference internal" href="../benchmarks.html">Benchmarks</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/docs/r/">R</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/apache/arrow/blob/master/ruby/README.md">Ruby</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.rs/crate/arrow/">Rust</a></li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../developers/contributing.html">Contributing to Apache Arrow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/cpp/index.html">C++ Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/python.html">Python Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/archery.html">Daily Development using Archery</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/crossbow.html">Packaging and Testing with Crossbow</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/docker.html">Running Docker Builds</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../developers/documentation.html">Building the Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Apache Arrow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../index.html">Python bindings</a> &raquo;</li>
<li><a href="../api.html">API Reference</a> &raquo;</li>
<li>Arrays and Scalars</li>
<li class="wy-breadcrumbs-aside">
<a href="../../_sources/python/api/arrays.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="arrays-and-scalars">
<span id="api-array"></span><h1>Arrays and Scalars<a class="headerlink" href="#arrays-and-scalars" title="Permalink to this headline">¶</a></h1>
<div class="section" id="factory-functions">
<h2>Factory Functions<a class="headerlink" href="#factory-functions" title="Permalink to this headline">¶</a></h2>
<p>These functions create new Arrow arrays:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.array.html#pyarrow.array" title="pyarrow.array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a>(obj[, type, mask, size, from_pandas])</p></td>
<td><p>Create pyarrow.Array instance from a Python object.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.nulls.html#pyarrow.nulls" title="pyarrow.nulls"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nulls</span></code></a>(size[, type])</p></td>
<td><p>Create a strongly-typed Array instance with all elements null.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="array-types">
<h2>Array Types<a class="headerlink" href="#array-types" title="Permalink to this headline">¶</a></h2>
<p>An array’s Python class depends on its data type. Concrete array classes
may expose data type-specific methods or properties.</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a>()</p></td>
<td><p>The base class for all Arrow arrays.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.BooleanArray.html#pyarrow.BooleanArray" title="pyarrow.BooleanArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BooleanArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of boolean data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.FloatingPointArray.html#pyarrow.FloatingPointArray" title="pyarrow.FloatingPointArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FloatingPointArray</span></code></a></p></td>
<td><p>A base class for Arrow floating-point arrays.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.IntegerArray.html#pyarrow.IntegerArray" title="pyarrow.IntegerArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">IntegerArray</span></code></a></p></td>
<td><p>A base class for Arrow integer arrays.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Int8Array.html#pyarrow.Int8Array" title="pyarrow.Int8Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int8Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of int8 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Int16Array.html#pyarrow.Int16Array" title="pyarrow.Int16Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int16Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of int16 data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Int32Array.html#pyarrow.Int32Array" title="pyarrow.Int32Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int32Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of int32 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Int64Array.html#pyarrow.Int64Array" title="pyarrow.Int64Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int64Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of int64 data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.NullArray.html#pyarrow.NullArray" title="pyarrow.NullArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NullArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of null data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.NumericArray.html#pyarrow.NumericArray" title="pyarrow.NumericArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NumericArray</span></code></a></p></td>
<td><p>A base class for Arrow numeric arrays.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.UInt8Array.html#pyarrow.UInt8Array" title="pyarrow.UInt8Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt8Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of uint8 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.UInt16Array.html#pyarrow.UInt16Array" title="pyarrow.UInt16Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt16Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of uint16 data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.UInt32Array.html#pyarrow.UInt32Array" title="pyarrow.UInt32Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt32Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of uint32 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.UInt64Array.html#pyarrow.UInt64Array" title="pyarrow.UInt64Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt64Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of uint64 data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.BinaryArray.html#pyarrow.BinaryArray" title="pyarrow.BinaryArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BinaryArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of variable-sized binary data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.StringArray.html#pyarrow.StringArray" title="pyarrow.StringArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StringArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of string (or utf8) data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.FixedSizeBinaryArray.html#pyarrow.FixedSizeBinaryArray" title="pyarrow.FixedSizeBinaryArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FixedSizeBinaryArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of a fixed-size binary data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.LargeBinaryArray.html#pyarrow.LargeBinaryArray" title="pyarrow.LargeBinaryArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LargeBinaryArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of large variable-sized binary data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.LargeStringArray.html#pyarrow.LargeStringArray" title="pyarrow.LargeStringArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LargeStringArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of large string (or utf8) data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Time32Array.html#pyarrow.Time32Array" title="pyarrow.Time32Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time32Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of time32 data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Time64Array.html#pyarrow.Time64Array" title="pyarrow.Time64Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time64Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of time64 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Date32Array.html#pyarrow.Date32Array" title="pyarrow.Date32Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Date32Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of date32 data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Date64Array.html#pyarrow.Date64Array" title="pyarrow.Date64Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Date64Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of date64 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.TimestampArray.html#pyarrow.TimestampArray" title="pyarrow.TimestampArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TimestampArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of timestamp data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Decimal128Array.html#pyarrow.Decimal128Array" title="pyarrow.Decimal128Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Decimal128Array</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of decimal128 data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.DictionaryArray.html#pyarrow.DictionaryArray" title="pyarrow.DictionaryArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DictionaryArray</span></code></a></p></td>
<td><p>Concrete class for dictionary-encoded Arrow arrays.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.ListArray.html#pyarrow.ListArray" title="pyarrow.ListArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ListArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of a list data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.LargeListArray.html#pyarrow.LargeListArray" title="pyarrow.LargeListArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LargeListArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of a large list data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.StructArray.html#pyarrow.StructArray" title="pyarrow.StructArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StructArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of a struct data type.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.UnionArray.html#pyarrow.UnionArray" title="pyarrow.UnionArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnionArray</span></code></a></p></td>
<td><p>Concrete class for Arrow arrays of a Union data type.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.ExtensionArray.html#pyarrow.ExtensionArray" title="pyarrow.ExtensionArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ExtensionArray</span></code></a></p></td>
<td><p>Concrete class for Arrow extension arrays.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="scalars">
<span id="api-scalar"></span><h2>Scalars<a class="headerlink" href="#scalars" title="Permalink to this headline">¶</a></h2>
<p>This function constructs a new Arrow scalar:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.scalar.html#pyarrow.scalar" title="pyarrow.scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scalar</span></code></a>(value[, type, from_pandas])</p></td>
<td><p>Create a pyarrow.Scalar instance from a Python object.</p></td>
</tr>
</tbody>
</table>
<p>A scalar’s python class depends on its data type. Concrete scalar
classes may expose data type-specific methods or properties.</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.NA.html#pyarrow.NA" title="pyarrow.NA"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NA</span></code></a></p></td>
<td><p>NullScalar()</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Scalar.html#pyarrow.Scalar" title="pyarrow.Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scalar</span></code></a>()</p></td>
<td><p>The base class for scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.BooleanScalar.html#pyarrow.BooleanScalar" title="pyarrow.BooleanScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BooleanScalar</span></code></a></p></td>
<td><p>Concrete class for boolean scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Int8Scalar.html#pyarrow.Int8Scalar" title="pyarrow.Int8Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int8Scalar</span></code></a></p></td>
<td><p>Concrete class for int8 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Int16Scalar.html#pyarrow.Int16Scalar" title="pyarrow.Int16Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int16Scalar</span></code></a></p></td>
<td><p>Concrete class for int16 scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Int32Scalar.html#pyarrow.Int32Scalar" title="pyarrow.Int32Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int32Scalar</span></code></a></p></td>
<td><p>Concrete class for int32 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Int64Scalar.html#pyarrow.Int64Scalar" title="pyarrow.Int64Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int64Scalar</span></code></a></p></td>
<td><p>Concrete class for int64 scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.UInt8Scalar.html#pyarrow.UInt8Scalar" title="pyarrow.UInt8Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt8Scalar</span></code></a></p></td>
<td><p>Concrete class for uint8 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.UInt16Scalar.html#pyarrow.UInt16Scalar" title="pyarrow.UInt16Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt16Scalar</span></code></a></p></td>
<td><p>Concrete class for uint16 scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.UInt32Scalar.html#pyarrow.UInt32Scalar" title="pyarrow.UInt32Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt32Scalar</span></code></a></p></td>
<td><p>Concrete class for uint32 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.UInt64Scalar.html#pyarrow.UInt64Scalar" title="pyarrow.UInt64Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UInt64Scalar</span></code></a></p></td>
<td><p>Concrete class for uint64 scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.FloatScalar.html#pyarrow.FloatScalar" title="pyarrow.FloatScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FloatScalar</span></code></a></p></td>
<td><p>Concrete class for float scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.DoubleScalar.html#pyarrow.DoubleScalar" title="pyarrow.DoubleScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DoubleScalar</span></code></a></p></td>
<td><p>Concrete class for double scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.BinaryScalar.html#pyarrow.BinaryScalar" title="pyarrow.BinaryScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BinaryScalar</span></code></a></p></td>
<td><p>Concrete class for binary-like scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.StringScalar.html#pyarrow.StringScalar" title="pyarrow.StringScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StringScalar</span></code></a></p></td>
<td><p>Concrete class for string-like (utf8) scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.FixedSizeBinaryScalar.html#pyarrow.FixedSizeBinaryScalar" title="pyarrow.FixedSizeBinaryScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FixedSizeBinaryScalar</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.LargeBinaryScalar.html#pyarrow.LargeBinaryScalar" title="pyarrow.LargeBinaryScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LargeBinaryScalar</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.LargeStringScalar.html#pyarrow.LargeStringScalar" title="pyarrow.LargeStringScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LargeStringScalar</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Time32Scalar.html#pyarrow.Time32Scalar" title="pyarrow.Time32Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time32Scalar</span></code></a></p></td>
<td><p>Concrete class for time32 scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Time64Scalar.html#pyarrow.Time64Scalar" title="pyarrow.Time64Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time64Scalar</span></code></a></p></td>
<td><p>Concrete class for time64 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.Date32Scalar.html#pyarrow.Date32Scalar" title="pyarrow.Date32Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Date32Scalar</span></code></a></p></td>
<td><p>Concrete class for date32 scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Date64Scalar.html#pyarrow.Date64Scalar" title="pyarrow.Date64Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Date64Scalar</span></code></a></p></td>
<td><p>Concrete class for date64 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.TimestampScalar.html#pyarrow.TimestampScalar" title="pyarrow.TimestampScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TimestampScalar</span></code></a></p></td>
<td><p>Concrete class for timestamp scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.Decimal128Scalar.html#pyarrow.Decimal128Scalar" title="pyarrow.Decimal128Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Decimal128Scalar</span></code></a></p></td>
<td><p>Concrete class for decimal128 scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.DictionaryScalar.html#pyarrow.DictionaryScalar" title="pyarrow.DictionaryScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DictionaryScalar</span></code></a></p></td>
<td><p>Concrete class for dictionary-encoded scalars.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.ListScalar.html#pyarrow.ListScalar" title="pyarrow.ListScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ListScalar</span></code></a></p></td>
<td><p>Concrete class for list-like scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.LargeListScalar.html#pyarrow.LargeListScalar" title="pyarrow.LargeListScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LargeListScalar</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../generated/pyarrow.StructScalar.html#pyarrow.StructScalar" title="pyarrow.StructScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StructScalar</span></code></a></p></td>
<td><p>Concrete class for struct scalars.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../generated/pyarrow.UnionScalar.html#pyarrow.UnionScalar" title="pyarrow.UnionScalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UnionScalar</span></code></a></p></td>
<td><p>Concrete class for Union scalars.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../generated/pyarrow.array.html" class="btn btn-neutral float-right" title="pyarrow.array" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../generated/pyarrow.types.is_dictionary.html" class="btn btn-neutral float-left" title="pyarrow.types.is_dictionary" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016-2019 Apache Software Foundation
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script type="text/javascript" src="/docs/_static/versionwarning.js"></script></body>
</html>