This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 0150cd93a0 Publish built docs triggered by
dc4e3ab473ef949558ab4540dda188e168262958
0150cd93a0 is described below
commit 0150cd93a00b6cad459060972df3b8e212cea849
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Dec 9 22:43:26 2025 +0000
Publish built docs triggered by dc4e3ab473ef949558ab4540dda188e168262958
---
_sources/user-guide/cli/functions.md.txt | 32 ++++++++++++++++
searchindex.js | 2 +-
user-guide/cli/functions.html | 65 ++++++++++++++++++++++++++++++++
user-guide/cli/index.html | 1 +
4 files changed, 99 insertions(+), 1 deletion(-)
diff --git a/_sources/user-guide/cli/functions.md.txt
b/_sources/user-guide/cli/functions.md.txt
index 305b53c16f..f3b0163534 100644
--- a/_sources/user-guide/cli/functions.md.txt
+++ b/_sources/user-guide/cli/functions.md.txt
@@ -138,5 +138,37 @@ The columns of the returned table are:
| hits | UInt64 | Number of times the cached metadata has
been accessed |
| extra | Utf8 | Extra information about the cached
metadata (e.g., if page index information is included) |
+## `statistics_cache`
+
+Similarly to the `metadata_cache`, the `statistics_cache` function can be used
to show information
+about the File Statistics Cache that is used by the [`ListingTable`]
implementation in DataFusion.
+For the statistics to be collected, the config
`datafusion.execution.collect_statistics` must be
+enabled.
+
+You can inspect the statistics cache by querying the `statistics_cache`
function. For example:
+
+```sql
+> select * from statistics_cache();
++------------------+---------------------+-----------------+------------------------+---------+-----------------+-------------+--------------------+-----------------------+
+| path | file_modified | file_size_bytes | e_tag
| version | num_rows | num_columns | table_size_bytes |
statistics_size_bytes |
++------------------+---------------------+-----------------+------------------------+---------+-----------------+-------------+--------------------+-----------------------+
+| .../hits.parquet | 2022-06-25T22:22:22 | 14779976446 |
0-5e24d1ee16380-370f48 | NULL | Exact(99997497) | 105 |
Exact(36445943240) | 0 |
++------------------+---------------------+-----------------+------------------------+---------+-----------------+-------------+--------------------+-----------------------+
+```
+
+The columns of the returned table are:
+
+| column_name | data_type | Description
|
+| --------------------- | --------- |
---------------------------------------------------------------------------- |
+| path | Utf8 | File path relative to the object store /
filesystem root |
+| file_modified | Timestamp | Last modified time of the file
|
+| file_size_bytes | UInt64 | Size of the file in bytes
|
+| e_tag | Utf8 | [Entity Tag] (ETag) of the file if
available |
+| version | Utf8 | Version of the file if available (for
object stores that support versioning) |
+| num_rows | Utf8 | Number of rows in the table
|
+| num_columns | UInt64 | Number of columns in the table
|
+| table_size_bytes | Utf8 | Size of the table, in bytes
|
+| statistics_size_bytes | UInt64 | Size of the cached statistics in memory
|
+
[`listingtable`]:
https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingTable.html
[entity tag]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
diff --git a/searchindex.js b/searchindex.js
index 8e38e8f952..f9b367daeb 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"!=":[[60,"op-neq"]],"!~":[[60,"op-re-not-match"]],"!~*":[[60,"op-re-not-match-i"]],"!~~":[[60,"id19"]],"!~~*":[[60,"id20"]],"#":[[60,"op-bit-xor"]],"%":[[60,"op-modulo"]],"&":[[60,"op-bit-and"]],"(relation,
name) tuples in logical fields and logical columns are
unique":[[13,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[60,"op-multiply"]],"+":[[60,"op-plus"]],"-":[[60,"op-minus"]],"/":[[60,"op-divide"]],"<":[[60,"op-lt"]],"<
[...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"!=":[[60,"op-neq"]],"!~":[[60,"op-re-not-match"]],"!~*":[[60,"op-re-not-match-i"]],"!~~":[[60,"id19"]],"!~~*":[[60,"id20"]],"#":[[60,"op-bit-xor"]],"%":[[60,"op-modulo"]],"&":[[60,"op-bit-and"]],"(relation,
name) tuples in logical fields and logical columns are
unique":[[13,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[60,"op-multiply"]],"+":[[60,"op-plus"]],"-":[[60,"op-minus"]],"/":[[60,"op-divide"]],"<":[[60,"op-lt"]],"<
[...]
\ No newline at end of file
diff --git a/user-guide/cli/functions.html b/user-guide/cli/functions.html
index 07f13da645..3057c15daf 100644
--- a/user-guide/cli/functions.html
+++ b/user-guide/cli/functions.html
@@ -618,6 +618,70 @@ a table reference.</p>
</table>
</div>
</section>
+<section id="statistics-cache">
+<h2><code class="docutils literal notranslate"><span
class="pre">statistics_cache</span></code><a class="headerlink"
href="#statistics-cache" title="Link to this heading">#</a></h2>
+<p>Similarly to the <code class="docutils literal notranslate"><span
class="pre">metadata_cache</span></code>, the <code class="docutils literal
notranslate"><span class="pre">statistics_cache</span></code> function can be
used to show information
+about the File Statistics Cache that is used by the <a class="reference
external"
href="https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingTable.html";><code
class="docutils literal notranslate"><span
class="pre">ListingTable</span></code></a> implementation in DataFusion.
+For the statistics to be collected, the config <code class="docutils literal
notranslate"><span
class="pre">datafusion.execution.collect_statistics</span></code> must be
+enabled.</p>
+<p>You can inspect the statistics cache by querying the <code class="docutils
literal notranslate"><span class="pre">statistics_cache</span></code> function.
For example:</p>
+<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">select</span><span class="w"> </span><span
class="o">*</span><span class="w"> </span><span class="k">from</span><span
class="w"> </span><span class="n">statistics_cache</span><span
class="p">();</span>
+<span class="o">+</span><span
class="c1">------------------+---------------------+-----------------+------------------------+---------+-----------------+-------------+--------------------+-----------------------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="n">path</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span
class="n">file_modified</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span
class="n">file_size_bytes</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="n">e_tag</span><span
class="w"> </span><span class="o">|</span><span class="w">
[...]
+<span class="o">+</span><span
class="c1">------------------+---------------------+-----------------+------------------------+---------+-----------------+-------------+--------------------+-----------------------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="p">...</span><span class="o">/</span><span class="n">hits</span><span
class="p">.</span><span class="n">parquet</span><span class="w"> </span><span
class="o">|</span><span class="w"> </span><span class="mi">2022</span><span
class="o">-</span><span class="mi">06</span><span class="o">-</span><span
class="mi">25</span><span class="n">T22</span><span class="p">:</span><span
class="mi">22</span><span class="p">:</span><span class=" [...]
+<span class="o">+</span><span
class="c1">------------------+---------------------+-----------------+------------------------+---------+-----------------+-------------+--------------------+-----------------------+</span>
+</pre></div>
+</div>
+<p>The columns of the returned table are:</p>
+<div class="pst-scrollable-table-container"><table class="table">
+<thead>
+<tr class="row-odd"><th class="head"><p>column_name</p></th>
+<th class="head"><p>data_type</p></th>
+<th class="head"><p>Description</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>path</p></td>
+<td><p>Utf8</p></td>
+<td><p>File path relative to the object store / filesystem root</p></td>
+</tr>
+<tr class="row-odd"><td><p>file_modified</p></td>
+<td><p>Timestamp</p></td>
+<td><p>Last modified time of the file</p></td>
+</tr>
+<tr class="row-even"><td><p>file_size_bytes</p></td>
+<td><p>UInt64</p></td>
+<td><p>Size of the file in bytes</p></td>
+</tr>
+<tr class="row-odd"><td><p>e_tag</p></td>
+<td><p>Utf8</p></td>
+<td><p><a class="reference external"
href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag";>Entity
Tag</a> (ETag) of the file if available</p></td>
+</tr>
+<tr class="row-even"><td><p>version</p></td>
+<td><p>Utf8</p></td>
+<td><p>Version of the file if available (for object stores that support
versioning)</p></td>
+</tr>
+<tr class="row-odd"><td><p>num_rows</p></td>
+<td><p>Utf8</p></td>
+<td><p>Number of rows in the table</p></td>
+</tr>
+<tr class="row-even"><td><p>num_columns</p></td>
+<td><p>UInt64</p></td>
+<td><p>Number of columns in the table</p></td>
+</tr>
+<tr class="row-odd"><td><p>table_size_bytes</p></td>
+<td><p>Utf8</p></td>
+<td><p>Size of the table, in bytes</p></td>
+</tr>
+<tr class="row-even"><td><p>statistics_size_bytes</p></td>
+<td><p>UInt64</p></td>
+<td><p>Size of the cached statistics in memory</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</section>
</section>
@@ -669,6 +733,7 @@ a table reference.</p>
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#parquet-metadata"><code class="docutils literal notranslate"><span
class="pre">parquet_metadata</span></code></a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#metadata-cache"><code class="docutils literal notranslate"><span
class="pre">metadata_cache</span></code></a></li>
+<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link"
href="#statistics-cache"><code class="docutils literal notranslate"><span
class="pre">statistics_cache</span></code></a></li>
</ul>
</nav></div>
diff --git a/user-guide/cli/index.html b/user-guide/cli/index.html
index cb47c804bc..f68d9c3810 100644
--- a/user-guide/cli/index.html
+++ b/user-guide/cli/index.html
@@ -428,6 +428,7 @@
<li class="toctree-l1"><a class="reference internal" href="functions.html">CLI
Specific Functions</a><ul>
<li class="toctree-l2"><a class="reference internal"
href="functions.html#parquet-metadata"><code class="docutils literal
notranslate"><span class="pre">parquet_metadata</span></code></a></li>
<li class="toctree-l2"><a class="reference internal"
href="functions.html#metadata-cache"><code class="docutils literal
notranslate"><span class="pre">metadata_cache</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal"
href="functions.html#statistics-cache"><code class="docutils literal
notranslate"><span class="pre">statistics_cache</span></code></a></li>
</ul>
</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
