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

Add documentation for HYPO indexes #19714

Open
mjonss opened this issue Dec 16, 2024 · 1 comment
Open

Add documentation for HYPO indexes #19714

mjonss opened this issue Dec 16, 2024 · 1 comment

Comments

@mjonss
Copy link
Contributor

mjonss commented Dec 16, 2024

Change Request

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.
    There are no documentation of the HYPO index type, implemented here.

  2. Describe your suggestion or addition.
    A Hypothetical index type was added in X.Y

with syntax like:
ALTER TABLE t SET HYPO TIFLASH REPLICA ...
DROP HYPO INDEX ...
CREATE INDEX <index_name> TYPE HYPO ON <tbl> (<columns>)
...

This is to make it possible to evaluate how the optimizer would take a new index into account, if it would be used, what plans would be updated if such index existed etc.

As I understand it, it will only affect EXPLAIN commands, and not any other statements, since it is just a hypothetical index, metadata only, no actual index on any data.

  1. Provide some reference materials (such as documents and websites) if you could.
    planner: support hypo-indexes tidb#43817
@dveeden
Copy link
Contributor

dveeden commented Dec 16, 2024

Also: recommend index show etc from pingcap/tidb#55947

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

No branches or pull requests

2 participants