HIVE-29759: Add HPLSQL documentation to Apache Hive Official Documentation website. - #115
Conversation
mdayakar
changed the title
ee6772b to
0f105a5
Compare
mdayakar
changed the title
0f105a5 to
714b2d7
Compare
|
Thank you for the work of on the HPLSQL documentation! Other PR's to hive-site have "All checks have passed". This one has "1 workflow awaiting approval". Why did it not run the CI? Since last week, hive-site's CI will fail on warnings. If the CI for this PR has not run, how do we know that the CI does not fail after the merge? Edit: just saw that this branch is some commits behind the main branch. Could you rebase, please? |
|
|
||
| You can set all options dynamically using the [SET]({{< ref "assign" >}}) statement in a HPL/SQL script: `SET option=value;` | ||
|
|
||
| <!-- HPL/SQL configuration is stored in *hplsql-site.xml* file. This file stores options in the following format: |
There was a problem hiding this comment.
Why is this part of the doc commented out? Either it should be part of the doc, or the block should be removed.
There was a problem hiding this comment.
Thanks for the explanation, @mdayakar. We can keep the block to track the history. Could you add a comment to that block to explain why it has been commented out, please?
There was a problem hiding this comment.
Added the comment.
| DROP FUNCTION hello; | ||
| ``` | ||
|
|
||
| <!-- ## Permanent Functions and Stored Procedures |
thomasrebele
left a comment
thomasrebele
left a comment
There was a problem hiding this comment.
Some parts of the md files have been commented out with <!-- -->. This also concerns a lot of **Version** information. I think it makes sense to show that info.
Thanks for the review @thomasrebele. I intensionally commented some parts which are not applicable as per current code. I want to keep the text as commented (which will not be shown to the end user) for referring purpose for a developer. Also I commented Version information as this version specific to HPLSQL tool which was delivered as a separate tool but as a part of (HIVE-24230) HPL/SQL has been re-architected to an integrated part of HiveServer (HS2). So these versions are not applicable so commented them. HPLSQL documentation was hosted on http://hplsql.org site, now that site is down so to see the history we don't have any reference so I just commented the unrelated data for future reference, anyway that will not be shown to the enduser. |
714b2d7 to
f992368
Compare
thomasrebele
left a comment
thomasrebele
left a comment
There was a problem hiding this comment.
Thank you for the clarification about the <!-- --> blocks in the PR.
I did a very superficial review of the changes, and I've noticed that a few tables incorrectly use the first row as the header. It would be nice to fix that. As this is mainly cosmetic, it could even be merged as-is and fixed later. So LGTM. I don't have committer rights, so someone else needs to decide about the table headers anyways.
zabetak
left a comment
zabetak
left a comment
There was a problem hiding this comment.
In terms of structure I would prefer to see the HPL/SQL documentation directly under contents/docs/latest similar to hcatalog or if we consider it a language extension it would be better placed under contents/docs/latest/language. In addition, I would rename the hive-hplsql directory simply to hplsql since we are already in the Hive site.
This is the only change that I would like to see before merging to minimize changes in the public facing URLs later on.
…ation website. Updated the docs as per latest codebase.
f992368 to
fb106b7
Compare
|
In Dokuwiki format, we can have a table format without header but in markdown pages without header table format is not possible. |
…ation website. Changed hplsql doc location from content/docs/latest/user/hive-hplsql to content/docs/latest/language/hplsql.
Changed the HPLSQl document location from |
3 participants
Add HPLSQL documentation to Apache Hive Official Documentation website
Currently HPLSQL code is present in the Apache Hive's github repository but the corresponding documentation is present at http://hplsql.org/home website. This site is maintained by Dmitry Tolpeko so had a discussion with him and he is ok to host HPLSQL documentation content on the Apache Hive's official documentation page, thanks Dmitry Tolpeko.
Refer https://lists.apache.org/thread/tj3ptv38fj13c1rgwrkvk9o921rzn5tm thread for ore details.
The first commit represents converting the DokuWiki source pages into Hugo-flavored Markdown and lands them under a new content/docs/latest/user/hive-hplsql/. Later we need to modify the content as per current HPLSQL code present in Apache Hive github.
The second commit represents the changes as per current HPLSQL code present in the Apache Hive github repository. Initially it was provided as a stand alone command line tool. As a part of (HIVE-24230) HPL/SQL has been re-architected to an integrated part of HiveServer (HS2). Document also changed accordingly in second commit.
Some files intensionally renamed to *.md.bak which will not be displayed in the web documentation but they will be available in the github repository for history purpose for a developer. As http://hplsql.org/doc site is no more available, we will not be getting the history to check some details.