PostBOUND 0.19.0__tar.gz

postbound-0.19.0/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

postbound-0.19.0/PKG-INFO

@@ -0,0 +1,355 @@
+Metadata-Version: 2.4
+Name: PostBOUND
+Version: 0.19.0
+Summary: PostBOUND is a research framework to prototype and benchmark database query optimizers
+Author-email: Rico Bergmann <rico.bergmann1@tu-dresden.de>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/rbergm/PostBOUND
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Database :: Database Engines/Servers
+Classifier: Topic :: Scientific/Engineering
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: lazy-loader~=0.4
+Requires-Dist: levenshtein~=0.27
+Requires-Dist: natsort~=8.4
+Requires-Dist: networkx~=3.5
+Requires-Dist: numpy~=2.3
+Requires-Dist: pandas~=2.3
+Requires-Dist: pglast~=7.10
+Requires-Dist: psycopg[binary]~=3.2
+Requires-Dist: tqdm~=4.67
+Provides-Extra: vis
+Requires-Dist: matplotlib~=3.10; extra == "vis"
+Requires-Dist: seaborn~=0.13; extra == "vis"
+Requires-Dist: graphviz~=0.21; extra == "vis"
+Provides-Extra: mysql
+Requires-Dist: mysql-connector-python~=9.5; extra == "mysql"
+Dynamic: license-file
+
+# PostBOUND
+
+![GitHub License](https://img.shields.io/github/license/rbergm/PostBOUND)
+![GitHub Release](https://img.shields.io/github/v/release/rbergm/PostBOUND?color=blue)
+
+<p align="center">
+    <img src="docs/figures/postbound-logo.svg" style="width: 150px; margin: 15px;">
+</p>
+
+PostBOUND is a Python framework for studying query optimization in database systems.
+At a high level, PostBOUND has the following goals and features:
+
+- 🏃‍♀️ **Rapid prototyping:** PostBOUND allows researchers to implement specific phases of the optimization process, such
+  as the cardinality estimator or the join order optimization. Researchers can focus precisely on the parts that they are
+  studying and use _reasonable_ defaults for the rest. See [🧑‍🏫 Example](#-example) for how this looks in practice.
+- 🧰 **No boilerplate:** to ease the implementation of the optimizers, PostBOUND provides a large toolbox of
+  support functionality, such as query parsing, join graph construction, relational algebra or database statistics.
+- 📊 **Transparent benchmarks:** once a new optimizer prototype is completed, the benchmarking tools allow to compare this
+  prototype against other optimization strategies in a transparent and reproducible way. As a core design principle,
+  PostBOUND executes queries on an actual database system such as PostgreSQL, or DuckDB, rather than research systems or
+  artificial "lab" comparisons. See [💡 Essentials](#-essentials) for more information on this.
+- 🔋 **Batteries included:** in addition to the Python package, PostBOUND provides a lot of utilities to setup databases
+  and load commonly used benchmarks (e.g., JOB, Stats and Stack).
+
+| **[💻 Installation](https://postbound.readthedocs.io/en/latest/setup.html)**
+| **[📖 Documentation](https://postbound.readthedocs.io/en/latest/)**
+| **[🧑‍🏫 Examples](https://github.com/rbergm/PostBOUND/tree/main/examples)** |
+
+
+## ⚡️ Quick Start
+
+An installation of PostBOUND consists of two parts: the PostBOUND framework itself, as well as a running database instance
+(such as PostgreSQL or DuckDB) that is used to actually execute the optimized queries (see [💡 Essentials](#-essentials)
+below).
+
+The easiest way to install PostBOUND is via Pip:
+
+```sh
+pip install postbound
+```
+
+Afterwards, you can [connect](https://postbound.readthedocs.io/en/latest/10minutes.html#database-connection) it to a
+Postgres server running [pg_hint_plan](https://github.com/ossc-db/pg_hint_plan).
+
+If you prefer a more integrated setup, we provide a Docker image that contains PostBOUND as well as a readily-configured
+Postgres server or DuckDB installation.
+You can build your Docker image with the following command:
+
+```sh
+docker build -t postbound --build-arg TIMEZONE=$(cat /etc/timezone) .
+```
+
+Once the image is built, you can create any number of containers with different setups.
+For example, to create a container with a local Postgres instance (using [pg_lab](https://github.com/rbergm/pg_lab)) and
+setup the Stats, JOB and Stack benchmarks, use the following command:
+
+
+```sh
+docker run -dt \
+    --shm-size 4G \
+    --name postbound \
+    --env USE_PGLAB=true \
+    --env OPTIMIZE_PG_CONFIG=true \
+    --env SETUP_DUCKDB=false \
+    --env SETUP_STATS=true \
+    --env SETUP_JOB=false \
+    --env SETUP_STACK=false \
+    --volume $PWD/vol-postbound:/postbound \
+    --volume $PWD/vol-pglab:/pg_lab \
+    --publish 5432:5432 \
+    --publish 8888:8888 \
+    postbound
+```
+
+All supported build arguments are listed under [Docker options](#-docker-options).
+See [Essentials](#-essentials) for why a database instance is necessary.
+For Postgres, adjust the amount of shared memory depending on your machine.
+Note that the initial start of the container will take a substantial amount of time.
+This is because the container needs to compile a fresh Postgres server from source, download and import workloads, etc.
+Use `docker logs -f postbound`  to monitor the startup process.
+
+> [!TIP]
+> Shared memory is used by Postgres for its internal caching and therefore paramount for good server performance.
+> The general recommendation is to set it to at least 1/4 of the available RAM.
+
+The Postgres server will be available at port 5432 from the host machine (using the user _postbound_ with the same
+password).
+You can also create a local DuckDB installation by setting `SETUP_DUCKDB` to _true_.
+If you plan on using Jupyter for data analysis, also publish port 8888.
+The volume mountpoints provide all internal files from PostBOUND and pg_lab (if used).
+
+You can connect to the PostBOUND container using the usual
+
+```sh
+docker exec -it postbound /bin/bash
+```
+
+The shell enviroment is setup to have PostBOUND available in a fresh Python virtual environment (which is activated by
+default).
+Furthermore, all Postgres and DuckDB utilities are available on the _PATH_ (if the respective systems have been build during
+the setup).
+
+> [!TIP]
+> If you want to install PostBOUND directly on your machine, the
+> [documentation](https://postbound.readthedocs.io/en/latest/setup.html) provides a detailed setup guide.
+
+
+## 💡 Essentials
+
+As a central design decision, PostBOUND is not integrated into a specific database system.
+Instead, it is implemented as a Python framework operating on top of a running database instance.
+In the end, all query plans generated by PostBOUND should be executed on a real-world database system.
+This decision was made to ensure that the optimization strategies are actually useful in practice and we treat the execution
+time as the ultimate measure of optimization quality.
+
+However, this decision means that we need a way to ensure that the optimization decisions made within the framework are
+actually used when executing the query in the context of the target database.
+This is achieved by using query hints which typically encode the optimization decisions in comment blocks within the query.
+
+In the case of Postgres, this interaction roughly looks like this:
+
+<p align="center">
+  <img src="docs/figures/postbound-pg-interaction.svg" style="width: 600px; margin: 15px;">
+</p>
+
+Users implement their optimization strategies in terms of
+[optimization pipelines](https://postbound.readthedocs.io/en/latest/core/optimization.html).
+For an incoming SQL query, the pipeline computes an abstract representation of the resulting query plan without user
+intervention.
+This plan is automatically converted into equivalent hints for the target database system such as Postgres or DuckDB.
+Afterwards, the hints ensure that the database system executes the query plan that was originally computed in the optimization
+pipeline.
+
+Depending on the actual database system, the hints might differ in syntax as well as semantics.
+Generally speaking, PostBOUND figures out which hints to use on its own, without user intervention.
+In the case of PostgreSQL,  PostBOUND relies on either [pg_hint_plan](https://github.com/ossc-db/pg_hint_plan) or
+[pg_lab](https://github.com/rbergm/pg_lab) to provide the necessary hinting functionality when targeting Postgres.
+For DuckDB, PostBOUND uses [quacklab](https://github.com/rbergm/quacklab) hints to guide the optimizer.
+
+> [!NOTE]
+> PostBOUND's database interaction is designed to be independent of a specific system (such as PostgreSQL, Oracle, ...).
+> However, the current implementation is most complete for PostgreSQL and DuckDB with limited support for MySQL.
+> This is due to practical reasons, mostly our own time budget and the popularity of the two systems in the optimizer research
+> community.
+
+
+## 🧑‍🏫 Example
+
+The typical end-to-end workflow using PostBOUND looks like this:
+
+1. **Implement your new optimization strategy**. To do so, you need to figure out which parts of the optimization process you
+   want to customize and what the most appropriate optimization pipeline is. In a nutshell, the optimization pipeline is
+   a mental model of how the optimizer works. Commonly used pipelines are the textbook-style pipeline (i.e. using plan
+   enumerator, cost model and cardinality estimator), or the multi-stage pipeline which first computes a join order and
+   afterwards selects the best physical operators. The pipeline determines which interfaces can be implemented.
+2. Select your **target database system** and **benchmark** that should be used for the evaluation.
+3. Optionally, select different optimization strategies that you want to compare against.
+4. Use the **benchmarking tools** to execute the workload against the target database system.
+
+For example, a random join order optimizer could be implemented like this:
+
+```python
+import random
+
+import postbound as pb
+
+
+# Step 1: define our optimization strategy.
+# In this example we develop a simple join order optimizer that
+# selects a linear join order at random.
+# We delegate most of the actual work to the pre-defined join grap
+# that keeps track of free tables.
+class RandomJoinOrderOptimizer(pb.JoinOrderOptimization):
+    def optimize_join_order(self, query: pb.SqlQuery) -> pb.LogicalJoinTree:
+        join_tree = pb.LogicalJoinTree()
+        join_graph = pb.opt.JoinGraph(query)
+
+        while join_graph.contains_free_tables():
+            candidate_tables = [
+                path.target_table for path in join_graph.available_join_paths()
+            ]
+            next_table = random.choice(candidate_tables)
+
+            join_tree = join_tree.join_with(next_table)
+            join_graph.mark_joined(next_table)
+
+        return join_tree
+
+    def describe(self) -> pb.util.jsondict:
+        return {"name": "random-join-order"}
+
+
+# Step 2: connect to the target database, load the workload and
+# setup the optimization pipeline.
+# In our case, we evaluate on the Join Order Benchmark on Postgres
+pg_imdb = pb.postgres.connect(config_file=".psycopg_connection_job")
+job = pb.workloads.job()
+
+optimization_pipeline = (
+    pb.MultiStageOptimizationPipeline(pg_imdb)
+    .use(RandomJoinOrderOptimizer())
+    .build()
+)
+
+# (Step 3): in this example we just compare against the native Postgres optimizer
+# Therefore, we do not need to setup any additional optimizers.
+
+# Step 4: execute the workload.
+# We use the QueryPreparationService to prewarm the database buffer and run all
+# queries as EXPLAIN ANALYZE.
+query_prep = pb.bench.QueryPreparation(
+    prewarm=True, analyze=True, preparatory_statements=["SET geqo TO off;"]
+)
+native_results = pb.bench.execute_workload(
+    job,
+    on=pg_imdb,
+    query_preparation=query_prep,
+    workload_repetitions=3,
+    progressive_output="job-results-native.csv",
+    logger="tqdm",
+)
+optimized_results = pb.bench.execute_workload(
+    job,
+    on=optimization_pipeline,
+    query_preparation=query_prep,
+    workload_repetitions=3,
+    progressive_output="job-results-optimized.csv",
+    logger="tqdm",
+)
+
+```
+
+
+## 🤬 Issues
+
+Something feels wrong or broken, or a part of PostBOUND is poorly documented or otherwise unclear?
+Please don't hestitate to file an issue or open a pull request!
+PostBOUND is not one-off software, but an ongoing research project.
+We are always happy to improve both PostBOUND and its documentation and we feel that the user experience (specifically,
+_your_ user experience) is a very important part of this.
+
+
+## 🫶 Reference
+
+If you find our work useful, please cite the following paper:
+
+```bibtex
+@inproceedings{bergmann2025elephant,
+  author       = {Rico Bergmann and
+                  Claudio Hartmann and
+                  Dirk Habich and
+                  Wolfgang Lehner},
+  title        = {An Elephant Under the Microscope: Analyzing the Interaction of Optimizer
+                  Components in PostgreSQL},
+  journal      = {Proc. {ACM} Manag. Data},
+  volume       = {3},
+  number       = {1},
+  pages        = {9:1--9:28},
+  year         = {2025},
+  url          = {https://doi.org/10.1145/3709659},
+  doi          = {10.1145/3709659},
+  timestamp    = {Tue, 01 Apr 2025 19:03:19 +0200},
+  biburl       = {https://dblp.org/rec/journals/pacmmod/BergmannHHL25.bib},
+  bibsource    = {dblp computer science bibliography, https://dblp.org}
+}
+```
+
+---
+
+
+## 📖 Documentation
+
+A detailed documentation of PostBOUND is available [here](https://postbound.readthedocs.io/en/latest/).
+
+
+## 🐳 Docker options
+
+The following options can be used when starting the Docker container as `--env` parameters (with the exception of _TIMEZONE_,
+which must be specified as a `--build-arg` when creating the image).
+
+| Argument | Allowed values | Description | Default |
+|----------|----------------|-------------|---------|
+| `TIMEZONE` | Any valid timezone identifier | Timezone of the Docker container (and hence the Postgres server). It is probably best to just use the value of `cat /etc/timezone` | `UTC` |
+| `USERNAME` | Any valid UNIX username. | The username within the Docker container. This will also be the Postgres user and password. | `postbound` |
+| `SETUP_POSTGRES` | `true` or `false` | Whether to include a Postgres server in the setup. By default, this is a vanilla Postgres server with the latest minor release. However, this can be customized with `USE_PGLAB` and `PGVER`. | `true` |
+| `USE_PGLAB` | `true` or `false` | Whether to initialize a [pg_lab](https://github.com/rbergm/pg_lab) server instead of a normal Postgres server. pg_lab provides advanced hinting capabilities and offers additional extension points for the query optimizer. | `false` |
+| `OPTIMIZE_PG_CONFIG` |  `true` or `false` | Whether the Postgres configuration parameters should be automatically set based on your hardware platform. Rules are based on [PGTune](https://pgtune.leopard.in.ua/) by [le0pard](https://github.com/le0pard). | `false` |
+| `PG_DISK_TYPE` | `SSD` or `HDD` | In case the Postgres server is automatically configured (see `OPTIMIZE_PG_CONFIG`) this indicates the kind of storage for the actual database. In turn, this influences the relative cost of sequential access and index-based access for the query optimizer. | `SSD` |
+| `PGVER` | 16, 17, ... | The Postgres version to use. Notice that pg_lab supports fewer versions. This value is passed to the `postgres-setup.sh` script of the Postgres tooling (either under `db-support` or from pg_lab), which provides the most up to date list of supported versions. | 17 |
+| `SETUP_DUCKDB` | `true` or `false` | Whether DuckDB-support should be added to PostBOUND. If enabled, a [DuckDB version with hinting support](https://github.com/rbergm/quacklab) will be compiled and images for all selected benchmarks will be created. Please be aware that during testing we noticed that creating an optimized build of DuckDB takes a lot of time on some platforms (think a couple of hours). | `false` |
+| `SETUP_IMDB` | `true` or `false` | Whether an [IMDB](https://doi.org/10.14778/2850583.2850594) instance should be created as part of the setup. If a Postgres server is included in the setup, PostBOUND can connect to the database using the `.psycopg_connection_job` config file. For DuckDB, the database will be located at `/postbound/imdb.duckdb`. | `false` |
+| `SETUP_STATS` | `true` or `false` | Whether a [Stats](https://doi.org/10.14778/3503585.3503586) instance should be created as part of the setup. If a Postgres server is included in the setup, PostBOUND can connect to the database using the `.psycopg_connection_stats` config file. For DuckDB, the database will be located at `/postbound/stats.duckdb` | `false` |
+| `SETUP_STACK` | `true` or `false`| Whether a [Stack](https://doi.org/10.1145/3448016.3452838) instance should be created as part of the Postgres setup. If a Postgres server is included in the setup, PostBOUND can connect to the database using the `.psycopg_connection_stack` config file. DuckDB is currently not supported. | `false` |
+
+The PostBOUND source code is located at `/postbound`. If pg_lab is being used, the corresponding files are located at `/pg_lab`.
+The container automatically exposes the Postgres port 5432 and provides volume mountpoints at `/postbound` and `/pg_lab`.
+These mountpoints can be used as backups or to easily ingest data into the container.
+If the pg_lab mountpoint points to an existing (i.e. non-empty) directory, the setup assumes that this is already a valid
+pg_lab installation and skips the corresponding setup.
+
+> [!TIP]
+> pg_lab provides advanced hinting support (e.g. for materialization or cardinality hints for base tables) and offers
+> additional extension points for the query optimizer (e.g. hooks for the different cost functions).
+> If pg_lab is not used, the Postgres server will setup pg_hint_plan instead.
+
+
+## 📑 Repo Structure
+
+The repository is structured as follows.
+The `postbound` directory contains the actual source code, all other folders are concerned with "supporting" aspects
+(which are nevertheless important..).
+Almost all of the subdirectories contain further READMEs that explain their purpose and structure in more detail.
+
+| Folder        | Description |
+| ------------- | ----------- |
+| `postbound`   | Contains the source code of the PostBOUND framework |
+| `docs`        | contains the high-level documentation as well as infrastructure to export the source code documentation |
+| `examples`    | contains general examples for typical usage scenarios. These should be run from the root directory, e.g. as `python3 -m examples.example-01-basic-workflow` |
+| `tests`       | contains the unit tests and integration tests for the framework implementatino. These should also be run from the root directory, e.g. as `python3 -m unittest tests` |
+| `db-support`  | Contains utilities to setup instances of the respective database systems and contain system-specific scripts to import popular benchmarks for them |
+| `workloads`   | Contains the raw SQL queries of some popular benchmarks |
+| `tools`       | Provides different other utilities that are not directly concerned with specific database systems, but rather with common problems encoutered when benchmarking query optimizers |