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/sedona-spatialbench.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 96b9cce update documentation for main branch
96b9cce is described below
commit 96b9cce1fc8d91365189d1d9378237ae23c51d4a
Author: GitHub Actions <[email protected]>
AuthorDate: Fri Sep 19 18:27:32 2025 +0000
update documentation for main branch
---
index.html | 2 +-
overview-methodology/index.html | 179 ++++++++++++++++++++++++++++++++++++++--
search/search_index.json | 2 +-
3 files changed, 172 insertions(+), 11 deletions(-)
diff --git a/index.html b/index.html
index 9bd776e..ff02e21 100644
--- a/index.html
+++ b/index.html
@@ -754,7 +754,7 @@
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 24 24"><path d="M21
13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6
0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4
2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10
9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1
7.5 7.1 7.9l-.1.2z"></path></svg>
</span>
- <span class="git-revision-date-localized-plugin
git-revision-date-localized-plugin-datetime" title="September 19, 2025 06:08:03
UTC">September 19, 2025 06:08:03</span>
+ <span class="git-revision-date-localized-plugin
git-revision-date-localized-plugin-datetime" title="September 19, 2025 18:26:39
UTC">September 19, 2025 18:26:39</span>
</span>
diff --git a/overview-methodology/index.html b/overview-methodology/index.html
index da4f8f4..33d7236 100644
--- a/overview-methodology/index.html
+++ b/overview-methodology/index.html
@@ -82,7 +82,7 @@
<div data-md-component="skip">
- <a href="#todo" class="md-skip">
+ <a href="#spatialbench-overview-and-methodology" class="md-skip">
Skip to content
</a>
@@ -398,6 +398,8 @@
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
+
+
<label class="md-nav__link md-nav__link--active" for="__toc">
@@ -430,6 +432,8 @@
+
+
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
@@ -438,9 +442,63 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#todo" class="md-nav__link">
+ <a href="#why-spatialbench" class="md-nav__link">
+ <span class="md-ellipsis">
+ Why SpatialBench?
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#hardware-and-software" class="md-nav__link">
+ <span class="md-ellipsis">
+ Hardware and software
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#accurately-comparing-different-engines" class="md-nav__link">
+ <span class="md-ellipsis">
+ Accurately comparing different engines
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#engine-tuning-in-benchmarks" class="md-nav__link">
+ <span class="md-ellipsis">
+ Engine tuning in benchmarks
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#open-source-benchmarks-vs-vendor-benchmarks" class="md-nav__link">
+ <span class="md-ellipsis">
+ Open source benchmarks vs. vendor benchmarks
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#how-to-contribute" class="md-nav__link">
+ <span class="md-ellipsis">
+ How to contribute
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#future-work" class="md-nav__link">
<span class="md-ellipsis">
- TODO
+ Future work
</span>
</a>
@@ -559,6 +617,8 @@
+
+
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
@@ -567,9 +627,63 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
- <a href="#todo" class="md-nav__link">
+ <a href="#why-spatialbench" class="md-nav__link">
+ <span class="md-ellipsis">
+ Why SpatialBench?
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#hardware-and-software" class="md-nav__link">
+ <span class="md-ellipsis">
+ Hardware and software
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#accurately-comparing-different-engines" class="md-nav__link">
+ <span class="md-ellipsis">
+ Accurately comparing different engines
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#engine-tuning-in-benchmarks" class="md-nav__link">
<span class="md-ellipsis">
- TODO
+ Engine tuning in benchmarks
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#open-source-benchmarks-vs-vendor-benchmarks" class="md-nav__link">
+ <span class="md-ellipsis">
+ Open source benchmarks vs. vendor benchmarks
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#how-to-contribute" class="md-nav__link">
+ <span class="md-ellipsis">
+ How to contribute
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#future-work" class="md-nav__link">
+ <span class="md-ellipsis">
+ Future work
</span>
</a>
@@ -599,8 +713,6 @@
- <h1>Overview and Methodology</h1>
-
<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
@@ -616,7 +728,56 @@
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
---><h2 id="todo">TODO<a class="headerlink" href="#todo" title="Permanent
link">¶</a></h2>
+--><h1 id="spatialbench-overview-and-methodology">SpatialBench Overview and
Methodology<a class="headerlink" href="#spatialbench-overview-and-methodology"
title="Permanent link">¶</a></h1>
+<p>SpatialBench is an open benchmark suite of representative spatial queries
designed to evaluate the performance of different engines at multiple scale
factors.</p>
+<p>The SpatialBench queries are a great way to compare the relative
performance between engines for analytical spatial workloads. You can use a
small scale factor for single-machine queries, and a large scale factor to
benchmark an engine that distributes computations in the cloud.</p>
+<p>Let’s take a deeper look at why SpatialBench is so essential.</p>
+<h2 id="why-spatialbench">Why SpatialBench?<a class="headerlink"
href="#why-spatialbench" title="Permanent link">¶</a></h2>
+<p>Spatial workflows encompass queries such as spatial joins, spatial
filtering, and spatial-specific operations, including KNN joins.</p>
+<p>General-purpose analytics query benchmarks don’t cover spatial queries.
They focus on analytical queries, such as joins and aggregations, on tabular
data. Here are some popular analytical benchmarks:</p>
+<ul>
+<li><a href="https://www.tpc.org/tpch/";>TPC-H</a></li>
+<li><a href="https://www.tpc.org/tpcds/";>TPC-DS</a></li>
+<li><a href="https://benchmark.clickhouse.com/";>ClickBench</a></li>
+<li><a href="https://github.com/brianfrankcooper/YCSB";>YCSB</a></li>
+<li><a href="https://duckdblabs.github.io/db-benchmark/";>db-benchmark</a></li>
+</ul>
+<p>The analytical benchmarks help analyze analytical performance, but that
doesn’t necessarily translate to spatial queries. An engine can be blazing
fast for a large tabular aggregation and terrible for spatial joins.</p>
+<p>SpatialBench is tailored for spatial queries. It’s the best modern option
to assess the spatial performance of an engine. Let’s take a look at some of
the older spatial benchmarks.</p>
+<h2 id="hardware-and-software">Hardware and software<a class="headerlink"
href="#hardware-and-software" title="Permanent link">¶</a></h2>
+<p>SpatialBench runs benchmarks on commodity hardware, with software versions
fully disclosed for each release.</p>
+<p>When comparing different runtimes, developers should make a good-faith
effort to use similar hardware and software versions. It’s not helpful to
compare one runtime with another runtime that has a lot less computational
power.</p>
+<p>SpatialBench benchmarks should always be presented with associated
hardware/software specifications so readers can assess the reliability of the
comparison.</p>
+<h2 id="accurately-comparing-different-engines">Accurately comparing different
engines<a class="headerlink" href="#accurately-comparing-different-engines"
title="Permanent link">¶</a></h2>
+<p>It is challenging to compare fundamentally different engines, such as
PostGIS (an OLTP database), DuckDB (an OLAP database), and GeoPandas (a Python
engine).</p>
+<p>For example, let’s compare how two engines execute a query differently:</p>
+<ul>
+<li>PostGIS: create tables, load data into the tables, build an index (can be
expensive), run the query</li>
+<li>GeoPandas: read data into memory and run a query</li>
+</ul>
+<p>PostGIS and GeoPandas execute queries differently, so you need to present
the query runtime with caution. For example, you can’t just ignore the time it
takes to build the PostGIS index because that can be the slowest part of the
query. That’s a critical detail for users running ad hoc queries.</p>
+<p>The SpatialBench results strive to present runtimes for all relevant
portions of the query so users are best informed about how to interpret the
results.</p>
+<h2 id="engine-tuning-in-benchmarks">Engine tuning in benchmarks<a
class="headerlink" href="#engine-tuning-in-benchmarks" title="Permanent
link">¶</a></h2>
+<p>Engines can be tuned by configuring settings or optimizing code. For
example, you can optimize Spark code by tuning the JVM. You can optimize
GeoPandas code by adding indexes. Benchmarks that tune one engine and don’t
tune any of the other engines aren’t reliable.</p>
+<p>All performance tuning is fully disclosed in the SpatialBench results.
Some results are presented both naively and fully tuned to give a better
picture of out-of-the-box performance and what’s possible for expert users.</p>
+<h2 id="open-source-benchmarks-vs-vendor-benchmarks">Open source benchmarks
vs. vendor benchmarks<a class="headerlink"
href="#open-source-benchmarks-vs-vendor-benchmarks" title="Permanent
link">¶</a></h2>
+<p>The SpatialBench benchmarks report results for some open source spatial
engines/databases.</p>
+<p>The SpatialBench repository does not report results for any proprietary
engines or vendor runtimes. Vendors are free to use the SpatialBench data
generators and run the benchmarks on their own. We ask vendors to credit
SpatialBench when they run the benchmarks and fully disclose the results so
that other practitioners can reproduce the results.</p>
+<h2 id="how-to-contribute">How to contribute<a class="headerlink"
href="#how-to-contribute" title="Permanent link">¶</a></h2>
+<p>There are a variety of ways to contribute to the SpatialBench project:</p>
+<ul>
+<li>Submit <a href="https://github.com/apache/sedona-spatialbench/pulls";>pull
requests</a> to add features</li>
+<li>Create <a
href="https://github.com/apache/sedona-spatialbench/issues";>issues</a> for bug
reports</li>
+<li>Reproduce results or help add new spatial engines</li>
+<li>Publish vendor benchmarks</li>
+</ul>
+<p>Here is how you can communicate with the team:</p>
+<ul>
+<li>Chat with us on the <a href="https://discord.gg/9A3k5dEBsY";>Apache Sedona
Discord</a></li>
+<li>Create <a href="https://github.com/apache/sedona/discussions";>GitHub
Discussions</a></li>
+</ul>
+<h2 id="future-work">Future work<a class="headerlink" href="#future-work"
title="Permanent link">¶</a></h2>
+<p>In the next release, we will add raster datasets and raster queries. These
will stress test an engine’s ability to analyze raster data. They will also
show performance when joining vector and raster datasets.</p>
@@ -637,7 +798,7 @@
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 24 24"><path d="M21
13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6
0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4
2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10
9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1
7.5 7.1 7.9l-.1.2z"></path></svg>
</span>
- <span class="git-revision-date-localized-plugin
git-revision-date-localized-plugin-datetime" title="September 19, 2025 06:08:03
UTC">September 19, 2025 06:08:03</span>
+ <span class="git-revision-date-localized-plugin
git-revision-date-localized-plugin-datetime" title="September 19, 2025 18:26:39
UTC">September 19, 2025 18:26:39</span>
</span>
diff --git a/search/search_index.json b/search/search_index.json
index 7a265f7..af40317 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Sedona
SpatialBench","text":"<p>Sedona SpatialBench makes it easy to run spatial
benchmarks on a realistic dataset with any query engine.</p> <p>The methodology
is unbiased and the benchmarks in any environment to compare relative
performance between
runtimes.</p>"},{"location":"#why-spatialbench","title":"Why
SpatialBench","text":"<p>SpatialBench is a geospatial benchmark for [...]
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Sedona
SpatialBench","text":"<p>Sedona SpatialBench makes it easy to run spatial
benchmarks on a realistic dataset with any query engine.</p> <p>The methodology
is unbiased and the benchmarks in any environment to compare relative
performance between
runtimes.</p>"},{"location":"#why-spatialbench","title":"Why
SpatialBench","text":"<p>SpatialBench is a geospatial benchmark for [...]
\ No newline at end of file
