| |
| |
| <!DOCTYPE html> |
| |
| |
| <html lang="en" data-content_root="" > |
| |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
| |
| <title>pyarrow.DictionaryArray — Apache Arrow v17.0.0.dev52</title> |
| |
| |
| |
| <script data-cfasync="false"> |
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; |
| document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; |
| </script> |
| |
| <!-- Loaded before other Sphinx assets --> |
| <link href="../../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| |
| |
| <link href="../../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" /> |
| |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css" /> |
| |
| <!-- Pre-loaded scripts that we'll load fully later --> |
| <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" /> |
| <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" /> |
| <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script src="../../_static/design-tabs.js"></script> |
| <script>DOCUMENTATION_OPTIONS.pagename = 'python/generated/pyarrow.DictionaryArray';</script> |
| <script> |
| DOCUMENTATION_OPTIONS.theme_version = '0.15.2'; |
| DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json'; |
| DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/'; |
| DOCUMENTATION_OPTIONS.show_version_warning_banner = true; |
| </script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/python/generated/pyarrow.DictionaryArray.html" /> |
| <link rel="icon" href="../../_static/favicon.ico"/> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="pyarrow.ListArray" href="pyarrow.ListArray.html" /> |
| <link rel="prev" title="pyarrow.Decimal128Array" href="pyarrow.Decimal128Array.html" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _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 data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i> |
| Back to top |
| </button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__primary" |
| id="__primary"/> |
| <label class="overlay overlay-primary" for="__primary"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__secondary" |
| id="__secondary"/> |
| <label class="overlay overlay-secondary" for="__secondary"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="../../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar"> |
| <div class="bd-header__inner bd-page-width"> |
| <label class="sidebar-toggle primary-toggle" for="__primary"> |
| <span class="fa-solid fa-bars"></span> |
| </label> |
| |
| |
| <div class="col-lg-3 navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| <a class="navbar-brand logo" href="../../index.html"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <img src="../../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/> |
| <script>document.write(`<img src="../../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script> |
| |
| |
| </a></div> |
| |
| </div> |
| |
| <div class="col-lg-9 navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../cpp/index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-2" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-2" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-2" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-2"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| |
| <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0"> |
| <span class="fa-solid fa-outdent"></span> |
| </label> |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../cpp/index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-3" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-3" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-3" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-3"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item"> |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav"> |
| <li class="toctree-l1"><a class="reference internal" href="../install.html">Installing PyArrow</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../getstarted.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../data.html">Data Types and In-Memory Data Model</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../compute.html">Compute Functions</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../memory.html">Memory and IO Interfaces</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../ipc.html">Streaming, Serialization, and IPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../filesystems.html">Filesystem Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../numpy.html">NumPy Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../pandas.html">Pandas Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../interchange_protocol.html">Dataframe Interchange Protocol</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../dlpack.html">The DLPack Protocol</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../timestamps.html">Timestamps</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../orc.html">Reading and Writing the Apache ORC Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../csv.html">Reading and Writing CSV files</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../feather.html">Feather File Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../json.html">Reading JSON files</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../parquet.html">Reading and Writing the Apache Parquet Format</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../extending_types.html">Extending pyarrow</a></li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../integration.html">PyArrow Integrations</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../integration/python_r.html">Integrating PyArrow with R</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../integration/python_java.html">Integrating PyArrow with Java</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../integration/extending.html">Using pyarrow from C++ and Cython Code</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../integration/cuda.html">CUDA Integration</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../env_vars.html">Environment Variables</a></li> |
| <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/datatypes.html">Data Types and Schemas</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.null.html">pyarrow.null</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.bool_.html">pyarrow.bool_</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.int8.html">pyarrow.int8</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.int16.html">pyarrow.int16</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.int32.html">pyarrow.int32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.int64.html">pyarrow.int64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.uint8.html">pyarrow.uint8</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.uint16.html">pyarrow.uint16</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.uint32.html">pyarrow.uint32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.uint64.html">pyarrow.uint64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.float16.html">pyarrow.float16</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.float32.html">pyarrow.float32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.float64.html">pyarrow.float64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.time32.html">pyarrow.time32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.time64.html">pyarrow.time64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.timestamp.html">pyarrow.timestamp</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.date32.html">pyarrow.date32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.date64.html">pyarrow.date64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.duration.html">pyarrow.duration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.month_day_nano_interval.html">pyarrow.month_day_nano_interval</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.binary.html">pyarrow.binary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.string.html">pyarrow.string</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.utf8.html">pyarrow.utf8</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.large_binary.html">pyarrow.large_binary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.large_string.html">pyarrow.large_string</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.large_utf8.html">pyarrow.large_utf8</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.binary_view.html">pyarrow.binary_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.string_view.html">pyarrow.string_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.decimal128.html">pyarrow.decimal128</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.list_.html">pyarrow.list_</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.large_list.html">pyarrow.large_list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.list_view.html">pyarrow.list_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.large_list_view.html">pyarrow.large_list_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.map_.html">pyarrow.map_</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.struct.html">pyarrow.struct</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dictionary.html">pyarrow.dictionary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.run_end_encoded.html">pyarrow.run_end_encoded</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.field.html">pyarrow.field</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.schema.html">pyarrow.schema</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.from_numpy_dtype.html">pyarrow.from_numpy_dtype</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.unify_schemas.html">pyarrow.unify_schemas</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DataType.html">pyarrow.DataType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DictionaryType.html">pyarrow.DictionaryType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ListType.html">pyarrow.ListType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MapType.html">pyarrow.MapType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.StructType.html">pyarrow.StructType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UnionType.html">pyarrow.UnionType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampType.html">pyarrow.TimestampType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Time32Type.html">pyarrow.Time32Type</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Time64Type.html">pyarrow.Time64Type</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryType.html">pyarrow.FixedSizeBinaryType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Decimal128Type.html">pyarrow.Decimal128Type</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Field.html">pyarrow.Field</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Schema.html">pyarrow.Schema</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.RunEndEncodedType.html">pyarrow.RunEndEncodedType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ExtensionType.html">pyarrow.ExtensionType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.PyExtensionType.html">pyarrow.PyExtensionType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.register_extension_type.html">pyarrow.register_extension_type</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.unregister_extension_type.html">pyarrow.unregister_extension_type</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_boolean.html">pyarrow.types.is_boolean</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_integer.html">pyarrow.types.is_integer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_signed_integer.html">pyarrow.types.is_signed_integer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_unsigned_integer.html">pyarrow.types.is_unsigned_integer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_int8.html">pyarrow.types.is_int8</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_int16.html">pyarrow.types.is_int16</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_int32.html">pyarrow.types.is_int32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_int64.html">pyarrow.types.is_int64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_uint8.html">pyarrow.types.is_uint8</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_uint16.html">pyarrow.types.is_uint16</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_uint32.html">pyarrow.types.is_uint32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_uint64.html">pyarrow.types.is_uint64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_floating.html">pyarrow.types.is_floating</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_float16.html">pyarrow.types.is_float16</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_float32.html">pyarrow.types.is_float32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_float64.html">pyarrow.types.is_float64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_decimal.html">pyarrow.types.is_decimal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_decimal128.html">pyarrow.types.is_decimal128</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_decimal256.html">pyarrow.types.is_decimal256</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_list.html">pyarrow.types.is_list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_large_list.html">pyarrow.types.is_large_list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_fixed_size_list.html">pyarrow.types.is_fixed_size_list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_list_view.html">pyarrow.types.is_list_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_large_list_view.html">pyarrow.types.is_large_list_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_struct.html">pyarrow.types.is_struct</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_union.html">pyarrow.types.is_union</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_nested.html">pyarrow.types.is_nested</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_run_end_encoded.html">pyarrow.types.is_run_end_encoded</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_temporal.html">pyarrow.types.is_temporal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_timestamp.html">pyarrow.types.is_timestamp</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_date.html">pyarrow.types.is_date</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_date32.html">pyarrow.types.is_date32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_date64.html">pyarrow.types.is_date64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_time.html">pyarrow.types.is_time</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_time32.html">pyarrow.types.is_time32</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_time64.html">pyarrow.types.is_time64</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_duration.html">pyarrow.types.is_duration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_interval.html">pyarrow.types.is_interval</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_null.html">pyarrow.types.is_null</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_binary.html">pyarrow.types.is_binary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_unicode.html">pyarrow.types.is_unicode</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_string.html">pyarrow.types.is_string</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_large_binary.html">pyarrow.types.is_large_binary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_large_unicode.html">pyarrow.types.is_large_unicode</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_large_string.html">pyarrow.types.is_large_string</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_binary_view.html">pyarrow.types.is_binary_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_string_view.html">pyarrow.types.is_string_view</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_fixed_size_binary.html">pyarrow.types.is_fixed_size_binary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_map.html">pyarrow.types.is_map</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_dictionary.html">pyarrow.types.is_dictionary</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.types.is_primitive.html">pyarrow.types.is_primitive</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 current active has-children"><a class="reference internal" href="../api/arrays.html">Arrays and Scalars</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.array.html">pyarrow.array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.nulls.html">pyarrow.nulls</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Array.html">pyarrow.Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BooleanArray.html">pyarrow.BooleanArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatingPointArray.html">pyarrow.FloatingPointArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.IntegerArray.html">pyarrow.IntegerArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Array.html">pyarrow.Int8Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Array.html">pyarrow.Int16Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Array.html">pyarrow.Int32Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Array.html">pyarrow.Int64Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.NullArray.html">pyarrow.NullArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.NumericArray.html">pyarrow.NumericArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Array.html">pyarrow.UInt8Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Array.html">pyarrow.UInt16Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Array.html">pyarrow.UInt32Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Array.html">pyarrow.UInt64Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.HalfFloatArray.html">pyarrow.HalfFloatArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatArray.html">pyarrow.FloatArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DoubleArray.html">pyarrow.DoubleArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BinaryArray.html">pyarrow.BinaryArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.StringArray.html">pyarrow.StringArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryArray.html">pyarrow.FixedSizeBinaryArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeBinaryArray.html">pyarrow.LargeBinaryArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeStringArray.html">pyarrow.LargeStringArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Time32Array.html">pyarrow.Time32Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Time64Array.html">pyarrow.Time64Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Array.html">pyarrow.Date32Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Array.html">pyarrow.Date64Array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampArray.html">pyarrow.TimestampArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DurationArray.html">pyarrow.DurationArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MonthDayNanoIntervalArray.html">pyarrow.MonthDayNanoIntervalArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Decimal128Array.html">pyarrow.Decimal128Array</a></li> |
| <li class="toctree-l3 current active"><a class="current reference internal" href="#">pyarrow.DictionaryArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ListArray.html">pyarrow.ListArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeListArray.html">pyarrow.FixedSizeListArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeListArray.html">pyarrow.LargeListArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ListViewArray.html">pyarrow.ListViewArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeListViewArray.html">pyarrow.LargeListViewArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MapArray.html">pyarrow.MapArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.RunEndEncodedArray.html">pyarrow.RunEndEncodedArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.StructArray.html">pyarrow.StructArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UnionArray.html">pyarrow.UnionArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ExtensionArray.html">pyarrow.ExtensionArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedShapeTensorArray.html">pyarrow.FixedShapeTensorArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.scalar.html">pyarrow.scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.NA.html">pyarrow.NA</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Scalar.html">pyarrow.Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BooleanScalar.html">pyarrow.BooleanScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int8Scalar.html">pyarrow.Int8Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int16Scalar.html">pyarrow.Int16Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int32Scalar.html">pyarrow.Int32Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Int64Scalar.html">pyarrow.Int64Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt8Scalar.html">pyarrow.UInt8Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt16Scalar.html">pyarrow.UInt16Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt32Scalar.html">pyarrow.UInt32Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UInt64Scalar.html">pyarrow.UInt64Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.HalfFloatScalar.html">pyarrow.HalfFloatScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FloatScalar.html">pyarrow.FloatScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DoubleScalar.html">pyarrow.DoubleScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BinaryScalar.html">pyarrow.BinaryScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.StringScalar.html">pyarrow.StringScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBinaryScalar.html">pyarrow.FixedSizeBinaryScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeBinaryScalar.html">pyarrow.LargeBinaryScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeStringScalar.html">pyarrow.LargeStringScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BinaryViewScalar.html">pyarrow.BinaryViewScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.StringViewScalar.html">pyarrow.StringViewScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Time32Scalar.html">pyarrow.Time32Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Time64Scalar.html">pyarrow.Time64Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Date32Scalar.html">pyarrow.Date32Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Date64Scalar.html">pyarrow.Date64Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.TimestampScalar.html">pyarrow.TimestampScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DurationScalar.html">pyarrow.DurationScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MonthDayNanoIntervalScalar.html">pyarrow.MonthDayNanoIntervalScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Decimal128Scalar.html">pyarrow.Decimal128Scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.DictionaryScalar.html">pyarrow.DictionaryScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.RunEndEncodedScalar.html">pyarrow.RunEndEncodedScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ListScalar.html">pyarrow.ListScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeListScalar.html">pyarrow.LargeListScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ListViewScalar.html">pyarrow.ListViewScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.LargeListViewScalar.html">pyarrow.LargeListViewScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MapScalar.html">pyarrow.MapScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.StructScalar.html">pyarrow.StructScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.UnionScalar.html">pyarrow.UnionScalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ExtensionScalar.html">pyarrow.ExtensionScalar</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/memory.html">Buffers and Memory</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.allocate_buffer.html">pyarrow.allocate_buffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.py_buffer.html">pyarrow.py_buffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.foreign_buffer.html">pyarrow.foreign_buffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Buffer.html">pyarrow.Buffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ResizableBuffer.html">pyarrow.ResizableBuffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Codec.html">pyarrow.Codec</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compress.html">pyarrow.compress</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.decompress.html">pyarrow.decompress</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MemoryPool.html">pyarrow.MemoryPool</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.default_memory_pool.html">pyarrow.default_memory_pool</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.jemalloc_memory_pool.html">pyarrow.jemalloc_memory_pool</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.mimalloc_memory_pool.html">pyarrow.mimalloc_memory_pool</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.system_memory_pool.html">pyarrow.system_memory_pool</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.jemalloc_set_decay_ms.html">pyarrow.jemalloc_set_decay_ms</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.set_memory_pool.html">pyarrow.set_memory_pool</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.log_memory_allocations.html">pyarrow.log_memory_allocations</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.total_allocated_bytes.html">pyarrow.total_allocated_bytes</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/tables.html">Tables and Tensors</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.chunked_array.html">pyarrow.chunked_array</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.concat_arrays.html">pyarrow.concat_arrays</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.concat_tables.html">pyarrow.concat_tables</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.record_batch.html">pyarrow.record_batch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.table.html">pyarrow.table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ChunkedArray.html">pyarrow.ChunkedArray</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.RecordBatch.html">pyarrow.RecordBatch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Table.html">pyarrow.Table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.TableGroupBy.html">pyarrow.TableGroupBy</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.RecordBatchReader.html">pyarrow.RecordBatchReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.interchange.from_dataframe.html">pyarrow.interchange.from_dataframe</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.Tensor.html">pyarrow.Tensor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/compute.html">Compute Functions</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-7"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.all.html">pyarrow.compute.all</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.any.html">pyarrow.compute.any</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.approximate_median.html">pyarrow.compute.approximate_median</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.count.html">pyarrow.compute.count</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.count_distinct.html">pyarrow.compute.count_distinct</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.index.html">pyarrow.compute.index</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.max.html">pyarrow.compute.max</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.mean.html">pyarrow.compute.mean</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.min.html">pyarrow.compute.min</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.min_max.html">pyarrow.compute.min_max</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.mode.html">pyarrow.compute.mode</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.product.html">pyarrow.compute.product</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.quantile.html">pyarrow.compute.quantile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.stddev.html">pyarrow.compute.stddev</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sum.html">pyarrow.compute.sum</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.tdigest.html">pyarrow.compute.tdigest</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.variance.html">pyarrow.compute.variance</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cumulative_sum.html">pyarrow.compute.cumulative_sum</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cumulative_sum_checked.html">pyarrow.compute.cumulative_sum_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cumulative_prod.html">pyarrow.compute.cumulative_prod</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cumulative_prod_checked.html">pyarrow.compute.cumulative_prod_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cumulative_max.html">pyarrow.compute.cumulative_max</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cumulative_min.html">pyarrow.compute.cumulative_min</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.abs.html">pyarrow.compute.abs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.abs_checked.html">pyarrow.compute.abs_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.add.html">pyarrow.compute.add</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.add_checked.html">pyarrow.compute.add_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.divide.html">pyarrow.compute.divide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.divide_checked.html">pyarrow.compute.divide_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.multiply.html">pyarrow.compute.multiply</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.multiply_checked.html">pyarrow.compute.multiply_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.negate.html">pyarrow.compute.negate</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.negate_checked.html">pyarrow.compute.negate_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.power.html">pyarrow.compute.power</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.power_checked.html">pyarrow.compute.power_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sign.html">pyarrow.compute.sign</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sqrt.html">pyarrow.compute.sqrt</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sqrt_checked.html">pyarrow.compute.sqrt_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.subtract.html">pyarrow.compute.subtract</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.subtract_checked.html">pyarrow.compute.subtract_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.bit_wise_and.html">pyarrow.compute.bit_wise_and</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.bit_wise_not.html">pyarrow.compute.bit_wise_not</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.bit_wise_or.html">pyarrow.compute.bit_wise_or</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.bit_wise_xor.html">pyarrow.compute.bit_wise_xor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.shift_left.html">pyarrow.compute.shift_left</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.shift_left_checked.html">pyarrow.compute.shift_left_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.shift_right.html">pyarrow.compute.shift_right</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.shift_right_checked.html">pyarrow.compute.shift_right_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ceil.html">pyarrow.compute.ceil</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.floor.html">pyarrow.compute.floor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.round.html">pyarrow.compute.round</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.round_to_multiple.html">pyarrow.compute.round_to_multiple</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.trunc.html">pyarrow.compute.trunc</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ln.html">pyarrow.compute.ln</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ln_checked.html">pyarrow.compute.ln_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.log10.html">pyarrow.compute.log10</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.log10_checked.html">pyarrow.compute.log10_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.log1p.html">pyarrow.compute.log1p</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.log1p_checked.html">pyarrow.compute.log1p_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.log2.html">pyarrow.compute.log2</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.log2_checked.html">pyarrow.compute.log2_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.logb.html">pyarrow.compute.logb</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.logb_checked.html">pyarrow.compute.logb_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.acos.html">pyarrow.compute.acos</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.acos_checked.html">pyarrow.compute.acos_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.asin.html">pyarrow.compute.asin</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.asin_checked.html">pyarrow.compute.asin_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.atan.html">pyarrow.compute.atan</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.atan2.html">pyarrow.compute.atan2</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cos.html">pyarrow.compute.cos</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cos_checked.html">pyarrow.compute.cos_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sin.html">pyarrow.compute.sin</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sin_checked.html">pyarrow.compute.sin_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.tan.html">pyarrow.compute.tan</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.tan_checked.html">pyarrow.compute.tan_checked</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.equal.html">pyarrow.compute.equal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.greater.html">pyarrow.compute.greater</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.greater_equal.html">pyarrow.compute.greater_equal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.less.html">pyarrow.compute.less</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.less_equal.html">pyarrow.compute.less_equal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.not_equal.html">pyarrow.compute.not_equal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.max_element_wise.html">pyarrow.compute.max_element_wise</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.min_element_wise.html">pyarrow.compute.min_element_wise</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.and_.html">pyarrow.compute.and_</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.and_kleene.html">pyarrow.compute.and_kleene</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.and_not.html">pyarrow.compute.and_not</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.and_not_kleene.html">pyarrow.compute.and_not_kleene</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.invert.html">pyarrow.compute.invert</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.or_.html">pyarrow.compute.or_</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.or_kleene.html">pyarrow.compute.or_kleene</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.xor.html">pyarrow.compute.xor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_alnum.html">pyarrow.compute.ascii_is_alnum</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_alpha.html">pyarrow.compute.ascii_is_alpha</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_decimal.html">pyarrow.compute.ascii_is_decimal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_lower.html">pyarrow.compute.ascii_is_lower</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_printable.html">pyarrow.compute.ascii_is_printable</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_space.html">pyarrow.compute.ascii_is_space</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_upper.html">pyarrow.compute.ascii_is_upper</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_alnum.html">pyarrow.compute.utf8_is_alnum</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_alpha.html">pyarrow.compute.utf8_is_alpha</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_decimal.html">pyarrow.compute.utf8_is_decimal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_digit.html">pyarrow.compute.utf8_is_digit</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_lower.html">pyarrow.compute.utf8_is_lower</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_numeric.html">pyarrow.compute.utf8_is_numeric</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_printable.html">pyarrow.compute.utf8_is_printable</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_space.html">pyarrow.compute.utf8_is_space</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_upper.html">pyarrow.compute.utf8_is_upper</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_is_title.html">pyarrow.compute.ascii_is_title</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_is_title.html">pyarrow.compute.utf8_is_title</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.string_is_ascii.html">pyarrow.compute.string_is_ascii</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_capitalize.html">pyarrow.compute.ascii_capitalize</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_lower.html">pyarrow.compute.ascii_lower</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_reverse.html">pyarrow.compute.ascii_reverse</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_swapcase.html">pyarrow.compute.ascii_swapcase</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_title.html">pyarrow.compute.ascii_title</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_upper.html">pyarrow.compute.ascii_upper</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_length.html">pyarrow.compute.binary_length</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_repeat.html">pyarrow.compute.binary_repeat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_replace_slice.html">pyarrow.compute.binary_replace_slice</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_reverse.html">pyarrow.compute.binary_reverse</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.replace_substring.html">pyarrow.compute.replace_substring</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.replace_substring_regex.html">pyarrow.compute.replace_substring_regex</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_capitalize.html">pyarrow.compute.utf8_capitalize</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_length.html">pyarrow.compute.utf8_length</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_lower.html">pyarrow.compute.utf8_lower</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_replace_slice.html">pyarrow.compute.utf8_replace_slice</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_reverse.html">pyarrow.compute.utf8_reverse</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_swapcase.html">pyarrow.compute.utf8_swapcase</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_title.html">pyarrow.compute.utf8_title</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_upper.html">pyarrow.compute.utf8_upper</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_center.html">pyarrow.compute.ascii_center</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_lpad.html">pyarrow.compute.ascii_lpad</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_rpad.html">pyarrow.compute.ascii_rpad</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_center.html">pyarrow.compute.utf8_center</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_lpad.html">pyarrow.compute.utf8_lpad</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_rpad.html">pyarrow.compute.utf8_rpad</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_ltrim.html">pyarrow.compute.ascii_ltrim</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_ltrim_whitespace.html">pyarrow.compute.ascii_ltrim_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_rtrim.html">pyarrow.compute.ascii_rtrim</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_rtrim_whitespace.html">pyarrow.compute.ascii_rtrim_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_trim.html">pyarrow.compute.ascii_trim</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_trim_whitespace.html">pyarrow.compute.ascii_trim_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_ltrim.html">pyarrow.compute.utf8_ltrim</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_ltrim_whitespace.html">pyarrow.compute.utf8_ltrim_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_rtrim.html">pyarrow.compute.utf8_rtrim</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_rtrim_whitespace.html">pyarrow.compute.utf8_rtrim_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_trim.html">pyarrow.compute.utf8_trim</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_trim_whitespace.html">pyarrow.compute.utf8_trim_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ascii_split_whitespace.html">pyarrow.compute.ascii_split_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.split_pattern.html">pyarrow.compute.split_pattern</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.split_pattern_regex.html">pyarrow.compute.split_pattern_regex</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_split_whitespace.html">pyarrow.compute.utf8_split_whitespace</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.extract_regex.html">pyarrow.compute.extract_regex</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_join.html">pyarrow.compute.binary_join</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_join_element_wise.html">pyarrow.compute.binary_join_element_wise</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.binary_slice.html">pyarrow.compute.binary_slice</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.utf8_slice_codeunits.html">pyarrow.compute.utf8_slice_codeunits</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.count_substring.html">pyarrow.compute.count_substring</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.count_substring_regex.html">pyarrow.compute.count_substring_regex</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ends_with.html">pyarrow.compute.ends_with</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.find_substring.html">pyarrow.compute.find_substring</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.find_substring_regex.html">pyarrow.compute.find_substring_regex</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.index_in.html">pyarrow.compute.index_in</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_in.html">pyarrow.compute.is_in</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.match_like.html">pyarrow.compute.match_like</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.match_substring.html">pyarrow.compute.match_substring</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.match_substring_regex.html">pyarrow.compute.match_substring_regex</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.starts_with.html">pyarrow.compute.starts_with</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.indices_nonzero.html">pyarrow.compute.indices_nonzero</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_finite.html">pyarrow.compute.is_finite</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_inf.html">pyarrow.compute.is_inf</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_nan.html">pyarrow.compute.is_nan</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_null.html">pyarrow.compute.is_null</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_valid.html">pyarrow.compute.is_valid</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.true_unless_null.html">pyarrow.compute.true_unless_null</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.case_when.html">pyarrow.compute.case_when</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.choose.html">pyarrow.compute.choose</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.coalesce.html">pyarrow.compute.coalesce</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.if_else.html">pyarrow.compute.if_else</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.cast.html">pyarrow.compute.cast</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ceil_temporal.html">pyarrow.compute.ceil_temporal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.floor_temporal.html">pyarrow.compute.floor_temporal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.round_temporal.html">pyarrow.compute.round_temporal</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.run_end_decode.html">pyarrow.compute.run_end_decode</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.run_end_encode.html">pyarrow.compute.run_end_encode</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.strftime.html">pyarrow.compute.strftime</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.strptime.html">pyarrow.compute.strptime</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.day.html">pyarrow.compute.day</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.day_of_week.html">pyarrow.compute.day_of_week</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.day_of_year.html">pyarrow.compute.day_of_year</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.hour.html">pyarrow.compute.hour</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.iso_week.html">pyarrow.compute.iso_week</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.iso_year.html">pyarrow.compute.iso_year</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.iso_calendar.html">pyarrow.compute.iso_calendar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.is_leap_year.html">pyarrow.compute.is_leap_year</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.microsecond.html">pyarrow.compute.microsecond</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.millisecond.html">pyarrow.compute.millisecond</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.minute.html">pyarrow.compute.minute</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.month.html">pyarrow.compute.month</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.nanosecond.html">pyarrow.compute.nanosecond</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.quarter.html">pyarrow.compute.quarter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.second.html">pyarrow.compute.second</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.subsecond.html">pyarrow.compute.subsecond</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.us_week.html">pyarrow.compute.us_week</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.us_year.html">pyarrow.compute.us_year</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.week.html">pyarrow.compute.week</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.year.html">pyarrow.compute.year</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.year_month_day.html">pyarrow.compute.year_month_day</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.day_time_interval_between.html">pyarrow.compute.day_time_interval_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.days_between.html">pyarrow.compute.days_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.hours_between.html">pyarrow.compute.hours_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.microseconds_between.html">pyarrow.compute.microseconds_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.milliseconds_between.html">pyarrow.compute.milliseconds_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.minutes_between.html">pyarrow.compute.minutes_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.month_day_nano_interval_between.html">pyarrow.compute.month_day_nano_interval_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.month_interval_between.html">pyarrow.compute.month_interval_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.nanoseconds_between.html">pyarrow.compute.nanoseconds_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.quarters_between.html">pyarrow.compute.quarters_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.seconds_between.html">pyarrow.compute.seconds_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.weeks_between.html">pyarrow.compute.weeks_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.years_between.html">pyarrow.compute.years_between</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.assume_timezone.html">pyarrow.compute.assume_timezone</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.local_timestamp.html">pyarrow.compute.local_timestamp</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.dictionary_encode.html">pyarrow.compute.dictionary_encode</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.unique.html">pyarrow.compute.unique</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.value_counts.html">pyarrow.compute.value_counts</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.array_filter.html">pyarrow.compute.array_filter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.array_take.html">pyarrow.compute.array_take</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.drop_null.html">pyarrow.compute.drop_null</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.filter.html">pyarrow.compute.filter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.take.html">pyarrow.compute.take</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.array_sort_indices.html">pyarrow.compute.array_sort_indices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.partition_nth_indices.html">pyarrow.compute.partition_nth_indices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.select_k_unstable.html">pyarrow.compute.select_k_unstable</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.sort_indices.html">pyarrow.compute.sort_indices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.fill_null.html">pyarrow.compute.fill_null</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.fill_null_backward.html">pyarrow.compute.fill_null_backward</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.fill_null_forward.html">pyarrow.compute.fill_null_forward</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.list_element.html">pyarrow.compute.list_element</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.list_flatten.html">pyarrow.compute.list_flatten</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.list_parent_indices.html">pyarrow.compute.list_parent_indices</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.list_slice.html">pyarrow.compute.list_slice</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.list_value_length.html">pyarrow.compute.list_value_length</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.make_struct.html">pyarrow.compute.make_struct</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.map_lookup.html">pyarrow.compute.map_lookup</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.replace_with_mask.html">pyarrow.compute.replace_with_mask</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.struct_field.html">pyarrow.compute.struct_field</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.pairwise_diff.html">pyarrow.compute.pairwise_diff</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ArraySortOptions.html">pyarrow.compute.ArraySortOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.AssumeTimezoneOptions.html">pyarrow.compute.AssumeTimezoneOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.CastOptions.html">pyarrow.compute.CastOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.CountOptions.html">pyarrow.compute.CountOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.CountOptions.html">pyarrow.compute.CountOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.CumulativeSumOptions.html">pyarrow.compute.CumulativeSumOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.DayOfWeekOptions.html">pyarrow.compute.DayOfWeekOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.DictionaryEncodeOptions.html">pyarrow.compute.DictionaryEncodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ElementWiseAggregateOptions.html">pyarrow.compute.ElementWiseAggregateOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ExtractRegexOptions.html">pyarrow.compute.ExtractRegexOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.FilterOptions.html">pyarrow.compute.FilterOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.IndexOptions.html">pyarrow.compute.IndexOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.JoinOptions.html">pyarrow.compute.JoinOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ListSliceOptions.html">pyarrow.compute.ListSliceOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.MakeStructOptions.html">pyarrow.compute.MakeStructOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.MapLookupOptions.html">pyarrow.compute.MapLookupOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.MatchSubstringOptions.html">pyarrow.compute.MatchSubstringOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ModeOptions.html">pyarrow.compute.ModeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.NullOptions.html">pyarrow.compute.NullOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.PadOptions.html">pyarrow.compute.PadOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.PairwiseOptions.html">pyarrow.compute.PairwiseOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.PartitionNthOptions.html">pyarrow.compute.PartitionNthOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.QuantileOptions.html">pyarrow.compute.QuantileOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ReplaceSliceOptions.html">pyarrow.compute.ReplaceSliceOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ReplaceSubstringOptions.html">pyarrow.compute.ReplaceSubstringOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.RoundOptions.html">pyarrow.compute.RoundOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.RoundTemporalOptions.html">pyarrow.compute.RoundTemporalOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.RoundToMultipleOptions.html">pyarrow.compute.RoundToMultipleOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.RunEndEncodeOptions.html">pyarrow.compute.RunEndEncodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ScalarAggregateOptions.html">pyarrow.compute.ScalarAggregateOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.ScalarAggregateOptions.html">pyarrow.compute.ScalarAggregateOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.SelectKOptions.html">pyarrow.compute.SelectKOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.SetLookupOptions.html">pyarrow.compute.SetLookupOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.SliceOptions.html">pyarrow.compute.SliceOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.SortOptions.html">pyarrow.compute.SortOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.SplitOptions.html">pyarrow.compute.SplitOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.SplitPatternOptions.html">pyarrow.compute.SplitPatternOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.StrftimeOptions.html">pyarrow.compute.StrftimeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.StrptimeOptions.html">pyarrow.compute.StrptimeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.StructFieldOptions.html">pyarrow.compute.StructFieldOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.TakeOptions.html">pyarrow.compute.TakeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.TDigestOptions.html">pyarrow.compute.TDigestOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.TDigestOptions.html">pyarrow.compute.TDigestOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.TrimOptions.html">pyarrow.compute.TrimOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.VarianceOptions.html">pyarrow.compute.VarianceOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.WeekOptions.html">pyarrow.compute.WeekOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.register_scalar_function.html">pyarrow.compute.register_scalar_function</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.compute.UdfContext.html">pyarrow.compute.UdfContext</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/acero.html">Acero - Streaming Execution Engine</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-8"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.Declaration.html">pyarrow.acero.Declaration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.ExecNodeOptions.html">pyarrow.acero.ExecNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.TableSourceNodeOptions.html">pyarrow.acero.TableSourceNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.ScanNodeOptions.html">pyarrow.acero.ScanNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.FilterNodeOptions.html">pyarrow.acero.FilterNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.ProjectNodeOptions.html">pyarrow.acero.ProjectNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.AggregateNodeOptions.html">pyarrow.acero.AggregateNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.OrderByNodeOptions.html">pyarrow.acero.OrderByNodeOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.acero.HashJoinNodeOptions.html">pyarrow.acero.HashJoinNodeOptions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/substrait.html">Substrait</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-9"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.substrait.run_query.html">pyarrow.substrait.run_query</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.substrait.BoundExpressions.html">pyarrow.substrait.BoundExpressions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.substrait.deserialize_expressions.html">pyarrow.substrait.deserialize_expressions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.substrait.serialize_expressions.html">pyarrow.substrait.serialize_expressions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.substrait.get_supported_functions.html">pyarrow.substrait.get_supported_functions</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/files.html">Streams and File Access</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-10"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.input_stream.html">pyarrow.input_stream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.output_stream.html">pyarrow.output_stream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.memory_map.html">pyarrow.memory_map</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.create_memory_map.html">pyarrow.create_memory_map</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.NativeFile.html">pyarrow.NativeFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.OSFile.html">pyarrow.OSFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.PythonFile.html">pyarrow.PythonFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BufferReader.html">pyarrow.BufferReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.BufferOutputStream.html">pyarrow.BufferOutputStream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.FixedSizeBufferWriter.html">pyarrow.FixedSizeBufferWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.MemoryMappedFile.html">pyarrow.MemoryMappedFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.CompressedInputStream.html">pyarrow.CompressedInputStream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.CompressedOutputStream.html">pyarrow.CompressedOutputStream</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/ipc.html">Serialization and IPC</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-11"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.new_file.html">pyarrow.ipc.new_file</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.open_file.html">pyarrow.ipc.open_file</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.new_stream.html">pyarrow.ipc.new_stream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.open_stream.html">pyarrow.ipc.open_stream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.read_message.html">pyarrow.ipc.read_message</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.read_record_batch.html">pyarrow.ipc.read_record_batch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.get_record_batch_size.html">pyarrow.ipc.get_record_batch_size</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.read_tensor.html">pyarrow.ipc.read_tensor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.write_tensor.html">pyarrow.ipc.write_tensor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.get_tensor_size.html">pyarrow.ipc.get_tensor_size</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.IpcReadOptions.html">pyarrow.ipc.IpcReadOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.IpcWriteOptions.html">pyarrow.ipc.IpcWriteOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.Message.html">pyarrow.ipc.Message</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.MessageReader.html">pyarrow.ipc.MessageReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.RecordBatchFileReader.html">pyarrow.ipc.RecordBatchFileReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.RecordBatchFileWriter.html">pyarrow.ipc.RecordBatchFileWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.RecordBatchStreamReader.html">pyarrow.ipc.RecordBatchStreamReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.ipc.RecordBatchStreamWriter.html">pyarrow.ipc.RecordBatchStreamWriter</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/flight.html">Arrow Flight</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-12"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.Action.html">pyarrow.flight.Action</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ActionType.html">pyarrow.flight.ActionType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.DescriptorType.html">pyarrow.flight.DescriptorType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightDescriptor.html">pyarrow.flight.FlightDescriptor</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightEndpoint.html">pyarrow.flight.FlightEndpoint</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightInfo.html">pyarrow.flight.FlightInfo</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.Location.html">pyarrow.flight.Location</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.MetadataRecordBatchReader.html">pyarrow.flight.MetadataRecordBatchReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.MetadataRecordBatchWriter.html">pyarrow.flight.MetadataRecordBatchWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.Ticket.html">pyarrow.flight.Ticket</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.Result.html">pyarrow.flight.Result</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.connect.html">pyarrow.flight.connect</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightCallOptions.html">pyarrow.flight.FlightCallOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightClient.html">pyarrow.flight.FlightClient</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightStreamReader.html">pyarrow.flight.FlightStreamReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightStreamWriter.html">pyarrow.flight.FlightStreamWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ClientMiddlewareFactory.html">pyarrow.flight.ClientMiddlewareFactory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ClientMiddleware.html">pyarrow.flight.ClientMiddleware</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightDataStream.html">pyarrow.flight.FlightDataStream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightMetadataWriter.html">pyarrow.flight.FlightMetadataWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightServerBase.html">pyarrow.flight.FlightServerBase</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.GeneratorStream.html">pyarrow.flight.GeneratorStream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.RecordBatchStream.html">pyarrow.flight.RecordBatchStream</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ServerCallContext.html">pyarrow.flight.ServerCallContext</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ServerMiddlewareFactory.html">pyarrow.flight.ServerMiddlewareFactory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ServerMiddleware.html">pyarrow.flight.ServerMiddleware</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ClientAuthHandler.html">pyarrow.flight.ClientAuthHandler</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.ServerAuthHandler.html">pyarrow.flight.ServerAuthHandler</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightError.html">pyarrow.flight.FlightError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightCancelledError.html">pyarrow.flight.FlightCancelledError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightInternalError.html">pyarrow.flight.FlightInternalError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightServerError.html">pyarrow.flight.FlightServerError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightTimedOutError.html">pyarrow.flight.FlightTimedOutError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightUnauthenticatedError.html">pyarrow.flight.FlightUnauthenticatedError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightUnauthorizedError.html">pyarrow.flight.FlightUnauthorizedError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightUnavailableError.html">pyarrow.flight.FlightUnavailableError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightWriteSizeExceededError.html">pyarrow.flight.FlightWriteSizeExceededError</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.FlightMethod.html">pyarrow.flight.FlightMethod</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.flight.CallInfo.html">pyarrow.flight.CallInfo</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/formats.html">Tabular File Formats</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-13"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.ConvertOptions.html">pyarrow.csv.ConvertOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.CSVStreamingReader.html">pyarrow.csv.CSVStreamingReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.CSVWriter.html">pyarrow.csv.CSVWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.ISO8601.html">pyarrow.csv.ISO8601</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.ParseOptions.html">pyarrow.csv.ParseOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.ReadOptions.html">pyarrow.csv.ReadOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.WriteOptions.html">pyarrow.csv.WriteOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.open_csv.html">pyarrow.csv.open_csv</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.read_csv.html">pyarrow.csv.read_csv</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.write_csv.html">pyarrow.csv.write_csv</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.csv.InvalidRow.html">pyarrow.csv.InvalidRow</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.feather.read_feather.html">pyarrow.feather.read_feather</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.feather.read_table.html">pyarrow.feather.read_table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.feather.write_feather.html">pyarrow.feather.write_feather</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.json.ReadOptions.html">pyarrow.json.ReadOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.json.ParseOptions.html">pyarrow.json.ParseOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.json.read_json.html">pyarrow.json.read_json</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetDataset.html">pyarrow.parquet.ParquetDataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetFile.html">pyarrow.parquet.ParquetFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetWriter.html">pyarrow.parquet.ParquetWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_table.html">pyarrow.parquet.read_table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_metadata.html">pyarrow.parquet.read_metadata</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_pandas.html">pyarrow.parquet.read_pandas</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.read_schema.html">pyarrow.parquet.read_schema</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_metadata.html">pyarrow.parquet.write_metadata</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_table.html">pyarrow.parquet.write_table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.write_to_dataset.html">pyarrow.parquet.write_to_dataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.FileMetaData.html">pyarrow.parquet.FileMetaData</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.RowGroupMetaData.html">pyarrow.parquet.RowGroupMetaData</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.SortingColumn.html">pyarrow.parquet.SortingColumn</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ColumnChunkMetaData.html">pyarrow.parquet.ColumnChunkMetaData</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.Statistics.html">pyarrow.parquet.Statistics</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetSchema.html">pyarrow.parquet.ParquetSchema</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ColumnSchema.html">pyarrow.parquet.ColumnSchema</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.ParquetLogicalType.html">pyarrow.parquet.ParquetLogicalType</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.encryption.CryptoFactory.html">pyarrow.parquet.encryption.CryptoFactory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.encryption.KmsClient.html">pyarrow.parquet.encryption.KmsClient</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.encryption.KmsConnectionConfig.html">pyarrow.parquet.encryption.KmsConnectionConfig</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.encryption.EncryptionConfiguration.html">pyarrow.parquet.encryption.EncryptionConfiguration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.parquet.encryption.DecryptionConfiguration.html">pyarrow.parquet.encryption.DecryptionConfiguration</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.orc.ORCFile.html">pyarrow.orc.ORCFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.orc.ORCWriter.html">pyarrow.orc.ORCWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.orc.read_table.html">pyarrow.orc.read_table</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.orc.write_table.html">pyarrow.orc.write_table</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/filesystems.html">Filesystems</a><input class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-14"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.FileInfo.html">pyarrow.fs.FileInfo</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.FileSelector.html">pyarrow.fs.FileSelector</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.FileSystem.html">pyarrow.fs.FileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.LocalFileSystem.html">pyarrow.fs.LocalFileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.S3FileSystem.html">pyarrow.fs.S3FileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.GcsFileSystem.html">pyarrow.fs.GcsFileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.HadoopFileSystem.html">pyarrow.fs.HadoopFileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.SubTreeFileSystem.html">pyarrow.fs.SubTreeFileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.PyFileSystem.html">pyarrow.fs.PyFileSystem</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.FileSystemHandler.html">pyarrow.fs.FileSystemHandler</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.FSSpecHandler.html">pyarrow.fs.FSSpecHandler</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.copy_files.html">pyarrow.fs.copy_files</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.initialize_s3.html">pyarrow.fs.initialize_s3</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.finalize_s3.html">pyarrow.fs.finalize_s3</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.resolve_s3_region.html">pyarrow.fs.resolve_s3_region</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.fs.S3LogLevel.html">pyarrow.fs.S3LogLevel</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/dataset.html">Dataset</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-15"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.dataset.html">pyarrow.dataset.dataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.parquet_dataset.html">pyarrow.dataset.parquet_dataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.partitioning.html">pyarrow.dataset.partitioning</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.field.html">pyarrow.dataset.field</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.scalar.html">pyarrow.dataset.scalar</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.write_dataset.html">pyarrow.dataset.write_dataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.FileFormat.html">pyarrow.dataset.FileFormat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.CsvFileFormat.html">pyarrow.dataset.CsvFileFormat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.CsvFragmentScanOptions.html">pyarrow.dataset.CsvFragmentScanOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.IpcFileFormat.html">pyarrow.dataset.IpcFileFormat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.JsonFileFormat.html">pyarrow.dataset.JsonFileFormat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.ParquetFileFormat.html">pyarrow.dataset.ParquetFileFormat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.ParquetReadOptions.html">pyarrow.dataset.ParquetReadOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.ParquetFragmentScanOptions.html">pyarrow.dataset.ParquetFragmentScanOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.ParquetFileFragment.html">pyarrow.dataset.ParquetFileFragment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.OrcFileFormat.html">pyarrow.dataset.OrcFileFormat</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.Partitioning.html">pyarrow.dataset.Partitioning</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.PartitioningFactory.html">pyarrow.dataset.PartitioningFactory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.DirectoryPartitioning.html">pyarrow.dataset.DirectoryPartitioning</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.HivePartitioning.html">pyarrow.dataset.HivePartitioning</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.FilenamePartitioning.html">pyarrow.dataset.FilenamePartitioning</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.Dataset.html">pyarrow.dataset.Dataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.FileSystemDataset.html">pyarrow.dataset.FileSystemDataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.FileSystemFactoryOptions.html">pyarrow.dataset.FileSystemFactoryOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.FileSystemDatasetFactory.html">pyarrow.dataset.FileSystemDatasetFactory</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.UnionDataset.html">pyarrow.dataset.UnionDataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.Fragment.html">pyarrow.dataset.Fragment</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.FragmentScanOptions.html">pyarrow.dataset.FragmentScanOptions</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.TaggedRecordBatch.html">pyarrow.dataset.TaggedRecordBatch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.Scanner.html">pyarrow.dataset.Scanner</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.Expression.html">pyarrow.dataset.Expression</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.InMemoryDataset.html">pyarrow.dataset.InMemoryDataset</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.WrittenFile.html">pyarrow.dataset.WrittenFile</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.dataset.get_partition_keys.html">pyarrow.dataset.get_partition_keys</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/cuda.html">CUDA Integration</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-16"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.Context.html">pyarrow.cuda.Context</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.CudaBuffer.html">pyarrow.cuda.CudaBuffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.new_host_buffer.html">pyarrow.cuda.new_host_buffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.HostBuffer.html">pyarrow.cuda.HostBuffer</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.BufferReader.html">pyarrow.cuda.BufferReader</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.BufferWriter.html">pyarrow.cuda.BufferWriter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.serialize_record_batch.html">pyarrow.cuda.serialize_record_batch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.read_record_batch.html">pyarrow.cuda.read_record_batch</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.read_message.html">pyarrow.cuda.read_message</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cuda.IpcMemHandle.html">pyarrow.cuda.IpcMemHandle</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../api/misc.html">Miscellaneous</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-17"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.cpu_count.html">pyarrow.cpu_count</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.set_cpu_count.html">pyarrow.set_cpu_count</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.io_thread_count.html">pyarrow.io_thread_count</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.set_io_thread_count.html">pyarrow.set_io_thread_count</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.get_include.html">pyarrow.get_include</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.get_libraries.html">pyarrow.get_libraries</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="pyarrow.get_library_dirs.html">pyarrow.get_library_dirs</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../getting_involved.html">Getting Involved</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../benchmarks.html">Benchmarks</a></li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/py/">Python cookbook</a></li> |
| </ul> |
| </div> |
| </nav></div> |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main"> |
| |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| |
| |
| |
| |
| <nav aria-label="Breadcrumb"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="../../index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| |
| <li class="breadcrumb-item"><a href="../index.html" class="nav-link">Python</a></li> |
| |
| |
| <li class="breadcrumb-item"><i class="fa-solid fa-ellipsis"></i></li> |
| |
| |
| <li class="breadcrumb-item"><a href="../api/arrays.html" class="nav-link">Arrays and Scalars</a></li> |
| |
| <li class="breadcrumb-item active" aria-current="page">pyarrow.Dict...</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="pyarrow-dictionaryarray"> |
| <h1>pyarrow.DictionaryArray<a class="headerlink" href="#pyarrow-dictionaryarray" title="Permalink to this heading">#</a></h1> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyarrow.</span></span><span class="sig-name descname"><span class="pre">DictionaryArray</span></span><a class="headerlink" href="#pyarrow.DictionaryArray" title="Permalink to this definition">#</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.lib.Array"><code class="xref py py-class docutils literal notranslate"><span class="pre">Array</span></code></a></p> |
| <p>Concrete class for dictionary-encoded Arrow arrays.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.__init__"> |
| <span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.__init__" title="Permalink to this definition">#</a></dt> |
| <dd></dd></dl> |
| |
| <p class="rubric">Methods</p> |
| <table class="autosummary longtable table autosummary"> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.__init__" title="pyarrow.DictionaryArray.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(*args, **kwargs)</p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.buffers" title="pyarrow.DictionaryArray.buffers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">buffers</span></code></a>(self)</p></td> |
| <td><p>Return a list of Buffer objects pointing to this array's physical storage.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.cast" title="pyarrow.DictionaryArray.cast"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cast</span></code></a>(self[, target_type, safe, options, ...])</p></td> |
| <td><p>Cast array values to another data type</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.dictionary_decode" title="pyarrow.DictionaryArray.dictionary_decode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary_decode</span></code></a>(self)</p></td> |
| <td><p>Decodes the DictionaryArray to an Array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.dictionary_encode" title="pyarrow.DictionaryArray.dictionary_encode"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary_encode</span></code></a>(self)</p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.diff" title="pyarrow.DictionaryArray.diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diff</span></code></a>(self, Array other)</p></td> |
| <td><p>Compare contents of this array against another one.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.drop_null" title="pyarrow.DictionaryArray.drop_null"><code class="xref py py-obj docutils literal notranslate"><span class="pre">drop_null</span></code></a>(self)</p></td> |
| <td><p>Remove missing values from an array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.equals" title="pyarrow.DictionaryArray.equals"><code class="xref py py-obj docutils literal notranslate"><span class="pre">equals</span></code></a>(self, Array other)</p></td> |
| <td><p><dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p></p></dd> |
| </dl> |
| </p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.fill_null" title="pyarrow.DictionaryArray.fill_null"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fill_null</span></code></a>(self, fill_value)</p></td> |
| <td><p>See <a class="reference internal" href="pyarrow.compute.fill_null.html#pyarrow.compute.fill_null" title="pyarrow.compute.fill_null"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.fill_null()</span></code></a> for usage.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.filter" title="pyarrow.DictionaryArray.filter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">filter</span></code></a>(self, Array mask, *[, ...])</p></td> |
| <td><p>Select values from an array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.format" title="pyarrow.DictionaryArray.format"><code class="xref py py-obj docutils literal notranslate"><span class="pre">format</span></code></a>(self, **kwargs)</p></td> |
| <td><p>DEPRECATED, use pyarrow.Array.to_string</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.from_arrays" title="pyarrow.DictionaryArray.from_arrays"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_arrays</span></code></a>(indices, dictionary[, mask])</p></td> |
| <td><p>Construct a DictionaryArray from indices and values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.from_buffers" title="pyarrow.DictionaryArray.from_buffers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_buffers</span></code></a>(DataType type, int64_t length, ...)</p></td> |
| <td><p>Construct a DictionaryArray from buffers.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.from_pandas" title="pyarrow.DictionaryArray.from_pandas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_pandas</span></code></a>(obj[, mask, type])</p></td> |
| <td><p>Convert pandas.Series to an Arrow Array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.get_total_buffer_size" title="pyarrow.DictionaryArray.get_total_buffer_size"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_total_buffer_size</span></code></a>(self)</p></td> |
| <td><p>The sum of bytes in each buffer referenced by the array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.index" title="pyarrow.DictionaryArray.index"><code class="xref py py-obj docutils literal notranslate"><span class="pre">index</span></code></a>(self, value[, start, end, memory_pool])</p></td> |
| <td><p>Find the first index of a value.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.is_nan" title="pyarrow.DictionaryArray.is_nan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_nan</span></code></a>(self)</p></td> |
| <td><p>Return BooleanArray indicating the NaN values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.is_null" title="pyarrow.DictionaryArray.is_null"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_null</span></code></a>(self, *[, nan_is_null])</p></td> |
| <td><p>Return BooleanArray indicating the null values.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.is_valid" title="pyarrow.DictionaryArray.is_valid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_valid</span></code></a>(self)</p></td> |
| <td><p>Return BooleanArray indicating the non-null values.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.slice" title="pyarrow.DictionaryArray.slice"><code class="xref py py-obj docutils literal notranslate"><span class="pre">slice</span></code></a>(self[, offset, length])</p></td> |
| <td><p>Compute zero-copy slice of this array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.sort" title="pyarrow.DictionaryArray.sort"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sort</span></code></a>(self[, order])</p></td> |
| <td><p>Sort the Array</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.sum" title="pyarrow.DictionaryArray.sum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sum</span></code></a>(self, **kwargs)</p></td> |
| <td><p>Sum the values in a numerical array.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.take" title="pyarrow.DictionaryArray.take"><code class="xref py py-obj docutils literal notranslate"><span class="pre">take</span></code></a>(self, indices)</p></td> |
| <td><p>Select values from an array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.to_numpy" title="pyarrow.DictionaryArray.to_numpy"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_numpy</span></code></a>(self[, zero_copy_only, writable])</p></td> |
| <td><p>Return a NumPy view or copy of this array (experimental).</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.to_pandas" title="pyarrow.DictionaryArray.to_pandas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_pandas</span></code></a>(self[, memory_pool, categories, ...])</p></td> |
| <td><p>Convert to a pandas-compatible NumPy array or DataFrame, as appropriate</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.to_pylist" title="pyarrow.DictionaryArray.to_pylist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_pylist</span></code></a>(self)</p></td> |
| <td><p>Convert to a list of native Python objects.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.to_string" title="pyarrow.DictionaryArray.to_string"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_string</span></code></a>(self, *, int indent=2, ...)</p></td> |
| <td><p>Render a "pretty-printed" string representation of the Array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.tolist" title="pyarrow.DictionaryArray.tolist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tolist</span></code></a>(self)</p></td> |
| <td><p>Alias of to_pylist for compatibility with NumPy.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.unique" title="pyarrow.DictionaryArray.unique"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unique</span></code></a>(self)</p></td> |
| <td><p>Compute distinct elements in array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.validate" title="pyarrow.DictionaryArray.validate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">validate</span></code></a>(self, *[, full])</p></td> |
| <td><p>Perform validation checks.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.value_counts" title="pyarrow.DictionaryArray.value_counts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">value_counts</span></code></a>(self)</p></td> |
| <td><p>Compute counts of unique elements in array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.view" title="pyarrow.DictionaryArray.view"><code class="xref py py-obj docutils literal notranslate"><span class="pre">view</span></code></a>(self, target_type)</p></td> |
| <td><p>Return zero-copy "view" of array as another data type.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <p class="rubric">Attributes</p> |
| <table class="autosummary longtable table autosummary"> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.dictionary" title="pyarrow.DictionaryArray.dictionary"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.indices" title="pyarrow.DictionaryArray.indices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">indices</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.nbytes" title="pyarrow.DictionaryArray.nbytes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nbytes</span></code></a></p></td> |
| <td><p>Total number of bytes consumed by the elements of the array.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.null_count" title="pyarrow.DictionaryArray.null_count"><code class="xref py py-obj docutils literal notranslate"><span class="pre">null_count</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.offset" title="pyarrow.DictionaryArray.offset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">offset</span></code></a></p></td> |
| <td><p>A relative position into another array's data.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#pyarrow.DictionaryArray.type" title="pyarrow.DictionaryArray.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></a></p></td> |
| <td><p></p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.buffers"> |
| <span class="sig-name descname"><span class="pre">buffers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.buffers" title="Permalink to this definition">#</a></dt> |
| <dd><p>Return a list of Buffer objects pointing to this array’s physical |
| storage.</p> |
| <p>To correctly interpret these buffers, you need to also apply the offset |
| multiplied with the size of the stored data type.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.cast"> |
| <span class="sig-name descname"><span class="pre">cast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">safe</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.cast" title="Permalink to this definition">#</a></dt> |
| <dd><p>Cast array values to another data type</p> |
| <p>See <a class="reference internal" href="pyarrow.compute.cast.html#pyarrow.compute.cast" title="pyarrow.compute.cast"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.cast()</span></code></a> for usage.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>target_type</strong><span class="classifier"><a class="reference internal" href="pyarrow.DataType.html#pyarrow.DataType" title="pyarrow.DataType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataType</span></code></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">None</span></code></a></span></dt><dd><p>Type to cast array to.</p> |
| </dd> |
| <dt><strong>safe</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>Whether to check for conversion errors such as overflow.</p> |
| </dd> |
| <dt><strong>options</strong><span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CastOptions</span></code>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">None</span></code></a></span></dt><dd><p>Additional checks pass by CastOptions</p> |
| </dd> |
| <dt><strong>memory_pool</strong><span class="classifier"><a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MemoryPool</span></code></a>, optional</span></dt><dd><p>memory pool to use for allocations during function execution.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>cast</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.dictionary"> |
| <span class="sig-name descname"><span class="pre">dictionary</span></span><a class="headerlink" href="#pyarrow.DictionaryArray.dictionary" title="Permalink to this definition">#</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.dictionary_decode"> |
| <span class="sig-name descname"><span class="pre">dictionary_decode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.dictionary_decode" title="Permalink to this definition">#</a></dt> |
| <dd><p>Decodes the DictionaryArray to an Array.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.dictionary_encode"> |
| <span class="sig-name descname"><span class="pre">dictionary_encode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.dictionary_encode" title="Permalink to this definition">#</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.diff"> |
| <span class="sig-name descname"><span class="pre">diff</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Array</span> <span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.diff" title="Permalink to this definition">#</a></dt> |
| <dd><p>Compare contents of this array against another one.</p> |
| <p>Return a string containing the result of diffing this array |
| (on the left side) against the other array (on the right side).</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>other</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd><p>The other array to compare this array with.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>diff</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>A human-readable printout of the differences.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> |
| <span class="gp">>>> </span><span class="n">left</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="s2">"one"</span><span class="p">,</span> <span class="s2">"two"</span><span class="p">,</span> <span class="s2">"three"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">right</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="s2">"two"</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s2">"two-and-a-half"</span><span class="p">,</span> <span class="s2">"three"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">left</span><span class="o">.</span><span class="n">diff</span><span class="p">(</span><span class="n">right</span><span class="p">))</span> |
| </pre></div> |
| </div> |
| <p>@@ -0, +0 @@ |
| -“one” |
| @@ -2, +1 @@ |
| +null |
| +”two-and-a-half”</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.drop_null"> |
| <span class="sig-name descname"><span class="pre">drop_null</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.drop_null" title="Permalink to this definition">#</a></dt> |
| <dd><p>Remove missing values from an array.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.equals"> |
| <span class="sig-name descname"><span class="pre">equals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Array</span> <span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.equals" title="Permalink to this definition">#</a></dt> |
| <dd><dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>other</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.Array</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl class="simple"> |
| <dt><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.fill_null"> |
| <span class="sig-name descname"><span class="pre">fill_null</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fill_value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.fill_null" title="Permalink to this definition">#</a></dt> |
| <dd><p>See <a class="reference internal" href="pyarrow.compute.fill_null.html#pyarrow.compute.fill_null" title="pyarrow.compute.fill_null"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.fill_null()</span></code></a> for usage.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>fill_value</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#any" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">any</span></code></a></span></dt><dd><p>The replacement value for null entries.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>result</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd><p>A new array with nulls replaced by the given value.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.filter"> |
| <span class="sig-name descname"><span class="pre">filter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Array</span> <span class="pre">mask</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">null_selection_behavior=u'drop'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.filter" title="Permalink to this definition">#</a></dt> |
| <dd><p>Select values from an array.</p> |
| <p>See <a class="reference internal" href="pyarrow.compute.filter.html#pyarrow.compute.filter" title="pyarrow.compute.filter"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.filter()</span></code></a> for full usage.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>mask</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a> or <a class="reference internal" href="pyarrow.array.html#pyarrow.array" title="pyarrow.array"><code class="xref py py-func docutils literal notranslate"><span class="pre">array-like</span></code></a></span></dt><dd><p>The boolean mask to filter the array with.</p> |
| </dd> |
| <dt><strong>null_selection_behavior</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a>, default “drop”</span></dt><dd><p>How nulls in the mask should be handled.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>filtered</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd><p>An array of the same type, with only the elements selected by |
| the boolean mask.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.format"> |
| <span class="sig-name descname"><span class="pre">format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.format" title="Permalink to this definition">#</a></dt> |
| <dd><p>DEPRECATED, use pyarrow.Array.to_string</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>**kwargs</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl class="simple"> |
| <dt><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.from_arrays"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_arrays</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indices</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dictionary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">ordered=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">from_pandas=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">safe=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">MemoryPool</span> <span class="pre">memory_pool=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.from_arrays" title="Permalink to this definition">#</a></dt> |
| <dd><p>Construct a DictionaryArray from indices and values.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>indices</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.Array</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a> or <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a> <a class="reference internal" href="#pyarrow.DictionaryArray.type" title="pyarrow.DictionaryArray.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></a></span></dt><dd><p>Non-negative integers referencing the dictionary values by zero |
| based index.</p> |
| </dd> |
| <dt><strong>dictionary</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.Array</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a> or <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a></span></dt><dd><p>The array of values referenced by the indices.</p> |
| </dd> |
| <dt><strong>mask</strong><span class="classifier"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a> or <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a> <a class="reference internal" href="#pyarrow.DictionaryArray.type" title="pyarrow.DictionaryArray.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></a></span></dt><dd><p>True values indicate that indices are actually null.</p> |
| </dd> |
| <dt><strong>ordered</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>Set to True if the category values are ordered.</p> |
| </dd> |
| <dt><strong>from_pandas</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>If True, the indices should be treated as though they originated in |
| a pandas.Categorical (null encoded as -1).</p> |
| </dd> |
| <dt><strong>safe</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>If True, check that the dictionary indices are in range.</p> |
| </dd> |
| <dt><strong>memory_pool</strong><span class="classifier"><a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MemoryPool</span></code></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">None</span></code></a></span></dt><dd><p>For memory allocations, if required, otherwise uses default pool.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>dict_array</strong><span class="classifier"><a class="reference internal" href="#pyarrow.DictionaryArray" title="pyarrow.DictionaryArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DictionaryArray</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.from_buffers"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_buffers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">DataType</span> <span class="pre">type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int64_t</span> <span class="pre">length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buffers</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">Array</span> <span class="pre">dictionary</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int64_t</span> <span class="pre">null_count=-1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int64_t</span> <span class="pre">offset=0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.from_buffers" title="Permalink to this definition">#</a></dt> |
| <dd><p>Construct a DictionaryArray from buffers.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>type</strong><span class="classifier"><a class="reference internal" href="pyarrow.DataType.html#pyarrow.DataType" title="pyarrow.DataType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.DataType</span></code></a></span></dt><dd></dd> |
| <dt><strong>length</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a></span></dt><dd><p>The number of values in the array.</p> |
| </dd> |
| <dt><strong>buffers</strong><span class="classifier"><code class="xref py py-obj docutils literal notranslate"><span class="pre">List</span></code>[<a class="reference internal" href="pyarrow.Buffer.html#pyarrow.Buffer" title="pyarrow.Buffer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Buffer</span></code></a>]</span></dt><dd><p>The buffers backing the indices array.</p> |
| </dd> |
| <dt><strong>dictionary</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.Array</span></code></a>, <a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a> or <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a></span></dt><dd><p>The array of values referenced by the indices.</p> |
| </dd> |
| <dt><strong>null_count</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, default -1</span></dt><dd><p>The number of null entries in the indices array. Negative value means that |
| the null count is not known.</p> |
| </dd> |
| <dt><strong>offset</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, default 0</span></dt><dd><p>The array’s logical offset (in values, not in bytes) from the |
| start of each buffer.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>dict_array</strong><span class="classifier"><a class="reference internal" href="#pyarrow.DictionaryArray" title="pyarrow.DictionaryArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DictionaryArray</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.from_pandas"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_pandas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">safe=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">MemoryPool</span> <span class="pre">memory_pool=None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.from_pandas" title="Permalink to this definition">#</a></dt> |
| <dd><p>Convert pandas.Series to an Arrow Array.</p> |
| <p>This method uses Pandas semantics about what values indicate |
| nulls. See pyarrow.array for more general conversion from arrays or |
| sequences to Arrow arrays.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>obj</strong><span class="classifier"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ndarray</span></code></a>, <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a>, <a class="reference internal" href="pyarrow.array.html#pyarrow.array" title="pyarrow.array"><code class="xref py py-func docutils literal notranslate"><span class="pre">array-like</span></code></a></span></dt><dd></dd> |
| <dt><strong>mask</strong><span class="classifier"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code></a> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>), optional</span></dt><dd><p>Indicate which values are null (True) or not null (False).</p> |
| </dd> |
| <dt><strong>type</strong><span class="classifier"><a class="reference internal" href="pyarrow.DataType.html#pyarrow.DataType" title="pyarrow.DataType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.DataType</span></code></a></span></dt><dd><p>Explicit type to attempt to coerce to, otherwise will be inferred |
| from the data.</p> |
| </dd> |
| <dt><strong>safe</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>Check for overflows or other unsafe conversions.</p> |
| </dd> |
| <dt><strong>memory_pool</strong><span class="classifier"><a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.MemoryPool</span></code></a>, optional</span></dt><dd><p>If not passed, will allocate memory from the currently-set default |
| memory pool.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>array</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.Array</span></code></a> or <a class="reference internal" href="pyarrow.ChunkedArray.html#pyarrow.ChunkedArray" title="pyarrow.ChunkedArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pyarrow.ChunkedArray</span></code></a></span></dt><dd><p>ChunkedArray is returned if object data overflows binary buffer.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| <p class="rubric">Notes</p> |
| <p>Localized timestamps will currently be returned as UTC (pandas’s native |
| representation). Timezone-naive data will be implicitly interpreted as |
| UTC.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.get_total_buffer_size"> |
| <span class="sig-name descname"><span class="pre">get_total_buffer_size</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.get_total_buffer_size" title="Permalink to this definition">#</a></dt> |
| <dd><p>The sum of bytes in each buffer referenced by the array.</p> |
| <p>An array may only reference a portion of a buffer. |
| This method will overestimate in this case and return the |
| byte size of the entire buffer.</p> |
| <p>If a buffer is referenced multiple times then it will |
| only be counted once.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.index"> |
| <span class="sig-name descname"><span class="pre">index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.index" title="Permalink to this definition">#</a></dt> |
| <dd><p>Find the first index of a value.</p> |
| <p>See <a class="reference internal" href="pyarrow.compute.index.html#pyarrow.compute.index" title="pyarrow.compute.index"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.index()</span></code></a> for full usage.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>value</strong><span class="classifier"><a class="reference internal" href="pyarrow.Scalar.html#pyarrow.Scalar" title="pyarrow.Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scalar</span></code></a> or object</span></dt><dd><p>The value to look for in the array.</p> |
| </dd> |
| <dt><strong>start</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, optional</span></dt><dd><p>The start index where to look for <cite>value</cite>.</p> |
| </dd> |
| <dt><strong>end</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, optional</span></dt><dd><p>The end index where to look for <cite>value</cite>.</p> |
| </dd> |
| <dt><strong>memory_pool</strong><span class="classifier"><a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MemoryPool</span></code></a>, optional</span></dt><dd><p>A memory pool for potential memory allocations.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>index</strong><span class="classifier"><a class="reference internal" href="pyarrow.Int64Scalar.html#pyarrow.Int64Scalar" title="pyarrow.Int64Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Int64Scalar</span></code></a></span></dt><dd><p>The index of the value in the array (-1 if not found).</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.indices"> |
| <span class="sig-name descname"><span class="pre">indices</span></span><a class="headerlink" href="#pyarrow.DictionaryArray.indices" title="Permalink to this definition">#</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.is_nan"> |
| <span class="sig-name descname"><span class="pre">is_nan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.is_nan" title="Permalink to this definition">#</a></dt> |
| <dd><p>Return BooleanArray indicating the NaN values.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>array</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a> <a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.is_null"> |
| <span class="sig-name descname"><span class="pre">is_null</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nan_is_null</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.is_null" title="Permalink to this definition">#</a></dt> |
| <dd><p>Return BooleanArray indicating the null values.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>nan_is_null</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a> (optional, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a>)</span></dt><dd><p>Whether floating-point NaN values should also be considered null.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>array</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a> <a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.is_valid"> |
| <span class="sig-name descname"><span class="pre">is_valid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.is_valid" title="Permalink to this definition">#</a></dt> |
| <dd><p>Return BooleanArray indicating the non-null values.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.nbytes"> |
| <span class="sig-name descname"><span class="pre">nbytes</span></span><a class="headerlink" href="#pyarrow.DictionaryArray.nbytes" title="Permalink to this definition">#</a></dt> |
| <dd><p>Total number of bytes consumed by the elements of the array.</p> |
| <p>In other words, the sum of bytes from all buffer |
| ranges referenced.</p> |
| <p>Unlike <cite>get_total_buffer_size</cite> this method will account for array |
| offsets.</p> |
| <p>If buffers are shared between arrays then the shared |
| portion will be counted multiple times.</p> |
| <p>The dictionary of dictionary arrays will always be counted in their |
| entirety even if the array only references a portion of the dictionary.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.null_count"> |
| <span class="sig-name descname"><span class="pre">null_count</span></span><a class="headerlink" href="#pyarrow.DictionaryArray.null_count" title="Permalink to this definition">#</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.offset"> |
| <span class="sig-name descname"><span class="pre">offset</span></span><a class="headerlink" href="#pyarrow.DictionaryArray.offset" title="Permalink to this definition">#</a></dt> |
| <dd><p>A relative position into another array’s data.</p> |
| <p>The purpose is to enable zero-copy slicing. This value defaults to zero |
| but must be applied on all operations with the physical storage |
| buffers.</p> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.slice"> |
| <span class="sig-name descname"><span class="pre">slice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.slice" title="Permalink to this definition">#</a></dt> |
| <dd><p>Compute zero-copy slice of this array.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>offset</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, default 0</span></dt><dd><p>Offset from start of array to slice.</p> |
| </dd> |
| <dt><strong>length</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">None</span></code></a></span></dt><dd><p>Length of slice (default is until end of Array starting from |
| offset).</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>sliced</strong><span class="classifier"><a class="reference internal" href="pyarrow.RecordBatch.html#pyarrow.RecordBatch" title="pyarrow.RecordBatch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">RecordBatch</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.sort"> |
| <span class="sig-name descname"><span class="pre">sort</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'ascending'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.sort" title="Permalink to this definition">#</a></dt> |
| <dd><p>Sort the Array</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>order</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a>, default “ascending”</span></dt><dd><p>Which order to sort values in. |
| Accepted values are “ascending”, “descending”.</p> |
| </dd> |
| <dt><strong>**kwargs</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a>, optional</span></dt><dd><p>Additional sorting options. |
| As allowed by <code class="xref py py-class docutils literal notranslate"><span class="pre">SortOptions</span></code></p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>result</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.sum"> |
| <span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.sum" title="Permalink to this definition">#</a></dt> |
| <dd><p>Sum the values in a numerical array.</p> |
| <p>See <a class="reference internal" href="pyarrow.compute.sum.html#pyarrow.compute.sum" title="pyarrow.compute.sum"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.sum()</span></code></a> for full usage.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>**kwargs</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">dict</span></code></a>, optional</span></dt><dd><p>Options to pass to <a class="reference internal" href="pyarrow.compute.sum.html#pyarrow.compute.sum" title="pyarrow.compute.sum"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.sum()</span></code></a>.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>sum</strong><span class="classifier"><a class="reference internal" href="pyarrow.Scalar.html#pyarrow.Scalar" title="pyarrow.Scalar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Scalar</span></code></a></span></dt><dd><p>A scalar containing the sum value.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.take"> |
| <span class="sig-name descname"><span class="pre">take</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indices</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.take" title="Permalink to this definition">#</a></dt> |
| <dd><p>Select values from an array.</p> |
| <p>See <a class="reference internal" href="pyarrow.compute.take.html#pyarrow.compute.take" title="pyarrow.compute.take"><code class="xref py py-func docutils literal notranslate"><span class="pre">pyarrow.compute.take()</span></code></a> for full usage.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>indices</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a> or <a class="reference internal" href="pyarrow.array.html#pyarrow.array" title="pyarrow.array"><code class="xref py py-func docutils literal notranslate"><span class="pre">array-like</span></code></a></span></dt><dd><p>The indices in the array whose values will be returned.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>taken</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd><p>An array with the same datatype, containing the taken values.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.to_numpy"> |
| <span class="sig-name descname"><span class="pre">to_numpy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">zero_copy_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">writable</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.to_numpy" title="Permalink to this definition">#</a></dt> |
| <dd><p>Return a NumPy view or copy of this array (experimental).</p> |
| <p>By default, tries to return a view of this array. This is only |
| supported for primitive arrays with the same memory layout as NumPy |
| (i.e. integers, floating point, ..) and without any nulls.</p> |
| <p>For the extension arrays, this method simply delegates to the |
| underlying storage array.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>zero_copy_only</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>If True, an exception will be raised if the conversion to a numpy |
| array would require copying the underlying data (e.g. in presence |
| of nulls, or for non-primitive types).</p> |
| </dd> |
| <dt><strong>writable</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>For numpy arrays created with zero copy (view on the Arrow data), |
| the resulting array is not writable (Arrow data is immutable). |
| By setting this to True, a copy of the array is made to ensure |
| it is writable.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>array</strong><span class="classifier"><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy.ndarray</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.to_pandas"> |
| <span class="sig-name descname"><span class="pre">to_pandas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">memory_pool=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">categories=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">strings_to_categorical=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">zero_copy_only=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">integer_object_nulls=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">date_as_object=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">timestamp_as_object=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">use_threads=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">deduplicate_objects=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">ignore_metadata=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">safe=True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">split_blocks=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">self_destruct=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unicode</span> <span class="pre">maps_as_pydicts=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">types_mapper=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">coerce_temporal_nanoseconds=False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.to_pandas" title="Permalink to this definition">#</a></dt> |
| <dd><p>Convert to a pandas-compatible NumPy array or DataFrame, as appropriate</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>memory_pool</strong><span class="classifier"><a class="reference internal" href="pyarrow.MemoryPool.html#pyarrow.MemoryPool" title="pyarrow.MemoryPool"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MemoryPool</span></code></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">None</span></code></a></span></dt><dd><p>Arrow MemoryPool to use for allocations. Uses the default memory |
| pool if not passed.</p> |
| </dd> |
| <dt><strong>categories</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a>, default <code class="xref py py-obj docutils literal notranslate"><span class="pre">empty</span></code></span></dt><dd><p>List of fields that should be returned as pandas.Categorical. Only |
| applies to table-like data structures.</p> |
| </dd> |
| <dt><strong>strings_to_categorical</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>Encode string (UTF8) and binary types to pandas.Categorical.</p> |
| </dd> |
| <dt><strong>zero_copy_only</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>Raise an ArrowException if this function call would require copying |
| the underlying data.</p> |
| </dd> |
| <dt><strong>integer_object_nulls</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>Cast integers with nulls to objects</p> |
| </dd> |
| <dt><strong>date_as_object</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>Cast dates to objects. If False, convert to datetime64 dtype with |
| the equivalent time unit (if supported). Note: in pandas version |
| < 2.0, only datetime64[ns] conversion is supported.</p> |
| </dd> |
| <dt><strong>timestamp_as_object</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>Cast non-nanosecond timestamps (np.datetime64) to objects. This is |
| useful in pandas version 1.x if you have timestamps that don’t fit |
| in the normal date range of nanosecond timestamps (1678 CE-2262 CE). |
| Non-nanosecond timestamps are supported in pandas version 2.0. |
| If False, all timestamps are converted to datetime64 dtype.</p> |
| </dd> |
| <dt><strong>use_threads</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>Whether to parallelize the conversion using multiple threads.</p> |
| </dd> |
| <dt><strong>deduplicate_objects</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>Do not create multiple copies Python objects when created, to save |
| on memory use. Conversion will be slower.</p> |
| </dd> |
| <dt><strong>ignore_metadata</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>If True, do not use the ‘pandas’ metadata to reconstruct the |
| DataFrame index, if present</p> |
| </dd> |
| <dt><strong>safe</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">True</span></code></a></span></dt><dd><p>For certain data types, a cast is needed in order to store the |
| data in a pandas DataFrame or Series (e.g. timestamps are always |
| stored as nanoseconds in pandas). This option controls whether it |
| is a safe cast or not.</p> |
| </dd> |
| <dt><strong>split_blocks</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>If True, generate one internal “block” for each column when |
| creating a pandas.DataFrame from a RecordBatch or Table. While this |
| can temporarily reduce memory note that various pandas operations |
| can trigger “consolidation” which may balloon memory use.</p> |
| </dd> |
| <dt><strong>self_destruct</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>EXPERIMENTAL: If True, attempt to deallocate the originating Arrow |
| memory while converting the Arrow object to pandas. If you use the |
| object after calling to_pandas with this option it will crash your |
| program.</p> |
| <p>Note that you may not see always memory usage improvements. For |
| example, if multiple columns share an underlying allocation, |
| memory can’t be freed until all columns are converted.</p> |
| </dd> |
| <dt><strong>maps_as_pydicts</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">str</span></code></a>, optional, default <cite>None</cite></span></dt><dd><p>Valid values are <cite>None</cite>, ‘lossy’, or ‘strict’. |
| The default behavior (<cite>None</cite>), is to convert Arrow Map arrays to |
| Python association lists (list-of-tuples) in the same order as the |
| Arrow Map, as in [(key1, value1), (key2, value2), …].</p> |
| <p>If ‘lossy’ or ‘strict’, convert Arrow Map arrays to native Python dicts. |
| This can change the ordering of (key, value) pairs, and will |
| deduplicate multiple keys, resulting in a possible loss of data.</p> |
| <p>If ‘lossy’, this key deduplication results in a warning printed |
| when detected. If ‘strict’, this instead results in an exception |
| being raised when detected.</p> |
| </dd> |
| <dt><strong>types_mapper</strong><span class="classifier">function, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">None</span></code></a></span></dt><dd><p>A function mapping a pyarrow DataType to a pandas ExtensionDtype. |
| This can be used to override the default pandas type for conversion |
| of built-in pyarrow types or in absence of pandas_metadata in the |
| Table schema. The function receives a pyarrow DataType and is |
| expected to return a pandas ExtensionDtype or <code class="docutils literal notranslate"><span class="pre">None</span></code> if the |
| default conversion should be used for that type. If you have |
| a dictionary mapping, you can pass <code class="docutils literal notranslate"><span class="pre">dict.get</span></code> as function.</p> |
| </dd> |
| <dt><strong>coerce_temporal_nanoseconds</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>Only applicable to pandas version >= 2.0. |
| A legacy option to coerce date32, date64, duration, and timestamp |
| time units to nanoseconds when converting to pandas. This is the |
| default behavior in pandas version 1.x. Set this option to True if |
| you’d like to use this coercion when using pandas version >= 2.0 |
| for backwards compatibility (not recommended otherwise).</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl class="simple"> |
| <dt><a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.Series.html#pandas.Series" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.Series</span></code></a> or <a class="reference external" href="https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.2)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a> depending on <a class="reference internal" href="#pyarrow.DictionaryArray.type" title="pyarrow.DictionaryArray.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span></code></a> of object</dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| <p class="rubric">Examples</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> |
| <span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span> |
| </pre></div> |
| </div> |
| <p>Convert a Table to pandas DataFrame:</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">table</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">table</span><span class="p">([</span> |
| <span class="gp">... </span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">100</span><span class="p">]),</span> |
| <span class="gp">... </span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="s2">"Flamingo"</span><span class="p">,</span> <span class="s2">"Horse"</span><span class="p">,</span> <span class="s2">"Brittle stars"</span><span class="p">,</span> <span class="s2">"Centipede"</span><span class="p">])</span> |
| <span class="gp">... </span> <span class="p">],</span> <span class="n">names</span><span class="o">=</span><span class="p">[</span><span class="s1">'n_legs'</span><span class="p">,</span> <span class="s1">'animals'</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">table</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span> |
| <span class="go"> n_legs animals</span> |
| <span class="go">0 2 Flamingo</span> |
| <span class="go">1 4 Horse</span> |
| <span class="go">2 5 Brittle stars</span> |
| <span class="go">3 100 Centipede</span> |
| <span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">table</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">(),</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">)</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| <p>Convert a RecordBatch to pandas DataFrame:</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> |
| <span class="gp">>>> </span><span class="n">n_legs</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">100</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">animals</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="s2">"Flamingo"</span><span class="p">,</span> <span class="s2">"Horse"</span><span class="p">,</span> <span class="s2">"Brittle stars"</span><span class="p">,</span> <span class="s2">"Centipede"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">batch</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">record_batch</span><span class="p">([</span><span class="n">n_legs</span><span class="p">,</span> <span class="n">animals</span><span class="p">],</span> |
| <span class="gp">... </span> <span class="n">names</span><span class="o">=</span><span class="p">[</span><span class="s2">"n_legs"</span><span class="p">,</span> <span class="s2">"animals"</span><span class="p">])</span> |
| <span class="gp">>>> </span><span class="n">batch</span> |
| <span class="go">pyarrow.RecordBatch</span> |
| <span class="go">n_legs: int64</span> |
| <span class="go">animals: string</span> |
| <span class="go">----</span> |
| <span class="go">n_legs: [2,4,5,100]</span> |
| <span class="go">animals: ["Flamingo","Horse","Brittle stars","Centipede"]</span> |
| <span class="gp">>>> </span><span class="n">batch</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span> |
| <span class="go"> n_legs animals</span> |
| <span class="go">0 2 Flamingo</span> |
| <span class="go">1 4 Horse</span> |
| <span class="go">2 5 Brittle stars</span> |
| <span class="go">3 100 Centipede</span> |
| <span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">batch</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">(),</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">)</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| <p>Convert a Chunked Array to pandas Series:</p> |
| <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">pyarrow</span> <span class="k">as</span> <span class="nn">pa</span> |
| <span class="gp">>>> </span><span class="n">n_legs</span> <span class="o">=</span> <span class="n">pa</span><span class="o">.</span><span class="n">chunked_array</span><span class="p">([[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">],</span> <span class="p">[</span><span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">100</span><span class="p">]])</span> |
| <span class="gp">>>> </span><span class="n">n_legs</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">()</span> |
| <span class="go">0 2</span> |
| <span class="go">1 2</span> |
| <span class="go">2 4</span> |
| <span class="go">3 4</span> |
| <span class="go">4 5</span> |
| <span class="go">5 100</span> |
| <span class="go">dtype: int64</span> |
| <span class="gp">>>> </span><span class="nb">isinstance</span><span class="p">(</span><span class="n">n_legs</span><span class="o">.</span><span class="n">to_pandas</span><span class="p">(),</span> <span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">)</span> |
| <span class="go">True</span> |
| </pre></div> |
| </div> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.to_pylist"> |
| <span class="sig-name descname"><span class="pre">to_pylist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.to_pylist" title="Permalink to this definition">#</a></dt> |
| <dd><p>Convert to a list of native Python objects.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>lst</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">list</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.to_string"> |
| <span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int</span> <span class="pre">indent=2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int</span> <span class="pre">top_level_indent=0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int</span> <span class="pre">window=10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">int</span> <span class="pre">container_window=2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool</span> <span class="pre">skip_new_lines=False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.to_string" title="Permalink to this definition">#</a></dt> |
| <dd><p>Render a “pretty-printed” string representation of the Array.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>indent</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, default 2</span></dt><dd><p>How much to indent the internal items in the string to |
| the right, by default <code class="docutils literal notranslate"><span class="pre">2</span></code>.</p> |
| </dd> |
| <dt><strong>top_level_indent</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a>, default 0</span></dt><dd><p>How much to indent right the entire content of the array, |
| by default <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p> |
| </dd> |
| <dt><strong>window</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a></span></dt><dd><p>How many primitive items to preview at the begin and end |
| of the array when the array is bigger than the window. |
| The other items will be ellipsed.</p> |
| </dd> |
| <dt><strong>container_window</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">int</span></code></a></span></dt><dd><p>How many container items (such as a list in a list array) |
| to preview at the begin and end of the array when the array |
| is bigger than the window.</p> |
| </dd> |
| <dt><strong>skip_new_lines</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a></span></dt><dd><p>If the array should be rendered as a single line of text |
| or if each element should be on its own line.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.tolist"> |
| <span class="sig-name descname"><span class="pre">tolist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.tolist" title="Permalink to this definition">#</a></dt> |
| <dd><p>Alias of to_pylist for compatibility with NumPy.</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.type"> |
| <span class="sig-name descname"><span class="pre">type</span></span><a class="headerlink" href="#pyarrow.DictionaryArray.type" title="Permalink to this definition">#</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.unique"> |
| <span class="sig-name descname"><span class="pre">unique</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.unique" title="Permalink to this definition">#</a></dt> |
| <dd><p>Compute distinct elements in array.</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>unique</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd><p>An array of the same data type, with deduplicated elements.</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.validate"> |
| <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">full</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.validate" title="Permalink to this definition">#</a></dt> |
| <dd><p>Perform validation checks. An exception is raised if validation fails.</p> |
| <p>By default only cheap validation checks are run. Pass <cite>full=True</cite> |
| for thorough validation checks (potentially O(n)).</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>full</strong><span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bltin-boolean-values" title="(in Python v3.12)"><span class="xref std std-ref">bool</span></a>, default <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="docutils literal notranslate"><span class="pre">False</span></code></a></span></dt><dd><p>If True, run expensive checks, otherwise cheap checks only.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Raises<span class="colon">:</span></dt> |
| <dd class="field-even"><dl class="simple"> |
| <dt><code class="xref py py-obj docutils literal notranslate"><span class="pre">ArrowInvalid</span></code></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.value_counts"> |
| <span class="sig-name descname"><span class="pre">value_counts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.value_counts" title="Permalink to this definition">#</a></dt> |
| <dd><p>Compute counts of unique elements in array.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl class="simple"> |
| <dt><a class="reference internal" href="pyarrow.StructArray.html#pyarrow.StructArray" title="pyarrow.StructArray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StructArray</span></code></a></dt><dd><p>An array of <input type “Values”, int64 “Counts”> structs</p> |
| </dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="pyarrow.DictionaryArray.view"> |
| <span class="sig-name descname"><span class="pre">view</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target_type</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyarrow.DictionaryArray.view" title="Permalink to this definition">#</a></dt> |
| <dd><p>Return zero-copy “view” of array as another data type.</p> |
| <p>The data types must have compatible columnar buffer layouts</p> |
| <dl class="field-list"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><dl> |
| <dt><strong>target_type</strong><span class="classifier"><a class="reference internal" href="pyarrow.DataType.html#pyarrow.DataType" title="pyarrow.DataType"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataType</span></code></a></span></dt><dd><p>Type to construct view as.</p> |
| </dd> |
| </dl> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><dl> |
| <dt><strong>view</strong><span class="classifier"><a class="reference internal" href="pyarrow.Array.html#pyarrow.Array" title="pyarrow.Array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Array</span></code></a></span></dt><dd></dd> |
| </dl> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="pyarrow.Decimal128Array.html" |
| title="previous page"> |
| <i class="fa-solid fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">pyarrow.Decimal128Array</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="pyarrow.ListArray.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">pyarrow.ListArray</p> |
| </div> |
| <i class="fa-solid fa-angle-right"></i> |
| </a> |
| </div> |
| </footer> |
| |
| </div> |
| |
| |
| |
| <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> |
| |
| |
| <div class="sidebar-secondary-item"> |
| <div |
| id="pst-page-navigation-heading-2" |
| class="page-toc tocsection onthispage"> |
| <i class="fa-solid fa-list"></i> On this page |
| </div> |
| <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray"><code class="docutils literal notranslate"><span class="pre">DictionaryArray</span></code></a><ul class="visible nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.__init__"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.__init__()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.buffers"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.buffers()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.cast"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.cast()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.dictionary"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.dictionary</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.dictionary_decode"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.dictionary_decode()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.dictionary_encode"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.dictionary_encode()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.diff"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.diff()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.drop_null"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.drop_null()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.equals"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.equals()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.fill_null"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.fill_null()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.filter"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.filter()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.format"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.format()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.from_arrays"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.from_arrays()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.from_buffers"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.from_buffers()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.from_pandas"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.from_pandas()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.get_total_buffer_size"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.get_total_buffer_size()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.index"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.index()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.indices"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.indices</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.is_nan"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.is_nan()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.is_null"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.is_null()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.is_valid"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.is_valid()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.nbytes"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.nbytes</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.null_count"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.null_count</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.offset"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.offset</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.slice"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.slice()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.sort"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.sort()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.sum"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.sum()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.take"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.take()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.to_numpy"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.to_numpy()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.to_pandas"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.to_pandas()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.to_pylist"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.to_pylist()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.to_string"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.to_string()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.tolist"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.tolist()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.type"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.type</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.unique"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.unique()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.validate"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.validate()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.value_counts"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.value_counts()</span></code></a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyarrow.DictionaryArray.view"><code class="docutils literal notranslate"><span class="pre">DictionaryArray.view()</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav></div> |
| |
| <div class="sidebar-secondary-item"> |
| |
| |
| <div class="tocsection editthispage"> |
| <a href="https://github.com/apache/arrow/edit/main/docs/source/python/generated/pyarrow.DictionaryArray.rst"> |
| <i class="fa-solid fa-pencil"></i> |
| |
| |
| |
| Edit on GitHub |
| |
| |
| </a> |
| </div> |
| </div> |
| |
| </div></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| </footer> |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script src="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script> |
| <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <footer class="bd-footer"> |
| <div class="bd-footer__inner bd-page-width"> |
| |
| <div class="footer-items__start"> |
| |
| <div class="footer-item"> |
| |
| <p class="copyright"> |
| |
| © Copyright 2016-2024 Apache Software Foundation. |
| Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| <br/> |
| |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| |
| <p class="sphinx-version"> |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0. |
| <br/> |
| </p> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="footer-items__end"> |
| |
| <div class="footer-item"> |
| <p class="theme-version"> |
| Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.2. |
| </p></div> |
| |
| </div> |
| |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
