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

[Docs] add mortonEncode and mortonDecode #60868

Merged
merged 6 commits into from
Mar 11, 2024

Conversation

Blargian
Copy link
Contributor

@Blargian Blargian commented Mar 5, 2024

Closes #1984 as part of the project to document missing or incomplete functions in the documentation.

  • Added mortonEncode and mortonDecode to the docs (documentation was already written in the .cpp file, just needed to be replicated with some format tweaks).

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Documentation entry for user-facing changes

  • Documentation is written (mandatory for new features)

@Blargian Blargian changed the title [WIP] Add mortonEncode and mortonDecode to documentation Add mortonEncode and mortonDecode to documentation Mar 5, 2024
@Blargian
Copy link
Contributor Author

Blargian commented Mar 5, 2024

@johnnymatthews could you give this a quick lookover when you are able? Do we need to add examples using columns as arguments? There is an example like this (see below) in the function source file however as I understood functions in the documentation should be able to be run by copy pasting into ClickHouse play online which is why I excluded it and opted to just mention this possibility in the 'parameters' section.

SELECT mortonEncode((1,2), n1, n2) FROM table

@qoega qoega added the can be tested Allows running workflows for external contributors label Mar 5, 2024
@robot-clickhouse robot-clickhouse added the pr-documentation Documentation PRs for the specific code PR label Mar 5, 2024
@robot-clickhouse
Copy link
Member

robot-clickhouse commented Mar 5, 2024

This is an automated comment for commit 06a7665 with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR✅ success
Docs checkBuilds and tests the documentation✅ success
PR CheckThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS⏳ pending
Mergeable CheckChecks if all other necessary checks are successful❌ failure

@nikitamikhaylov
Copy link
Member

@Blargian You can just write some complex query using a subquery to emulate that you are selecting from a table.

@Blargian
Copy link
Contributor Author

Blargian commented Mar 5, 2024

@nikitamikhaylov thanks, I will add it

@Blargian Blargian changed the title Add mortonEncode and mortonDecode to documentation [WIP] Add mortonEncode and mortonDecode to documentation Mar 6, 2024
@Blargian Blargian changed the title [WIP] Add mortonEncode and mortonDecode to documentation Add mortonEncode and mortonDecode to documentation Mar 6, 2024
Add missing "Result:" after query
@rschu1ze rschu1ze merged commit 683d229 into ClickHouse:master Mar 11, 2024
21 checks passed
@robot-ch-test-poll robot-ch-test-poll added the pr-synced-to-cloud The PR is synced to the cloud repo label Mar 11, 2024
@Blargian Blargian changed the title Add mortonEncode and mortonDecode to documentation [Docs] add mortonEncode and mortonDecode Apr 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-documentation Documentation PRs for the specific code PR pr-synced-to-cloud The PR is synced to the cloud repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document mortonXYZ functions.
6 participants