This repository has been archived by the owner on Jun 14, 2024. It is now read-only.
Update documentation - ZOrderCoveringIndex #522
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
sezruby
commented
Jan 14, 2022
|
|
||
| As of v0.6, Hyperspace supports the following two covering indexes: | ||
|
|
||
| 1. [(Bucketed) Covering Index](#covering-index) |
There was a problem hiding this comment.
Not sure how we can name the covering index.. bucketed? shuffled? 🤔
sezruby
commented
Jan 14, 2022
| title: "Index types" | ||
| permalink: /docs/ug-index-types/ | ||
| excerpt: "Mutable dataset guide" | ||
| last_modified_at: 2021-12-29 |
There was a problem hiding this comment.
nit: update the date
paryoja
reviewed
Jan 14, 2022
| from hyperspace import Hyperspace | ||
| from hyperspace import CoveringIndexConfig | ||
| hs = Hyperspace(sparkSession) | ||
| idxConfig = CoveringIndexConfig('<indexName>', ['<indexedCol1>', '<indexedCol2>'], ['<includedCol1>']) |
There was a problem hiding this comment.
Using double quote will be more consistent with the following line. (And I personally prefer double quote 😄)
'<indexName>' -> "<indexName>"
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the context for this pull request?
What changes were proposed in this pull request?
Update user document for ZOrderCoveringIndex
link to page: https://sezruby.github.io/hyperspace/docs/ug-index-types/
Does this PR introduce any user-facing change?
No, the PR only contains documentation update
How was this patch tested?
https://sezruby.github.io/hyperspace/docs/ug-index-types/