Skip to content

Fix key terminology around various Index structs #33074

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ggevay
Copy link
Contributor

@ggevay ggevay commented Jul 18, 2025

We have decided some time ago that

  • "keys" should mean multiple (composite) keys, e.g. a Vec<Vec<MirScalarExpr>>;
  • "key" should mean one (composite) key, e.g., a Vec<MirScalarExpr>;
  • "key column", "key part", "key field", "key component" or simply "k" (which Frank uses, and is common in the optimizer) should mean one column of a composite key, e.g., a MirScalarExpr.

discussion:
https://materializeinc.slack.com/archives/C02PPB50ZHS/p1676473154162599

Motivation

  • This PR refactors existing code.

Tips for reviewer

Checklist

  • This PR has adequate test coverage / QA involvement has been duly considered. (trigger-ci for additional test/nightly runs)
  • This PR has an associated up-to-date design doc, is a design doc (template), or is sufficiently small to not require a design.
  • If this PR evolves an existing $T ⇔ Proto$T mapping (possibly in a backwards-incompatible way), then it is tagged with a T-proto label.
  • If this PR will require changes to cloud orchestration or tests, there is a companion cloud PR to account for those changes that is tagged with the release-blocker label (example).
  • If this PR includes major user-facing behavior changes, I have pinged the relevant PM to schedule a changelog post.

We have decided some time ago that
- "keys" should mean multiple keys, e.g. a `Vec<Vec<MirScalarExpr>>`;
- "key" should mean one key (with possibly multiple columns), e.g., a
  Vec<MirScalarExpr>;
- "key column", "key part", "key field", "key component" or simply "k"
  (which Frank uses, and is common in the optimizer) should mean one
  column of a composite key, e.g., a MirScalarExpr.

discussion:
https://materializeinc.slack.com/archives/C02PPB50ZHS/p1676473154162599
@ggevay ggevay requested review from a team as code owners July 18, 2025 09:01
@ggevay ggevay requested a review from aljoscha July 18, 2025 09:01
@ggevay ggevay added the A-ADAPTER Topics related to the ADAPTER layer label Jul 18, 2025
@aljoscha
Copy link
Contributor

I don't really have an opinion on these, and someone closer to compute or the optimizer should review. I can give a blanket stamp if that's what's needed. 😅

@ggevay
Copy link
Contributor Author

ggevay commented Jul 18, 2025

Ok, thanks, I'll wait for someone closer to compute or the optimizer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ADAPTER Topics related to the ADAPTER layer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants