This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion-python.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new d9bd37f Publish built docs triggered by
433dbca009a25a78e698d2c703ef9f1e4177dae0
d9bd37f is described below
commit d9bd37f711bec5758170d34494fe089782925687
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed May 10 13:01:07 2023 +0000
Publish built docs triggered by 433dbca009a25a78e698d2c703ef9f1e4177dae0
---
_sources/generated/datafusion.Expr.rst.txt | 5 ++
generated/datafusion.Expr.html | 98 ++++++++++++++++++++++++++++-
genindex.html | 14 ++++-
objects.inv | Bin 1986 -> 2018 bytes
searchindex.js | 2 +-
5 files changed, 113 insertions(+), 6 deletions(-)
diff --git a/_sources/generated/datafusion.Expr.rst.txt
b/_sources/generated/datafusion.Expr.rst.txt
index 5c11434..856156c 100644
--- a/_sources/generated/datafusion.Expr.rst.txt
+++ b/_sources/generated/datafusion.Expr.rst.txt
@@ -18,12 +18,17 @@
~Expr.canonical_name
~Expr.cast
~Expr.column
+ ~Expr.column_name
~Expr.display_name
~Expr.is_null
~Expr.literal
+ ~Expr.python_value
+ ~Expr.rex_call_operands
+ ~Expr.rex_call_operator
~Expr.rex_type
~Expr.sort
~Expr.to_variant
+ ~Expr.types
diff --git a/generated/datafusion.Expr.html b/generated/datafusion.Expr.html
index de1e765..9a47835 100644
--- a/generated/datafusion.Expr.html
+++ b/generated/datafusion.Expr.html
@@ -258,6 +258,15 @@
</code>
</a>
</li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#datafusion.Expr.column_name">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ Expr.column_name()
+ </span>
+ </code>
+ </a>
+ </li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link"
href="#datafusion.Expr.display_name">
<code class="docutils literal notranslate">
@@ -285,6 +294,33 @@
</code>
</a>
</li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link"
href="#datafusion.Expr.python_value">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ Expr.python_value()
+ </span>
+ </code>
+ </a>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link"
href="#datafusion.Expr.rex_call_operands">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ Expr.rex_call_operands()
+ </span>
+ </code>
+ </a>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link"
href="#datafusion.Expr.rex_call_operator">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ Expr.rex_call_operator()
+ </span>
+ </code>
+ </a>
+ </li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#datafusion.Expr.rex_type">
<code class="docutils literal notranslate">
@@ -312,6 +348,15 @@
</code>
</a>
</li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#datafusion.Expr.types">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ Expr.types()
+ </span>
+ </code>
+ </a>
+ </li>
</ul>
</li>
</ul>
@@ -372,15 +417,27 @@
<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.column" title="datafusion.Expr.column"><code class="xref
py py-obj docutils literal notranslate"><span
class="pre">column</span></code></a>(value)</p></td>
<td><p></p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.display_name" title="datafusion.Expr.display_name"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">display_name</span></code></a>()</p></td>
+<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.column_name" title="datafusion.Expr.column_name"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">column_name</span></code></a>(plan)</p></td>
+<td><p></p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.display_name" title="datafusion.Expr.display_name"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">display_name</span></code></a>()</p></td>
<td><p>Returns the name of this expression as it should appear in a
schema.</p></td>
</tr>
-<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.is_null" title="datafusion.Expr.is_null"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">is_null</span></code></a>()</p></td>
+<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.is_null" title="datafusion.Expr.is_null"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">is_null</span></code></a>()</p></td>
<td><p></p></td>
</tr>
-<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.literal" title="datafusion.Expr.literal"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">literal</span></code></a>(value)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.literal" title="datafusion.Expr.literal"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">literal</span></code></a>(value)</p></td>
<td><p></p></td>
</tr>
+<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.python_value" title="datafusion.Expr.python_value"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">python_value</span></code></a>()</p></td>
+<td><p>Extracts the Expr value into a PyObject that can be shared with
Python</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.rex_call_operands"
title="datafusion.Expr.rex_call_operands"><code class="xref py py-obj docutils
literal notranslate"><span
class="pre">rex_call_operands</span></code></a>()</p></td>
+<td><p>Row expressions, Rex(s), operate on the concept of operands.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.rex_call_operator"
title="datafusion.Expr.rex_call_operator"><code class="xref py py-obj docutils
literal notranslate"><span
class="pre">rex_call_operator</span></code></a>()</p></td>
+<td><p>Extracts the operator associated with a RexType::Call</p></td>
+</tr>
<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.rex_type" title="datafusion.Expr.rex_type"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">rex_type</span></code></a>()</p></td>
<td><p>A Rex (Row Expression) specifies a single row of data.</p></td>
</tr>
@@ -390,6 +447,9 @@
<tr class="row-odd"><td><p><a class="reference internal"
href="#datafusion.Expr.to_variant" title="datafusion.Expr.to_variant"><code
class="xref py py-obj docutils literal notranslate"><span
class="pre">to_variant</span></code></a>()</p></td>
<td><p>Return the specific expression</p></td>
</tr>
+<tr class="row-even"><td><p><a class="reference internal"
href="#datafusion.Expr.types" title="datafusion.Expr.types"><code class="xref
py py-obj docutils literal notranslate"><span
class="pre">types</span></code></a>()</p></td>
+<td><p>Given the current <cite>Expr</cite> return the DataTypeMap which
represents the PythonType, Arrow DataType, and SqlType Enum which
represents</p></td>
+</tr>
</tbody>
</table>
<dl class="py method">
@@ -414,6 +474,11 @@
<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">column</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#datafusion.Expr.column" title="Permalink to this
definition">¶</a></dt>
<dd></dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datafusion.Expr.column_name">
+<span class="sig-name descname"><span
class="pre">column_name</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">plan</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#datafusion.Expr.column_name" title="Permalink to this
definition">¶</a></dt>
+<dd></dd></dl>
+
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.Expr.display_name">
<span class="sig-name descname"><span
class="pre">display_name</span></span><span class="sig-paren">(</span><span
class="sig-paren">)</span><a class="headerlink"
href="#datafusion.Expr.display_name" title="Permalink to this
definition">¶</a></dt>
@@ -431,6 +496,26 @@ will not include any CAST expressions.</p>
<em class="property"><span class="pre">static</span><span class="w">
</span></em><span class="sig-name descname"><span
class="pre">literal</span></span><span class="sig-paren">(</span><em
class="sig-param"><span class="n"><span
class="pre">value</span></span></em><span class="sig-paren">)</span><a
class="headerlink" href="#datafusion.Expr.literal" title="Permalink to this
definition">¶</a></dt>
<dd></dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datafusion.Expr.python_value">
+<span class="sig-name descname"><span
class="pre">python_value</span></span><span class="sig-paren">(</span><span
class="sig-paren">)</span><a class="headerlink"
href="#datafusion.Expr.python_value" title="Permalink to this
definition">¶</a></dt>
+<dd><p>Extracts the Expr value into a PyObject that can be shared with
Python</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="datafusion.Expr.rex_call_operands">
+<span class="sig-name descname"><span
class="pre">rex_call_operands</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink"
href="#datafusion.Expr.rex_call_operands" title="Permalink to this
definition">¶</a></dt>
+<dd><p>Row expressions, Rex(s), operate on the concept of operands. Different
variants of Expressions, Expr(s),
+store those operands in different datastructures. This function examines the
Expr variant and returns
+the operands to the calling logic as a Vec of PyExpr instances.</p>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="datafusion.Expr.rex_call_operator">
+<span class="sig-name descname"><span
class="pre">rex_call_operator</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink"
href="#datafusion.Expr.rex_call_operator" title="Permalink to this
definition">¶</a></dt>
+<dd><p>Extracts the operator associated with a RexType::Call</p>
+</dd></dl>
+
<dl class="py method">
<dt class="sig sig-object py" id="datafusion.Expr.rex_type">
<span class="sig-name descname"><span class="pre">rex_type</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink"
href="#datafusion.Expr.rex_type" title="Permalink to this definition">¶</a></dt>
@@ -451,6 +536,13 @@ as one of the possible valid <cite>RexTypes</cite>.</p>
<dd><p>Return the specific expression</p>
</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="datafusion.Expr.types">
+<span class="sig-name descname"><span class="pre">types</span></span><span
class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink"
href="#datafusion.Expr.types" title="Permalink to this definition">¶</a></dt>
+<dd><p>Given the current <cite>Expr</cite> return the DataTypeMap which
represents the
+PythonType, Arrow DataType, and SqlType Enum which represents</p>
+</dd></dl>
+
</dd></dl>
</section>
diff --git a/genindex.html b/genindex.html
index 33da016..0020ece 100644
--- a/genindex.html
+++ b/genindex.html
@@ -334,6 +334,8 @@
<li><a
href="generated/datafusion.DataFrame.html#datafusion.DataFrame.collect_partitioned">collect_partitioned()
(datafusion.DataFrame method)</a>
</li>
<li><a
href="generated/datafusion.Expr.html#datafusion.Expr.column">column()
(datafusion.Expr static method)</a>
+</li>
+ <li><a
href="generated/datafusion.Expr.html#datafusion.Expr.column_name">column_name()
(datafusion.Expr method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
@@ -595,6 +597,8 @@
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="generated/datafusion.functions.functions.html#datafusion.functions.functions.power">power()
(in module datafusion.functions.functions)</a>
+</li>
+ <li><a
href="generated/datafusion.Expr.html#datafusion.Expr.python_value">python_value()
(datafusion.Expr method)</a>
</li>
</ul></td>
</tr></table>
@@ -628,10 +632,10 @@
</li>
<li><a
href="generated/datafusion.SessionContext.html#datafusion.SessionContext.register_table">register_table()
(datafusion.SessionContext method)</a>
</li>
- </ul></td>
- <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="generated/datafusion.SessionContext.html#datafusion.SessionContext.register_udaf">register_udaf()
(datafusion.SessionContext method)</a>
</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
<li><a
href="generated/datafusion.SessionContext.html#datafusion.SessionContext.register_udf">register_udf()
(datafusion.SessionContext method)</a>
</li>
<li><a
href="generated/datafusion.DataFrame.html#datafusion.DataFrame.repartition">repartition()
(datafusion.DataFrame method)</a>
@@ -643,6 +647,10 @@
<li><a
href="generated/datafusion.functions.functions.html#datafusion.functions.functions.replace">replace()
(in module datafusion.functions.functions)</a>
</li>
<li><a
href="generated/datafusion.functions.functions.html#datafusion.functions.functions.reverse">reverse()
(in module datafusion.functions.functions)</a>
+</li>
+ <li><a
href="generated/datafusion.Expr.html#datafusion.Expr.rex_call_operands">rex_call_operands()
(datafusion.Expr method)</a>
+</li>
+ <li><a
href="generated/datafusion.Expr.html#datafusion.Expr.rex_call_operator">rex_call_operator()
(datafusion.Expr method)</a>
</li>
<li><a
href="generated/datafusion.Expr.html#datafusion.Expr.rex_type">rex_type()
(datafusion.Expr method)</a>
</li>
@@ -763,6 +771,8 @@
<li><a
href="generated/datafusion.functions.functions.html#datafusion.functions.functions.trim">trim()
(in module datafusion.functions.functions)</a>
</li>
<li><a
href="generated/datafusion.functions.functions.html#datafusion.functions.functions.trunc">trunc()
(in module datafusion.functions.functions)</a>
+</li>
+ <li><a
href="generated/datafusion.Expr.html#datafusion.Expr.types">types()
(datafusion.Expr method)</a>
</li>
</ul></td>
</tr></table>
diff --git a/objects.inv b/objects.inv
index b52f398..edcb460 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/searchindex.js b/searchindex.js
index 7406fe1..cdbb4e3 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api", "api/dataframe", "api/execution_context",
"api/expression", "api/functions", "api/object_store",
"generated/datafusion.DataFrame", "generated/datafusion.Expr",
"generated/datafusion.RuntimeConfig", "generated/datafusion.SessionConfig",
"generated/datafusion.SessionContext",
"generated/datafusion.functions.functions",
"generated/datafusion.object_store.object_store", "index"], "filenames":
["api.rst", "api/dataframe.rst", "api/execution_context.rst", " [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["api", "api/dataframe", "api/execution_context",
"api/expression", "api/functions", "api/object_store",
"generated/datafusion.DataFrame", "generated/datafusion.Expr",
"generated/datafusion.RuntimeConfig", "generated/datafusion.SessionConfig",
"generated/datafusion.SessionContext",
"generated/datafusion.functions.functions",
"generated/datafusion.object_store.object_store", "index"], "filenames":
["api.rst", "api/dataframe.rst", "api/execution_context.rst", " [...]
\ No newline at end of file
