Introduce more fields for in-source function documentation by rschu1ze · Pull Request #49300 · ClickHouse/ClickHouse

rschu1ze · 2023-04-28T11:28:11Z

Related: #49222

renamed class Documentation to FunctionDocumentation as other database "objects" (settings, system tables, etc.) use different "templates" for documentation
made the class more fine-granular, instead of

Description
Examples
Categories

we now have

Description
Syntax
Arguments
Returned Value
Examples
Categories.

This means more effort for the programmer but the generated documentation will look more uniform because more structural information is available.

The new fields are also exposed in system.functions (but undocumented because they may change again in future)

@DanRoscigno
@UnamedRus

Changelog category (leave one):

Improvement

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Split function-documentation into more fine-granular fields

robot-ch-test-poll4 · 2023-05-05T20:08:43Z

This is an automated comment for commit 4529511 with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🔴 failure

Check name	Description	Status
AST fuzzer	Runs randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help	🟢 success
CI running	A 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
ClickHouse build check	Builds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process	🟢 success
Compatibility check	Checks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help	🟢 success
Docker image for servers	The check to build and optionally push the mentioned image to docker hub	🟢 success
Fast test	Normally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here	🟢 success
Flaky tests	Checks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc	🟢 success
Install packages	Checks that the built packages are installable in a clear environment	🟢 success
Integration tests	The integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests	🟢 success
Mergeable Check	Checks if all other necessary checks are successful	🟢 success
Performance Comparison	Measure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests	🟢 success
Push to Dockerhub	The check for building and pushing the CI related docker images to docker hub	🟢 success
SQLancer	Fuzzing tests that detect logical bugs with SQLancer tool	🟢 success
Sqllogic	Run clickhouse on the sqllogic test set against sqlite and checks that all statements are passed	🟢 success
Stateful tests	Runs stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	🟢 success
Stateless tests	Runs stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	🔴 failure
Stress test	Runs stateless functional tests concurrently from several clients to detect concurrency-related errors	🟢 success
Style Check	Runs a set of checks to keep the code style clean. If some of tests failed, see the related log from the report	🟢 success
Unit tests	Runs the unit tests for different release types	🟢 success
Upgrade check	Runs stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts	🟢 success

hanfei1991

It looks cool! Is there a test to help me understand how the in-source documentation works?

DanRoscigno · 2023-05-11T13:14:54Z

It looks cool! Is there a test to help me understand how the in-source documentation works?

This test finds the functions that do not have entries in system.functions:
tests/queries/0_stateless/02415_all_new_functions_must_be_documented.sql

Here is how it is used now (by hand) contrib writing guide

In the future we plan to fill in the missing entries in the source and generate the docs in CI. Adding the correct fields and the logic to populate the tables from the source are the first steps.

UnamedRus · 2023-05-11T21:33:45Z

What about Parameters column in addition to Arguments?

DanRoscigno · 2023-05-11T23:46:43Z

closes #8562

rschu1ze · 2023-05-12T08:53:21Z

System table functions now shows in column arguments a human-readable representation of the arguments similar to the one in the documentation, e.g.

- haystack: String in which the search is performed. String.
- needle: Substring to be searched. String.

What about Parameters column in addition to Arguments?

Did you mean the argument type (e.g. "String")? This is currently part of Documentation::description which is admittedly not very clean (a separate field in class Documentation can be introduced in a separate PR).

UnamedRus · 2023-05-12T08:57:58Z

Did you mean the argument type (e.g. "String")? This is currently part of Documentation::description which is admittedly not very clean (a separate field in class Documentation can be introduced in a separate PR).

Not exactly,

I'm talking about

quantile(0,9)(value)

Where
value is argument
0.9 is parameter

rschu1ze · 2023-05-12T09:08:12Z

Interesting, haven't seen this syntax before, thanks! Makes for sure sense to have a field for that too.

I would nevertheless prefer to merge this PR as is because it is large and there is a risk of logical merge conflicts with other PRs. Also, this PR is technically about regular function docs whereas quantile is an aggregate function. I am sure there are even more "surprises" and things not covered yet in other function categories (think table functions, window functions, ...).

* Bump protobuf to v3.18.x (ref: ClickHouse/ClickHouse#50400) * Bump protobuf to v3.19.6 (ref: ClickHouse/ClickHouse#55963) * Bump protobuf to v3.19.6 (ref: ClickHouse/ClickHouse#50920) * Update contribe/orc (ref: ClickHouse/ClickHouse#53324) * Bump protobuf to v21.9 (ref: ClickHouse/ClickHouse#56014) * Removed unused code in google-protobuf-cmake/CMakeLists.txt (ref: ClickHouse/ClickHouse#56102) * Bump gRPC to v1.55.4 and protobuf to v22.5 (ref: ClickHouse/ClickHouse#56664) * Bump gRPC to v1.59 and protobuf to v24.4 (ref: ClickHouse/ClickHouse#56853) * enable functions in readonly mode (ref: ClickHouse/ClickHouse#42708) * Introduce more fields for in-source function documentation (ref: ClickHouse/ClickHouse#49300) * Add ability to convert timeplusd table structure to CapnProto/Protobuf format schema (ref: ClickHouse/ClickHouse#52278) * Well known protos (ref: ClickHouse/ClickHouse#56741) * Update protobuf to v25.1 (ref: ClickHouse/ClickHouse#58020) * fixed unit_tests_dbms build * Avoid ignoring errors of execute_process() (set COMMAND_ERROR_IS_FATAL=ANY) (ref: ClickHouse/ClickHouse#68267) * fixed reigsterFunction * fixed error after rebase

robot-ch-test-poll added the pr-improvement Pull request with some product improvements label Apr 28, 2023

rschu1ze force-pushed the rs/functdocs branch from 4c7b595 to 4a3b746 Compare May 5, 2023 20:07

rschu1ze force-pushed the rs/functdocs branch from 4a3b746 to a70e973 Compare May 5, 2023 20:39

rschu1ze changed the title ~~(wip) Introduce more fields for in-source function documentation~~ Introduce more fields for in-source function documentation May 5, 2023

rschu1ze marked this pull request as ready for review May 5, 2023 20:57

Introduce more fields for in-source function documentation

45c28e1

rschu1ze force-pushed the rs/functdocs branch from a70e973 to 45c28e1 Compare May 5, 2023 21:35

Fix table function docs

4529511

hanfei1991 self-assigned this May 11, 2023

hanfei1991 reviewed May 11, 2023

View reviewed changes

hanfei1991 approved these changes May 11, 2023

View reviewed changes

rschu1ze merged commit 9224204 into master May 12, 2023

rschu1ze deleted the rs/functdocs branch May 12, 2023 09:36

DanRoscigno mentioned this pull request May 12, 2023

Расширение информации в system.functions #8562

Closed

baibaichen mentioned this pull request May 22, 2023

[GLUTEN-1632][CH]Update Clickhouse Version (20230517) apache/gluten#1692

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce more fields for in-source function documentation#49300

Introduce more fields for in-source function documentation#49300
rschu1ze merged 2 commits intomasterfrom
rs/functdocs

rschu1ze commented Apr 28, 2023 •

edited

Loading

Uh oh!

robot-ch-test-poll4 commented May 5, 2023 •

edited by robot-ch-test-poll2

Loading

Uh oh!

hanfei1991 left a comment

Uh oh!

DanRoscigno commented May 11, 2023

Uh oh!

UnamedRus commented May 11, 2023

Uh oh!

DanRoscigno commented May 11, 2023

Uh oh!

rschu1ze commented May 12, 2023

Uh oh!

UnamedRus commented May 12, 2023

Uh oh!

rschu1ze commented May 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

rschu1ze commented Apr 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog category (leave one):

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Uh oh!

robot-ch-test-poll4 commented May 5, 2023 • edited by robot-ch-test-poll2 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hanfei1991 left a comment

Choose a reason for hiding this comment

Uh oh!

DanRoscigno commented May 11, 2023

Uh oh!

UnamedRus commented May 11, 2023

Uh oh!

DanRoscigno commented May 11, 2023

Uh oh!

rschu1ze commented May 12, 2023

Uh oh!

UnamedRus commented May 12, 2023

Uh oh!

rschu1ze commented May 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rschu1ze commented Apr 28, 2023 •

edited

Loading

robot-ch-test-poll4 commented May 5, 2023 •

edited by robot-ch-test-poll2

Loading