-
Notifications
You must be signed in to change notification settings - Fork 106
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
Hypercore API ref #3699
base: release-2.18.0-main
Are you sure you want to change the base?
Hypercore API ref #3699
Conversation
Allow 10 minutes from last push for the staging site to build. If the link doesn't work, try using incognito mode instead. For internal reviewers, check web-documentation repo actions for staging build status. Link to build for this PR: http://docs-dev.timescale.com/docs-235-docs-rfc-update-the-api-ref-for-hyperstore-and-compression-for-any-changes-due-to-the-hyperstore |
Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers). |
Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers). |
…tore-and-compression-for-any-changes-due-to-the-hyperstore
…tore-and-compression-for-any-changes-due-to-the-hyperstore
…tore-and-compression-for-any-changes-due-to-the-hyperstore
…tore-and-compression-for-any-changes-due-to-the-hyperstore
@billy-the-fish the changes look good to me. One thing, I would look like to add is a reference from the deprecated functions / parameters to the new ones. For example: |
…l these docs go live.
…tore-and-compression-for-any-changes-due-to-the-hyperstore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made a quick pass and added some suggestions.
Awesome review, thank you. Co-authored-by: Erik Nordström <819732+erimatnor@users.noreply.github.com> Signed-off-by: Iain Cox <iain@timescale.com>
…tore-and-compression-for-any-changes-due-to-the-hyperstore
…tore-and-compression-for-any-changes-due-to-the-hyperstore
Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers). |
Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noted that many entries are noted as required while they are not.
|Column| Type | Description | | ||
|-|-------------------------------------------------|-------------------------------------------------| | ||
| `convert_to_columnstore` | REGCLASS | The name of the chunk added to the columnstore. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The result set here does not have a name, so not sure how you want to handle this. We have two different cases: 1) return a table-like result set with zero or more rows, and 2) return a single value of a specific type. This one just returns a regclass
with no name.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @mkindahl , I've updated with my proposal of how to handle this case. Not entirely sure of the words to add so have left it open.
…tore-and-compression-for-any-changes-due-to-the-hyperstore
…tore-and-compression-for-any-changes-due-to-the-hyperstore
TimescaleDB 2.18 includes a new procedure to merge chunks. This change adds the API documentation.
…tore-and-compression-for-any-changes-due-to-the-hyperstore
No description provided.