blob: 1d0508c4f17da7e76a645565109bbe00badc0e00 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; Apache DataFusion documentation</title>
<link href="_static/styles/theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link href="_static/styles/pydata-sphinx-theme.css?digest=1999514e3f237ded88cf" rel="stylesheet">
<link rel="stylesheet"
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/styles/pydata-sphinx-theme.css?v=1140d252" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=c6d785ac" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf">
<script src="_static/documentation_options.js?v=8a448e45"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="true" defer="true" src="https://buttons.github.io/buttons.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
<!-- Google Analytics -->
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<div class="container-fluid" id="banner"></div>
<div class="container-xl">
<div class="row">
<!-- Only show if we have sidebars configured, else just a small margin -->
<div class="col-12 col-md-3 bd-sidebar">
<div class="sidebar-start-items">
<form class="bd-search d-flex align-items-center" action="search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<p aria-level="2" class="caption" role="heading">
<span class="caption-text">
ASF Links
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference external" href="https://apache.org">
Apache Software Foundation
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://www.apache.org/licenses/">
License
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://www.apache.org/foundation/sponsorship.html">
Donate
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://www.apache.org/foundation/thanks.html">
Thanks
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://www.apache.org/security/">
Security
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading">
<span class="caption-text">
Links
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference external" href="https://github.com/apache/datafusion">
GitHub and Issue Tracker
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://crates.io/crates/datafusion">
crates.io
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/">
API Docs
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://datafusion.apache.org/blog/">
Blog
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md">
Code of conduct
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="download.html">
Download
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading">
<span class="caption-text">
User Guide
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="user-guide/introduction.html">
Introduction
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/example-usage.html">
Example Usage
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/features.html">
Features
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/concepts-readings-events.html">
Concepts, Readings, Events
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/crate-configuration.html">
Crate Configuration
</a>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="user-guide/cli/index.html">
DataFusion CLI
</a>
<input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/>
<label for="toctree-checkbox-1">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/cli/overview.html">
Overview
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/cli/installation.html">
Installation
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/cli/usage.html">
Usage
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/cli/datasources.html">
Local Files / Directories
</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/dataframe.html">
DataFrame API
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/expressions.html">
Expression API
</a>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="user-guide/sql/index.html">
SQL Reference
</a>
<input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/>
<label for="toctree-checkbox-2">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/data_types.html">
Data Types
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/select.html">
SELECT syntax
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/subqueries.html">
Subqueries
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/ddl.html">
DDL
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/dml.html">
DML
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/explain.html">
EXPLAIN
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/information_schema.html">
Information Schema
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/operators.html">
Operators
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/aggregate_functions.html">
Aggregate Functions
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/window_functions.html">
Window Functions
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/scalar_functions.html">
Scalar Functions
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/special_functions.html">
Special Functions
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/write_options.html">
Write Options
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="user-guide/sql/prepared_statements.html">
Prepared Statements
</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/configs.html">
Configuration Settings
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/explain-usage.html">
Reading Explain Plans
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="user-guide/faq.html">
Frequently Asked Questions
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading">
<span class="caption-text">
Library User Guide
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/index.html">
Introduction
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/extensions.html">
Extensions List
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/using-the-sql-api.html">
Using the SQL API
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/working-with-exprs.html">
Working with
<code class="docutils literal notranslate">
<span class="pre">
Expr
</span>
</code>
s
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/using-the-dataframe-api.html">
Using the DataFrame API
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/building-logical-plans.html">
Building Logical Plans
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/catalogs.html">
Catalogs, Schemas, and Tables
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/adding-udfs.html">
Adding User Defined Functions: Scalar/Window/Aggregate/Table Functions
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/custom-table-providers.html">
Custom Table Provider
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/extending-operators.html">
Extending DataFusion’s operators: custom LogicalPlan and Execution Plans
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/profiling.html">
Profiling Cookbook
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/query-optimizer.html">
DataFusion Query Optimizer
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="library-user-guide/api-health.html">
API health policy
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading">
<span class="caption-text">
Contributor Guide
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/index.html">
Introduction
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/communication.html">
Communication
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/getting_started.html">
Getting Started
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/architecture.html">
Architecture
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/testing.html">
Testing
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/howtos.html">
HOWTOs
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/roadmap.html">
Roadmap
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/governance.html">
Governance
</a>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/inviting.html">
Inviting New Committers and PMC Members
</a>
</li>
<li class="toctree-l1 has-children">
<a class="reference internal" href="contributor-guide/specification/index.html">
Specifications
</a>
<input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/>
<label for="toctree-checkbox-3">
<i class="fas fa-chevron-down">
</i>
</label>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="contributor-guide/specification/invariants.html">
Invariants
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="contributor-guide/specification/output-field-name-semantic.html">
Output field name semantics
</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="reference internal" href="contributor-guide/gsoc_application_guidelines.html">
GSoC Application Guidelines
</a>
</li>
</ul>
<p aria-level="2" class="caption" role="heading">
<span class="caption-text">
DataFusion Subprojects
</span>
</p>
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a class="reference external" href="https://arrow.apache.org/ballista/">
DataFusion Ballista
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://datafusion.apache.org/comet/">
DataFusion Comet
</a>
</li>
<li class="toctree-l1">
<a class="reference external" href="https://datafusion.apache.org/python/">
DataFusion Python
</a>
</li>
</ul>
</div>
<a class="navbar-brand" href="index.html">
<img src="_static/images/2x_bgwhite_original.png" class="logo" alt="logo">
</a>
</nav>
</div>
<div class="sidebar-end-items">
</div>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
</div>
</div>
<!-- Previous / next buttons -->
<div class='prev-next-area'>
</div>
</main>
</div>
</div>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=1999514e3f237ded88cf"></script>
<!-- Based on pydata_sphinx_theme/footer.html -->
<footer class="footer mt-5 mt-md-0">
<div class="container">
<div class="footer-item">
<p class="copyright">
&copy; Copyright 2019-2024, Apache Software Foundation.<br>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br>
</p>
</div>
<div class="footer-item">
<p>Apache DataFusion, Apache, the Apache feather logo, and the Apache DataFusion project logo</p>
<p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
</div>
</div>
</footer>
</body>
</html>