You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by GitBox <gi...@apache.org> on 2022/04/11 02:58:18 UTC

[GitHub] [hudi] huberylee opened a new pull request, #5285: Adding doc for procedures

huberylee opened a new pull request, #5285:
URL: https://github.com/apache/hudi/pull/5285

   ## *Tips*
   - *Thank you very much for contributing to Apache Hudi.*
   - *Please review https://hudi.apache.org/contribute/how-to-contribute before opening a pull request.*
   
   ## What is the purpose of the pull request
   
   Adding doc for procedures, including how to use and some details about specific procedures.
   
   ## Brief change log
   
   - Add ``website/docs/procedures.md``
   - Add entrance for procedures in the sidebar
   
   ## Verify this pull request
   
   *(Please pick either of the following options)*
   
   This pull request is a trivial rework / code cleanup without any test coverage.
   
   *(or)*
   
   This pull request is already covered by existing tests, such as *(please describe tests)*.
   
   (or)
   
   This change added tests and can be verified as follows:
   
   *(example:)*
   
     - *Added integration tests for end-to-end.*
     - *Added HoodieClientWriteTest to verify the change.*
     - *Manually verified the change by running a job locally.*
   
   ## Committer checklist
   
    - [ ] Has a corresponding JIRA in PR title & commit
    
    - [ ] Commit message is descriptive of the change
    
    - [ ] CI is green
   
    - [ ] Necessary doc changes done or have another open PR
          
    - [ ] For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [hudi] xushiyan commented on a diff in pull request #5285: Adding doc for procedures

Posted by GitBox <gi...@apache.org>.
xushiyan commented on code in PR #5285:
URL: https://github.com/apache/hudi/pull/5285#discussion_r847079308


##########
website/docs/quick-start-guide.md:
##########
@@ -1094,6 +1094,24 @@ alter table hudi_cow_pt_tbl drop partition (dt='2021-12-09', hh='10');
 Currently,  the result of `show partitions` is based on the filesystem table path. It's not precise when delete the whole partition data or drop certain partition directly.
 
 :::
+### Procedures
+**Syntax**
+```sql
+--Call procedure by positional arguments
+CALL system.procedure_name(arg_1, arg_2, ... arg_n)
+
+--Call procedure by named arguments
+CALL system.procedure_name(arg_name_2 => arg_2, arg_name_1 => arg_1, ... arg_name_n => arg_n)
+```
+**Examples**
+```sql
+--show commit's info
+call show_commits(table => 'test_hudi_table', limit => 10);
+```
+
+Call command has already support some commit procedures and table optimization procedures, 
+more details please refer to [procedures](/docs/next/procedures).

Review Comment:
   ```suggestion
   more details please refer to [procedures](/docs/procedures).
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [hudi] huberylee commented on a diff in pull request #5285: Adding doc for procedures

Posted by GitBox <gi...@apache.org>.
huberylee commented on code in PR #5285:
URL: https://github.com/apache/hudi/pull/5285#discussion_r847138656


##########
website/docs/quick-start-guide.md:
##########
@@ -1094,6 +1094,24 @@ alter table hudi_cow_pt_tbl drop partition (dt='2021-12-09', hh='10');
 Currently,  the result of `show partitions` is based on the filesystem table path. It's not precise when delete the whole partition data or drop certain partition directly.
 
 :::
+### Procedures
+**Syntax**
+```sql
+--Call procedure by positional arguments
+CALL system.procedure_name(arg_1, arg_2, ... arg_n)
+
+--Call procedure by named arguments
+CALL system.procedure_name(arg_name_2 => arg_2, arg_name_1 => arg_1, ... arg_name_n => arg_n)
+```
+**Examples**
+```sql
+--show commit's info
+call show_commits(table => 'test_hudi_table', limit => 10);
+```
+
+Call command has already support some commit procedures and table optimization procedures, 
+more details please refer to [procedures](/docs/next/procedures).

Review Comment:
   ![image](https://user-images.githubusercontent.com/11664307/162711604-725121af-2ecc-4c11-9fc7-b5d14ee23d28.png)
   
   If remove ``next``, the hyperlink redirect will not work.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [hudi] huberylee commented on pull request #5285: Adding doc for procedures

Posted by GitBox <gi...@apache.org>.
huberylee commented on PR #5285:
URL: https://github.com/apache/hudi/pull/5285#issuecomment-1094826372

   > LGTM. can you test in local website and see the hyperlink redirect working ok?
   
   I have already test in local website with ``npm start`` command, the hyperlink redirect working ok.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [hudi] xushiyan merged pull request #5285: Adding doc for procedures

Posted by GitBox <gi...@apache.org>.
xushiyan merged PR #5285:
URL: https://github.com/apache/hudi/pull/5285


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@hudi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org