-
Notifications
You must be signed in to change notification settings - Fork 673
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 tidb_decode_key #5561
Comments
/assign @tangenta @wjhuang2016 @bb7133 |
The problem is that, do we expect users to know this function? |
For now, we don't have a page to introduce the built-in functions in detail. Where should I put the documentation of
@kolbe Do you know where the raw keys usually come from? We can put the explanation to the related tutorials. |
@tangenta I don't think an explanation needs to be provided in any tutorials, I think we simply need documentation about what the function does, its limitations, etc. |
https://docs.pingcap.com/tidb/stable/tidb-functions#tidb_decode_key Can we close this now or is there something missing? |
@dveeden I think the description in the docs should be extended a bit to include the expected output when the schema does not use a "hidden" row id. For example, a compound clustered primary key:
|
Closes: pingcap#5561 Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Closes: pingcap#5561 Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Closes: pingcap#5561 Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Change Request
Please answer the following questions before submitting your issue. Thanks!
The tidb_decode_key function is very useful for mapping a raw key back to the table/index it belongs to. This function should be documented so that its behavior and limitations (pingcap/tidb#23180 for example) are well-understood.
The text was updated successfully, but these errors were encountered: