docs: clarify that all data types except maps are supported as keys #6735
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
agavra
approved these changes
Dec 8, 2020
| !!! note | ||
| The `DELIMITED` format doesn't support maps. | ||
|
|
||
| ksqlDB supports fields that are maps. A map has a key and value type. All | ||
| of the keys must be of the same type, and all of the values must be also | ||
| be of the same type. Currently only `STRING` keys are supported. The | ||
| value type can be any valid SQL type. | ||
| be of the same type. |
There was a problem hiding this comment.
are you sure this is true? I thought there were some assumptions baked in at the ksql layer (not the serde layer) about string keys.
There was a problem hiding this comment.
That's funny, the reason I made this change was because I remembered #6182 which removed all the assumptions that were previously baked in at non-serde layers. However. I forgot that the PR didn't actually add support for protobuf maps with non-string keys, even though we in theory could. So ultimately you're right ( for the wrong reason ;) ). I'll put the statement back in.
There was a problem hiding this comment.
Thanks for the catch!
|
Docs-only change. Merging despite build (flaky test failure). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Docs for #6722. I don't see anywhere in the docs today where we say only primitive types are supported as keys. With 0.15, all non-map types will be supported, which this PR explicitly clarifies.
Testing done
Docs-only change.
Reviewer checklist