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

fix: update docs about partitioning. #3446

Open
wants to merge 11 commits into
base: latest
Choose a base branch
from

Conversation

billy-the-fish
Copy link
Contributor

No description provided.

Copy link

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-add-create-hypertable-link-for-schema-management

api/add_dimension.md Outdated Show resolved Hide resolved
api/add_dimension.md Outdated Show resolved Hide resolved
api/add_dimension.md Outdated Show resolved Hide resolved
api/dimension_info.md Outdated Show resolved Hide resolved
the `partition_func` argument of the dimension build to extract a compatible
data type. Look in the example section below.
</Highlight>

Dimension builders were introduced in TimescaleDB 2.13.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am confused by the section on "dimension builders". I know it was in the docs before, but it seems the concept is never really introduced. What is a dimension builder and why do I care about it?

My understanding is that it is just a set of functions you use together with create_hypertable() and add_dimension(), but those pages don't even mention the concept or make any reference to this section although the "builder" functions are used in those sections.

I guess am wondering why we need a separate section on dimension builders when it is not mentioned elsewhere?

If we are sticking with this concept of dimension builders, I think this section needs a better introduction to what they are and why they are useful, and when to use them.

But, if it was up to me, I would just take what is useful here and merge it with the sections on create_hypertable and add_dimension. I would probably skip the concept of "dimension builder" and just explain how to use the functions by_range() and by_hash()

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this comment, it really helps. I have had another look over this, and from what I understand this is talking about the _timescaledb_internal.dimension_info type returned when you call create_hypertable or add_dimension. How about as you suggest I add any useful information to those functions, and move the rest of the info to https://docs.timescale.com/api/latest/informational-views/ as a dimension_info object?

My head hurts.

api/add_dimension.md Outdated Show resolved Hide resolved
api/add_dimension.md Outdated Show resolved Hide resolved
api/add_dimension.md Outdated Show resolved Hide resolved
billy-the-fish and others added 3 commits October 1, 2024 14:48
Co-authored-by: Erik Nordström <[email protected]>
Signed-off-by: Iain Cox <[email protected]>
* fix: revert structure.
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.

2 participants