| <!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="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <title>Introduction — Apache Arrow 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/graphviz.css?v=4ae1632d" /> |
| <link rel="stylesheet" type="text/css" href="../_static/theme_overrides.css?v=dca7052a" /> |
| |
| <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> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Python Extensions" href="ffi.html" /> |
| <link rel="prev" title="SQL" href="../user-guide/sql.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"> |
| <a class="navbar-brand" href="../index.html"> |
| <img src="../_static/images/2x_bgwhite_original.png" class="logo" alt="logo"> |
| </a> |
| |
| <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"> |
| LINKS |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://github.com/apache/datafusion-python"> |
| Github and Issue Tracker |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/"> |
| Rust's API Docs |
| </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 external" href="https://github.com/apache/datafusion-python/tree/main/examples"> |
| Examples |
| </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/basics.html"> |
| Concepts |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../user-guide/data-sources.html"> |
| Data Sources |
| </a> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../user-guide/dataframe/index.html"> |
| DataFrames |
| </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/dataframe/rendering.html"> |
| HTML Rendering in Jupyter |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../user-guide/common-operations/index.html"> |
| Common Operations |
| </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/common-operations/views.html"> |
| Registering Views |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/basic-info.html"> |
| Basic Operations |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/select-and-filter.html"> |
| Column Selections |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/expressions.html"> |
| Expressions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/joins.html"> |
| Joins |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/functions.html"> |
| Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/aggregations.html"> |
| Aggregation |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/windows.html"> |
| Window Functions |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/common-operations/udf-and-udfa.html"> |
| User-Defined Functions |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../user-guide/io/index.html"> |
| IO |
| </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="../user-guide/io/arrow.html"> |
| Arrow |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/io/avro.html"> |
| Avro |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/io/csv.html"> |
| CSV |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/io/json.html"> |
| JSON |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/io/parquet.html"> |
| Parquet |
| </a> |
| </li> |
| <li class="toctree-l2"> |
| <a class="reference internal" href="../user-guide/io/table_provider.html"> |
| Custom Table Provider |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../user-guide/configuration.html"> |
| Configuration |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="../user-guide/sql.html"> |
| SQL |
| </a> |
| </li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"> |
| <span class="caption-text"> |
| CONTRIBUTOR GUIDE |
| </span> |
| </p> |
| <ul class="current nav bd-sidenav"> |
| <li class="toctree-l1 current active"> |
| <a class="current reference internal" href="#"> |
| Introduction |
| </a> |
| </li> |
| <li class="toctree-l1"> |
| <a class="reference internal" href="ffi.html"> |
| Python Extensions |
| </a> |
| </li> |
| </ul> |
| <p aria-level="2" class="caption" role="heading"> |
| <span class="caption-text"> |
| API |
| </span> |
| </p> |
| <ul class="nav bd-sidenav"> |
| <li class="toctree-l1 has-children"> |
| <a class="reference internal" href="../autoapi/index.html"> |
| API Reference |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/> |
| <label for="toctree-checkbox-4"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l2 has-children"> |
| <a class="reference internal" href="../autoapi/datafusion/index.html"> |
| datafusion |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/> |
| <label for="toctree-checkbox-5"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/catalog/index.html"> |
| datafusion.catalog |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/context/index.html"> |
| datafusion.context |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/dataframe/index.html"> |
| datafusion.dataframe |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/dataframe_formatter/index.html"> |
| datafusion.dataframe_formatter |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/expr/index.html"> |
| datafusion.expr |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/functions/index.html"> |
| datafusion.functions |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/html_formatter/index.html"> |
| datafusion.html_formatter |
| </a> |
| </li> |
| <li class="toctree-l3 has-children"> |
| <a class="reference internal" href="../autoapi/datafusion/input/index.html"> |
| datafusion.input |
| </a> |
| <input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/> |
| <label for="toctree-checkbox-6"> |
| <i class="fas fa-chevron-down"> |
| </i> |
| </label> |
| <ul> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../autoapi/datafusion/input/base/index.html"> |
| datafusion.input.base |
| </a> |
| </li> |
| <li class="toctree-l4"> |
| <a class="reference internal" href="../autoapi/datafusion/input/location/index.html"> |
| datafusion.input.location |
| </a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/io/index.html"> |
| datafusion.io |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/object_store/index.html"> |
| datafusion.object_store |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/plan/index.html"> |
| datafusion.plan |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/record_batch/index.html"> |
| datafusion.record_batch |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/substrait/index.html"> |
| datafusion.substrait |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/unparser/index.html"> |
| datafusion.unparser |
| </a> |
| </li> |
| <li class="toctree-l3"> |
| <a class="reference internal" href="../autoapi/datafusion/user_defined/index.html"> |
| datafusion.user_defined |
| </a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| |
| |
| </div> |
| </nav> |
| </div> |
| <div class="sidebar-end-items"> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="d-none d-xl-block col-xl-2 bd-toc"> |
| |
| |
| <div class="toc-item"> |
| |
| <div class="tocsection onthispage pt-5 pb-3"> |
| <i class="fas fa-list"></i> On this page |
| </div> |
| |
| <nav id="bd-toc-nav"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#how-to-develop"> |
| How to develop |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#running-installing-pre-commit-hooks"> |
| Running & Installing pre-commit hooks |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#guidelines-for-separating-python-and-rust-code"> |
| Guidelines for Separating Python and Rust Code |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#update-dependencies"> |
| Update Dependencies |
| </a> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"> |
| <a class="reference internal nav-link" href="#improving-build-speed"> |
| Improving Build Speed |
| </a> |
| </li> |
| </ul> |
| |
| </nav> |
| </div> |
| |
| <div class="toc-item"> |
| |
| </div> |
| |
| |
| </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> |
| |
| <section id="introduction"> |
| <h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h1> |
| <p>We welcome and encourage contributions of all kinds, such as:</p> |
| <ol class="arabic simple"> |
| <li><p>Tickets with issue reports of feature requests</p></li> |
| <li><p>Documentation improvements</p></li> |
| <li><p>Code, both PR and (especially) PR Review.</p></li> |
| </ol> |
| <p>In addition to submitting new PRs, we have a healthy tradition of community members reviewing each other’s PRs. |
| Doing so is a great way to help the community as well as get more familiar with Rust and the relevant codebases.</p> |
| <p>Before opening a pull request that touches PyO3 bindings, please review the |
| <a class="reference internal" href="ffi.html#ffi-pyclass-mutability"><span class="std std-ref">PyO3 class mutability guidelines</span></a> so you can flag missing |
| <code class="docutils literal notranslate"><span class="pre">#[pyclass(frozen)]</span></code> annotations during development and review.</p> |
| <section id="how-to-develop"> |
| <h2>How to develop<a class="headerlink" href="#how-to-develop" title="Link to this heading">¶</a></h2> |
| <p>This assumes that you have rust and cargo installed. We use the workflow recommended by |
| <a class="reference external" href="https://github.com/PyO3/pyo3">pyo3</a> and <a class="reference external" href="https://github.com/PyO3/maturin">maturin</a>. We recommend using |
| <a class="reference external" href="https://docs.astral.sh/uv/">uv</a> for python package management.</p> |
| <p>By default <cite>uv</cite> will attempt to build the datafusion python package. For our development we prefer to build manually. This means |
| that when creating your virtual environment using <cite>uv sync</cite> you need to pass in the additional <cite>–no-install-package datafusion</cite> |
| and for <cite>uv run</cite> commands the additional parameter <cite>–no-project</cite></p> |
| <p>Bootstrap:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># fetch this repo</span> |
| git<span class="w"> </span>clone<span class="w"> </span>git@github.com:apache/datafusion-python.git |
| <span class="c1"># create the virtual environment</span> |
| uv<span class="w"> </span>sync<span class="w"> </span>--dev<span class="w"> </span>--no-install-package<span class="w"> </span>datafusion |
| <span class="c1"># activate the environment</span> |
| <span class="nb">source</span><span class="w"> </span>.venv/bin/activate |
| </pre></div> |
| </div> |
| <p>The tests rely on test data in git submodules.</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>submodule<span class="w"> </span>init |
| git<span class="w"> </span>submodule<span class="w"> </span>update |
| </pre></div> |
| </div> |
| <p>Whenever rust code changes (your changes or via <cite>git pull</cite>):</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># make sure you activate the venv using "source .venv/bin/activate" first</span> |
| maturin<span class="w"> </span>develop<span class="w"> </span>-uv |
| python<span class="w"> </span>-m<span class="w"> </span>pytest |
| </pre></div> |
| </div> |
| </section> |
| <section id="running-installing-pre-commit-hooks"> |
| <h2>Running & Installing pre-commit hooks<a class="headerlink" href="#running-installing-pre-commit-hooks" title="Link to this heading">¶</a></h2> |
| <p>arrow-datafusion-python takes advantage of <a class="reference external" href="https://pre-commit.com/">pre-commit</a> to assist developers with code linting to help reduce the number of commits that ultimately fail in CI due to linter errors. Using the pre-commit hooks is optional for the developer but certainly helpful for keeping PRs clean and concise.</p> |
| <p>Our pre-commit hooks can be installed by running <code class="code docutils literal notranslate"><span class="pre">pre-commit</span> <span class="pre">install</span></code>, which will install the configurations in your ARROW_DATAFUSION_PYTHON_ROOT/.github directory and run each time you perform a commit, failing to complete the commit if an offending lint is found allowing you to make changes locally before pushing.</p> |
| <p>The pre-commit hooks can also be run adhoc without installing them by simply running <code class="code docutils literal notranslate"><span class="pre">pre-commit</span> <span class="pre">run</span> <span class="pre">--all-files</span></code></p> |
| </section> |
| <section id="guidelines-for-separating-python-and-rust-code"> |
| <h2>Guidelines for Separating Python and Rust Code<a class="headerlink" href="#guidelines-for-separating-python-and-rust-code" title="Link to this heading">¶</a></h2> |
| <p>Version 40 of <code class="docutils literal notranslate"><span class="pre">datafusion-python</span></code> introduced <code class="docutils literal notranslate"><span class="pre">python</span></code> wrappers around the <code class="docutils literal notranslate"><span class="pre">pyo3</span></code> generated code to vastly improve the user experience. (See the <a class="reference external" href="https://datafusion.apache.org/blog/2024/08/20/python-datafusion-40.0.0/">blog post</a> and <a class="reference external" href="https://github.com/apache/datafusion-python/pull/750">pull request</a> for more details.)</p> |
| <p>Mostly, the <code class="docutils literal notranslate"><span class="pre">python</span></code> code is limited to pure wrappers with type hints and good docstrings, but there are a few reasons for when the code does more:</p> |
| <ol class="arabic simple"> |
| <li><p>Trivial aliases like <a class="reference internal" href="../autoapi/datafusion/functions/index.html#datafusion.functions.array_append" title="datafusion.functions.array_append"><code class="xref py py-func docutils literal notranslate"><span class="pre">array_append()</span></code></a> and <a class="reference internal" href="../autoapi/datafusion/functions/index.html#datafusion.functions.list_append" title="datafusion.functions.list_append"><code class="xref py py-func docutils literal notranslate"><span class="pre">list_append()</span></code></a>.</p></li> |
| <li><p>Simple type conversion, like from a <code class="docutils literal notranslate"><span class="pre">path</span></code> to a <code class="docutils literal notranslate"><span class="pre">string</span></code> of the path or from <code class="docutils literal notranslate"><span class="pre">number</span></code> to <code class="docutils literal notranslate"><span class="pre">lit(number)</span></code>.</p></li> |
| <li><p>The additional code makes an API <strong>much</strong> more pythonic, like we do for <a class="reference internal" href="../autoapi/datafusion/functions/index.html#datafusion.functions.named_struct" title="datafusion.functions.named_struct"><code class="xref py py-func docutils literal notranslate"><span class="pre">named_struct()</span></code></a> (see <a class="reference external" href="https://github.com/apache/datafusion-python/blob/a0913c728f5f323c1eb4913e614c9d996083e274/python/datafusion/functions.py#L1040-L1046">source code</a>).</p></li> |
| </ol> |
| </section> |
| <section id="update-dependencies"> |
| <h2>Update Dependencies<a class="headerlink" href="#update-dependencies" title="Link to this heading">¶</a></h2> |
| <p>To change test dependencies, change the <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code> and run</p> |
| <p>To update dependencies, run</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>uv<span class="w"> </span>sync<span class="w"> </span>--dev<span class="w"> </span>--no-install-package<span class="w"> </span>datafusion |
| </pre></div> |
| </div> |
| </section> |
| <section id="improving-build-speed"> |
| <h2>Improving Build Speed<a class="headerlink" href="#improving-build-speed" title="Link to this heading">¶</a></h2> |
| <p>The <a class="reference external" href="https://github.com/PyO3/pyo3">pyo3</a> dependency of this project contains a <code class="docutils literal notranslate"><span class="pre">build.rs</span></code> file which |
| can cause it to rebuild frequently. You can prevent this from happening by defining a <code class="docutils literal notranslate"><span class="pre">PYO3_CONFIG_FILE</span></code> |
| environment variable that points to a file with your build configuration. Whenever your build configuration |
| changes, such as during some major version updates, you will need to regenerate this file. This variable |
| should point to a fully resolved path on your build machine.</p> |
| <p>To generate this file, use the following command:</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nv">PYO3_PRINT_CONFIG</span><span class="o">=</span><span class="m">1</span><span class="w"> </span>cargo<span class="w"> </span>build |
| </pre></div> |
| </div> |
| <p>This will generate some output that looks like the following. You will want to copy these contents intro |
| a file. If you place this file in your project directory with filename <code class="docutils literal notranslate"><span class="pre">.pyo3_build_config</span></code> it will |
| be ignored by <code class="docutils literal notranslate"><span class="pre">git</span></code>.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">implementation</span><span class="o">=</span><span class="n">CPython</span> |
| <span class="n">version</span><span class="o">=</span><span class="mf">3.9</span> |
| <span class="n">shared</span><span class="o">=</span><span class="n">true</span> |
| <span class="n">abi3</span><span class="o">=</span><span class="n">true</span> |
| <span class="n">lib_name</span><span class="o">=</span><span class="n">python3</span><span class="mf">.12</span> |
| <span class="n">lib_dir</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">homebrew</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">python</span><span class="o">@</span><span class="mf">3.12</span><span class="o">/</span><span class="n">Frameworks</span><span class="o">/</span><span class="n">Python</span><span class="o">.</span><span class="n">framework</span><span class="o">/</span><span class="n">Versions</span><span class="o">/</span><span class="mf">3.12</span><span class="o">/</span><span class="n">lib</span> |
| <span class="n">executable</span><span class="o">=/</span><span class="n">Users</span><span class="o">/</span><span class="n">myusername</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">datafusion</span><span class="o">-</span><span class="n">python</span><span class="o">/.</span><span class="n">venv</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">python</span> |
| <span class="n">pointer_width</span><span class="o">=</span><span class="mi">64</span> |
| <span class="n">build_flags</span><span class="o">=</span> |
| <span class="n">suppress_build_script_link_lines</span><span class="o">=</span><span class="n">false</span> |
| </pre></div> |
| </div> |
| <p>Add the environment variable to your system.</p> |
| <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">export</span><span class="w"> </span><span class="nv">PYO3_CONFIG_FILE</span><span class="o">=</span><span class="s2">"/Users//myusername/src/datafusion-python/.pyo3_build_config"</span> |
| </pre></div> |
| </div> |
| <p>If you are on a Mac and you use VS Code for your IDE, you will want to add these variables |
| to your settings. You can find the appropriate rust flags by looking in the |
| <code class="docutils literal notranslate"><span class="pre">.cargo/config.toml</span></code> file.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"rust-analyzer.cargo.extraEnv"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"RUSTFLAGS"</span><span class="p">:</span> <span class="s2">"-C link-arg=-undefined -C link-arg=dynamic_lookup"</span><span class="p">,</span> |
| <span class="s2">"PYO3_CONFIG_FILE"</span><span class="p">:</span> <span class="s2">"/Users/myusername/src/datafusion-python/.pyo3_build_config"</span> |
| <span class="p">},</span> |
| <span class="s2">"rust-analyzer.runnables.extraEnv"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"RUSTFLAGS"</span><span class="p">:</span> <span class="s2">"-C link-arg=-undefined -C link-arg=dynamic_lookup"</span><span class="p">,</span> |
| <span class="s2">"PYO3_CONFIG_FILE"</span><span class="p">:</span> <span class="s2">"/Users/myusername/src/personal/datafusion-python/.pyo3_build_config"</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </section> |
| </section> |
| |
| |
| </div> |
| |
| |
| <!-- Previous / next buttons --> |
| <div class='prev-next-area'> |
| <a class='left-prev' id="prev-link" href="../user-guide/sql.html" title="previous page"> |
| <i class="fas fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">SQL</p> |
| </div> |
| </a> |
| <a class='right-next' id="next-link" href="ffi.html" title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Python Extensions</p> |
| </div> |
| <i class="fas fa-angle-right"></i> |
| </a> |
| </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"> |
| © 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 Arrow DataFusion, Arrow DataFusion, Apache, the Apache feather logo, and the Apache Arrow 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> |
