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

Add documentation for SQL routines #18854

Merged
merged 1 commit into from
Oct 26, 2023
Merged

Conversation

mosabua
Copy link
Member

@mosabua mosabua commented Aug 29, 2023

Description

Add documentation for user-defined SQL functions including the following aspects:

  • Overview
  • Various docs for new keywords and such
  • Examples

To do:

  • reviews
  • test all examples
  • rebase after code PR is merged
  • figure out how and where to document routine storage support in connectors (currently Hive and Memory)

Additional context and related issues

Implementation: #19308

Release notes

(x) This is not user-visible or is docs only, and no release notes are required.

But this needs to be merged with the code PR which will make a big splash in the community and include a release notes entry or probably blog posts and more.

@cla-bot cla-bot bot added the cla-signed label Aug 29, 2023
@github-actions github-actions bot added the docs label Aug 29, 2023
@mosabua mosabua force-pushed the functions branch 4 times, most recently from abba9e1 to db0bee9 Compare September 19, 2023 17:09
@mosabua mosabua force-pushed the functions branch 7 times, most recently from 6c1238f to 5b6bbd3 Compare September 25, 2023 19:23
@mosabua mosabua force-pushed the functions branch 5 times, most recently from 59f0ec4 to e447b15 Compare October 6, 2023 05:39
Copy link
Member

@electrum electrum left a comment

Choose a reason for hiding this comment

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

Some initial comments

docs/src/main/sphinx/routines/begin.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/begin.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/leave.md Show resolved Hide resolved
docs/src/main/sphinx/routines/leave.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/repeat.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/set.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/set.md Outdated Show resolved Hide resolved
@mosabua mosabua changed the title (WIP) Add documentation for SQL functions (WIP) Add documentation for SQL routine Oct 10, 2023
@mosabua mosabua changed the title (WIP) Add documentation for SQL routine (WIP) Add documentation for SQL routines Oct 10, 2023
@mosabua mosabua marked this pull request as ready for review October 10, 2023 22:40
Copy link
Member Author

@mosabua mosabua left a comment

Choose a reason for hiding this comment

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

Did a bunch of updates .. more to come.

docs/src/main/sphinx/routines/leave.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/repeat.md Show resolved Hide resolved
docs/src/main/sphinx/routines/set.md Outdated Show resolved Hide resolved
@mosabua mosabua force-pushed the functions branch 3 times, most recently from 2fafebf to 19875e7 Compare October 23, 2023 17:36
@mosabua mosabua force-pushed the functions branch 5 times, most recently from 41258f3 to 09b167f Compare October 25, 2023 16:32
docs/src/main/sphinx/admin/properties-sql-environment.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines.md Show resolved Hide resolved
docs/src/main/sphinx/routines/begin.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/begin.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/begin.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/sql/select.md Show resolved Hide resolved
docs/src/main/sphinx/sql/select.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/sql/create-function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/sql/create-function.md Show resolved Hide resolved
docs/src/main/sphinx/sql/show-functions.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/examples.md Show resolved Hide resolved
docs/src/main/sphinx/routines/examples.md Show resolved Hide resolved
docs/src/main/sphinx/routines/examples.md Show resolved Hide resolved
docs/src/main/sphinx/routines/examples.md Show resolved Hide resolved
@mosabua mosabua force-pushed the functions branch 2 times, most recently from cd41c12 to 2c013b9 Compare October 25, 2023 21:55
docs/src/main/sphinx/routines/examples.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/if.md Outdated Show resolved Hide resolved
@mosabua mosabua force-pushed the functions branch 3 times, most recently from 9e097d9 to 47caa23 Compare October 25, 2023 23:04
docs/src/main/sphinx/routines/if.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/if.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/case.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/loop.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/return.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/set.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/declare.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/sql/select.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/sql/drop-function.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/sql/create-function.md Show resolved Hide resolved
docs/src/main/sphinx/sql/drop-function.md Show resolved Hide resolved
docs/src/main/sphinx/routines/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/introduction.md Outdated Show resolved Hide resolved
docs/src/main/sphinx/routines/introduction.md Show resolved Hide resolved
(routine-sql-environment)=
## SQL environment configuration

Configuration of the `sql.default-function-catalog` and
Copy link
Member

Choose a reason for hiding this comment

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

Agreed. Also, note that the default must be added to sql.path as well.

docs/src/main/sphinx/routines/introduction.md Outdated Show resolved Hide resolved
@mosabua mosabua force-pushed the functions branch 2 times, most recently from 67bec7b to 5731caa Compare October 26, 2023 00:08
- Add overview and examples
- Add supported statements for routines
- Add routine management statements
- Add SQL enviroment config properties
- Adjust docs for related statements
- Adjust Hive and Memory connector docs
@mosabua mosabua merged commit 84f83cb into trinodb:master Oct 26, 2023
3 checks passed
@mosabua mosabua deleted the functions branch October 26, 2023 00:16
@github-actions github-actions bot added this to the 431 milestone Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants