Skip to content

Add example and notice about task type Stored Procedure #9651

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

Closed
wants to merge 26 commits into from

Conversation

hstdream
Copy link
Contributor

@hstdream hstdream commented Apr 21, 2022

Purpose of the pull request

this pr close: #8019

Brief change log

Verify this pull request

This pull request is 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:

@SbloodyS SbloodyS requested a review from zhongjiajie April 21, 2022 09:54
@SbloodyS SbloodyS added the first time contributor First-time contributor label Apr 21, 2022
@hstdream
Copy link
Contributor Author

this pr close: #8019

Copy link
Member

@zhongjiajie zhongjiajie left a comment

Choose a reason for hiding this comment

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

BTW, please use the English screenshot instead of Chinese one

- 运行标志:标识这个结点是否能正常调度,如果不需要执行,可以打开禁止执行开关。
- 描述:描述该节点的功能。
- 任务优先级:worker 线程数不足时,根据优先级从高到低依次执行,优先级一样时根据先进先出原则执行。
- Worker 分组:任务分配给 worker 组的机器执行,选择Default,会随机选择一台 worker 机执行。
Copy link
Member

Choose a reason for hiding this comment

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

Your Chinese docs should also use the highlight as English Default, just like your doc in English.

Copy link
Member

Choose a reason for hiding this comment

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

Default

- Node name: The node name in a workflow definition is unique.
Copy link
Member

Choose a reason for hiding this comment

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

you should change the document like https://github.com/apache/dolphinscheduler/blob/dev/docs/docs/en/guide/task/sql.md. We have section Overview and section Create DataSource

Copy link
Member

Choose a reason for hiding this comment

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

- Delayed execution time: The time (unit minute) that a task delays in execution.
- Timeout alarm: Check the timeout alarm and timeout failure. When the task runs exceed the "timeout", an alarm email will send and the task execution will fail.
- DataSource: The DataSource type of the stored procedure supports MySQL,POSTGRESQL,HIVE,SPARK,CLICKHOUSE,ORACLE,SQLSERVER,DB2 and PRESTO, select the corresponding DataSource.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- DataSource: The DataSource type of the stored procedure supports MySQL,POSTGRESQL,HIVE,SPARK,CLICKHOUSE,ORACLE,SQLSERVER,DB2 and PRESTO, select the corresponding DataSource.
- DataSource: The DataSource type of the stored procedure supports MySQL,POSTGRESQL,HIVE,SPARK,CLICKHOUSE,ORACLE,SQLSERVER,DB2 and PRESTO.

@zhongjiajie zhongjiajie added the Waiting for user feedback Waiting for feedback from issue/PR author label Apr 26, 2022
@caishunfeng
Copy link
Contributor

@hstdream Please resolve conflicts.

@hstdream hstdream requested a review from Tianqi-Dotes as a code owner May 16, 2022 02:24
Copy link
Member

@zhongjiajie zhongjiajie left a comment

Choose a reason for hiding this comment

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

  • I think we should also add ## Notice section to notice users they could only call Stored Procedure in this task, if they want to call Stored function, they should use SQL task
  • Please change your screenshot from Chinese to English

@@ -1,4 +1,10 @@
# Stored Procedure
# PROCEDURE
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# PROCEDURE
# Procedure

`PROCEDURE` 任务类型,用于执行存储过程的程序

## 创建任务

- 根据选择的数据源,执行存储过程。
> 拖动工具栏中的![PNG](https://analysys.github.io/easyscheduler_docs_cn/images/toolbar_PROCEDURE.png)任务节点到画板中,如下图所示:
Copy link
Member

Choose a reason for hiding this comment

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

Please change this png link from analysys.github.io to our local file like you add then in its Task Example section

@@ -470,7 +470,7 @@ export default {
link: '/zh-cn/docs/dev/user_doc/guide/task/dependent.html',
},
{
title: 'Stored Procedure',
title: 'Procedure,
link: '/zh-cn/docs/dev/user_doc/guide/task/stored-procedure.html',
Copy link
Member

Choose a reason for hiding this comment

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

I suggest we should change the task file name from stored-procedure to procedure to keep the file name same as the content title of first line

Suggested change
link: '/zh-cn/docs/dev/user_doc/guide/task/stored-procedure.html',
link: '/zh-cn/docs/dev/user_doc/guide/task/procedure.html',

Copy link
Member

Choose a reason for hiding this comment

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

Please also change the EN document


`PROCEDURE` task type, the program used to execute the stored procedure

## Create Task

- Execute the stored procedure according to the selected DataSource.
Copy link
Member

Choose a reason for hiding this comment

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

We should also add how to create task like others - Drag from the toolbar <img src="/img/tasks/icons/procedure.png" width="25"/> to the canvas.

@zhongjiajie
Copy link
Member

@hstdream CI failed, it is seem your have some unused imgs, and some deadlink in your change

@codecov-commenter
Copy link

codecov-commenter commented May 30, 2022

Codecov Report

Merging #9651 (22f7240) into dev (7bf49a7) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##                dev    #9651   +/-   ##
=========================================
  Coverage     38.56%   38.56%           
+ Complexity     4080     4077    -3     
=========================================
  Files          1021     1021           
  Lines         38264    38264           
  Branches       4392     4394    +2     
=========================================
  Hits          14756    14756           
  Misses        21784    21784           
  Partials       1724     1724           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@zhongjiajie
Copy link
Member

zhongjiajie commented May 30, 2022

Hi @hstdream CI still failed, you should remove the images '/img/tasks/demo/procedure_task1.png', '/img/procedure-en.png', '/img/procedure_edit.png', '/img/tasks/demo/procedure_task2.png' in img directory.

And change the screenshot docs/img/tasks/demo/procedure_task01.png docs/img/tasks/demo/procedure_task02.png language from Chinese to English

houshitao and others added 2 commits June 10, 2022 06:16
� Conflicts:
�	docs/docs/en/guide/task/stored-procedure.md
�	docs/docs/zh/guide/task/stored-procedure.md
Copy link
Member

@zhongjiajie zhongjiajie left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution, but please switch dolphinscheduler language to English for the screenshot, we only accept English version

@caishunfeng
Copy link
Contributor

I close this pr due to already implemented in dev branch.

@caishunfeng caishunfeng closed this Feb 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document first time contributor First-time contributor Waiting for user feedback Waiting for feedback from issue/PR author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature][Document] Add example and notice about task type Stored Procedure
5 participants