Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update glossary and add lots of detail #5

Merged
merged 6 commits into from
Jan 18, 2025
Merged

Update glossary and add lots of detail #5

merged 6 commits into from
Jan 18, 2025

Conversation

connortsui20
Copy link
Member

We have found that definitions in query optimization have internally become overloaded. This document defines key names and definitions for concepts that are required in optimization.

Don't look at the diff, it would be better to view this document directly: https://github.com/cmu-db/optd/blob/glossary/docs/src/architecture/glossary.md

TODO I don't really know how to define Properties and Rules well so I left the old explanation there.

Copy link
Member

@yliang412 yliang412 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks great. I posted comments related to links and styles, but I think you already started to add a lot of those.

docs/src/architecture/glossary.md Outdated Show resolved Hide resolved
docs/src/architecture/glossary.md Outdated Show resolved Hide resolved
Copy link

@SarveshOO7 SarveshOO7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The definitions look good to me

docs/src/architecture/glossary.md Outdated Show resolved Hide resolved
@connortsui20
Copy link
Member Author

I'm making more changes (there are still todos everywhere) so please don't merge.

Also, @yliang412 there is a fixme that I don't fully understand, could you try rewriting that sentence if you have the time?

@connortsui20 connortsui20 merged commit f1daf95 into main Jan 18, 2025
12 checks passed
@connortsui20 connortsui20 deleted the glossary branch January 18, 2025 18:07
connortsui20 added a commit that referenced this pull request Jan 19, 2025
This commit defines several key terms related to query optimization that we found were heavily overloaded last semester, leading to lots of confusion.

Since this document will evolve over time, there are still many TODOs that will have to be fixed later.

* update glossary and add lots of detail

* add directory

* clean style

* refactor and make section for each term

* Fill in all main sections with something

* clean up ending but leave TODOs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants