Add README. #33

wangpatrick57 · 2024-07-06T04:02:00Z

Summary: Wrote Quickstart and Overview sections. Go here to see the README on the website.

Details:

Overview summarizes the research motivation behind the project, giving background as necessary.
Quickstart gives a single shell script which compiles Postgres with Boot, generates data, builds a Proto-X embedding, and trains a Proto-X agent.
I renamed all occurrences of "pgdata" to "dbdata" to match the project's vision of working for multiple DBMSs (as described in the README).
I removed the startup check.
I got rid of the ssd_checker dependency as it's a very small repository.
Fixed Postgres compilation code to work with the new vldb_2024 branch of Boot.

lmwnshn

LGTM - focused on README

wangpatrick57 added 4 commits July 5, 2024 20:30

wrote overview of readme

ab88342

wrote how to run

daec551

erge branch 'main' into readme

4a4f3ec

noted how the dbms is tuned during the training process

61bbfb6

wangpatrick57 requested review from lmwnshn and 17zhangw July 6, 2024 04:02

wangpatrick57 and others added 11 commits July 7, 2024 03:27

added install_dependencies.sh

a3b9d5e

updated readme with wan's rewrite

5593d4f

added quickstart script

4496145

removed no startup check option

6a9ea38

replaced is_ssd() check with our own version to eliminate a dependency

dfad09a

replace (almost) all occurrences of pgdata with dbdata

c45c4b6

now pulling from vldb_2024 branch instead of boot branch

99e7014

renamed bytejack_rs and bytejack to boot_rs and boot

03908e0

renamed bytejack to boot

43dd073

added title back

d40e6d9

Small fixes.

3128dde

lmwnshn changed the title ~~Readme~~ Add README. Jul 7, 2024

lmwnshn approved these changes Jul 7, 2024

View reviewed changes

wangpatrick57 merged commit d5cc4c2 into cmu-db:main Jul 7, 2024
1 check passed

lmwnshn mentioned this pull request Jul 7, 2024

Replace --no-startup-check with a --print-configuration. #14

Closed

wangpatrick57 deleted the readme branch July 7, 2024 23:45

Provide feedback