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

Hypercore API ref #3699

Draft
wants to merge 41 commits into
base: release-2.18.0-main
Choose a base branch
from

Conversation

billy-the-fish
Copy link
Contributor

No description provided.

Copy link

github-actions bot commented Jan 9, 2025

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

Copy link

github-actions bot commented Jan 9, 2025

Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers).

Copy link

github-actions bot commented Jan 9, 2025

Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers).

@billy-the-fish billy-the-fish marked this pull request as draft January 9, 2025 15:07
@billy-the-fish billy-the-fish requested review from mkindahl, esclymeTS, philkra and LeeHampton and removed request for esclymeTS January 10, 2025 13:22
…tore-and-compression-for-any-changes-due-to-the-hyperstore
…tore-and-compression-for-any-changes-due-to-the-hyperstore
@philkra
Copy link
Contributor

philkra commented Jan 15, 2025

@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:
compress_chunk is deprecated in favour of convert_to_columnstore. As user, I would love to know if there is a replacement for the deprecated function, having a reference to the replacement would be handy.

Copy link
Contributor

@erimatnor erimatnor left a 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.

_partials/_hypercore_policy_workflow.md Outdated Show resolved Hide resolved
_partials/_hypercore_policy_workflow.md Outdated Show resolved Hide resolved
api/hypercore/add_columnstore_policy.md Outdated Show resolved Hide resolved
api/hypercore/add_columnstore_policy.md Outdated Show resolved Hide resolved
api/hypercore/add_columnstore_policy.md Outdated Show resolved Hide resolved
api/hypercore/page-index/page-index.js Outdated Show resolved Hide resolved
api/hypercore/page-index/page-index.js Outdated Show resolved Hide resolved
api/hypercore/page-index/page-index.js Outdated Show resolved Hide resolved
api/hypercore/remove_columnstore_policy.md Outdated Show resolved Hide resolved
api/hypercore/remove_columnstore_policy.md Outdated Show resolved Hide resolved
billy-the-fish and others added 4 commits January 15, 2025 16:42
Awesome review, thank you.

Co-authored-by: Erik Nordström <819732+erimatnor@users.noreply.github.com>
Signed-off-by: Iain Cox <iain@timescale.com>
api/compression/index.md Outdated Show resolved Hide resolved
Copy link

Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers).

Copy link

Oh no, the docs build failed! To see why visit the failing build (link only accessible to Timescalers).

Copy link
Contributor

@mkindahl mkindahl left a 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.

Comment on lines 46 to 48
|Column| Type | Description |
|-|-------------------------------------------------|-------------------------------------------------|
| `convert_to_columnstore` | REGCLASS | The name of the chunk added to the columnstore. |
Copy link
Contributor

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.

Copy link
Contributor Author

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.

api/hypercore/convert_to_columnstore.md Outdated Show resolved Hide resolved
api/hypercore/add_columnstore_policy.md Outdated Show resolved Hide resolved
api/hypercore/add_columnstore_policy.md Outdated Show resolved Hide resolved
api/hypercore/add_columnstore_policy.md Outdated Show resolved Hide resolved
billy-the-fish and others added 6 commits January 20, 2025 14:58
…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
@billy-the-fish billy-the-fish changed the base branch from latest to release-2.18.0-main January 27, 2025 09:45
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

Successfully merging this pull request may close these issues.

5 participants