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.

Sign up for GitHub

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

Jump to bottom

[Feature-8020][Document] Add example and notice about task type SQL #667

Merged

zhongjiajie merged 3 commits into apache:master from hongshuboy:Feature-8020

Feb 14, 2022

Contributor

hongshuboy commented Feb 3, 2022 •

edited by zhongjiajie

separate usage into multiple sections
use icon in process definitions page instead of a screenshot
add an example for one or two simple actual task
add images for sql task demo and use appropriate language screenshot

close: apache/dolphinscheduler#8020


          [Feature][Document] Add example and notice about task type SQL

484aafb

separate usage into multiple sections
use icon in process definitions page instead of a screenshot
add an example for one or two simple actual task
add images for sql task demo and use appropriate language screenshot

Contributor Author

hongshuboy commented Feb 3, 2022

apache/dolphinscheduler#8020

This comment was marked as resolved.

Sign in to view

zhongjiajie assigned hongshuboy

zhongjiajie added plugin refactor labels

zhongjiajie self-requested a review

February 7, 2022 03:09

Member

zhongjiajie commented Feb 7, 2022

I am going to see tonight

zhongjiajie added the waiting for review label

zhongjiajie reviewed

View reviewed changes

Member

zhongjiajie left a comment •

edited

I add some suggestions based on dev Chinese version, it has the same problem as others. PTAL if you have time

docs/zh-cn/dev/user_doc/guide/task/sql.md Outdated

-               </p>
+              ## 创建数据源
+              - 点击数据源中心的“创建数据源”按钮，输入连接信息并测试连接。

Member

zhongjiajie Feb 7, 2022

If there are just one point in the list, maybe we can just remove the list.
BTW, could we use the hyperlink to how to add data sources?

Suggested change

      
            - 点击数据源中心的“创建数据源”按钮，输入连接信息并测试连接。
          
            点击数据源中心的“创建数据源”按钮，输入连接信息并测试连接。

docs/zh-cn/dev/user_doc/guide/task/sql.md Outdated

+              ## 创建任务
+              - 点击项目管理-项目名称-工作流定义，点击"创建工作流"按钮，进入DAG编辑页面。
+              - 工具栏中拖动 <img src="/img/tasks/demo/sql-icon.png" width="25"/> 到画板中，选择需要连接的数据源，即可完成创建。

Member

zhongjiajie Feb 7, 2022

we have a specific directory to keep all tasks icon

Suggested change

      
            - 工具栏中拖动 <img src="/img/tasks/demo/sql-icon.png" width="25"/> 到画板中，选择需要连接的数据源，即可完成创建。
          
            - 工具栏中拖动 <img src="/img/tasks/icon/sql.png" width="25"/> 到画板中，选择需要连接的数据源，即可完成创建。

docs/zh-cn/dev/user_doc/guide/task/sql.md Outdated


		该样例向hive中创建临时表`tmp_hello_world`并写入一行数据。选择SQL类型为非查询，在创建临时表之前需要确保该表不存在，所以会用到SQL任务中“前置sql”的功能，在“sql语句”执行之前将该表删除。

		<img src="/img/tasks/demo/hive-sql-zh.png" alt="hive-sql-zh" style="zoom:80%;" />

Member

zhongjiajie Feb 7, 2022

Please use markdown syntax instead of html syntax. besides, we could only use English version pictures in both English and Chinese versions documents.

Suggested change

      
            <img src="/img/tasks/demo/hive-sql-zh.png" alt="hive-sql-zh" style="zoom:80%;" />
          
            ![hive-sql](/img/tasks/demo/hive-sql.png)

docs/zh-cn/dev/user_doc/guide/task/sql.md Outdated


		运行该任务成功之后在hive中查询结果

		<img src="/img/tasks/demo/hive-result.png" alt="hive-result" style="zoom:80%;" />

Member

zhongjiajie Feb 7, 2022

Please use markdown syntax

docs/zh-cn/dev/user_doc/guide/task/sql.md Outdated


		<img src="/img/tasks/demo/hive-sql-zh.png" alt="hive-sql-zh" style="zoom:80%;" />

		运行该任务成功之后在hive中查询结果

Member

zhongjiajie Feb 7, 2022

Maybe we should add more detail about how to query the result. I think point out user go to hive cli or beeline to query results in good way, due to DolphinScheduler do not have ad-hoc mechanism, WDYT

docs/zh-cn/dev/user_doc/guide/task/sql.md Outdated


		该样例向hive中创建临时表`tmp_hello_world`并写入一行数据。选择SQL类型为非查询，在创建临时表之前需要确保该表不存在，所以会用到SQL任务中“前置sql”的功能，在“sql语句”执行之前将该表删除。

		<img src="/img/tasks/demo/hive-sql-zh.png" alt="hive-sql-zh" style="zoom:80%;" />

Member

zhongjiajie Feb 7, 2022

BTW, do you mind use whole screenshot with step number for how to create sql task? just like https://github.com/apache/dolphinscheduler-website/blob/7ec0cc27c2701b635a2296b141cc446a2da4e19d/img/tasks/demo/shell.jpg did?

docs/en-us/dev/user_doc/guide/task/sql.md Outdated

    
              - Query SQL function: Edit and query SQL task information, sql type selection query, select form or attachment to send mail to the specified recipient, as shown in the figure below.

              SQL task, used to connect to remote database and execute SQL.

Member

zhongjiajie Feb 7, 2022

I think maybe we could remove keyword remote, just database because it could connect local DB, WDYT

Suggested change

      
            SQL task, used to connect to remote database and execute SQL.
          
            SQL task, used to connect to database and execute SQL.

zhongjiajie added waiting user response First-time contributor and removed waiting for review labels

Member

zhongjiajie commented Feb 7, 2022

About the example of how to create tables, I thinks is better to make our example could run directly, could we use parameter in the table name, like tmp_hello_world_${current_time} to make sure table not exists

Member

zhongjiajie commented Feb 7, 2022

About the example of how to create tables, I thinks is better to make our example could run directly, could we use parameter in the table name, like tmp_hello_world_${current_time} to make sure table not exists

I mean, just like below.

Contributor Author

hongshuboy commented Feb 9, 2022

copy that, I will submit the update in a few days.


          change img only use English screenshot

ee550e7

use whole screenshot with step number for how to create sql task
use custom parameters for sql task

Contributor Author

hongshuboy commented Feb 13, 2022

@zhongjiajie hi, I have submitted an update, and i'm sorry I accidentally removed assignment in apache/dolphinscheduler#8020, could you reassin this issue to me

This comment was marked as resolved.

Sign in to view

zhongjiajie added waiting for review and removed waiting user response labels

Member

zhongjiajie commented Feb 13, 2022

Thanks for the feedback, I restart the CI

zhongjiajie reviewed

View reviewed changes

docs/en-us/2.0.0/user_doc/guide/task/sql.md Outdated

-               </p>
+              ## create data source
+              Refer to [Data Source](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/datasource/introduction.html)

Member

zhongjiajie Feb 13, 2022

We should use a related path instead of the full path with a fixable version, in this case, we should use syntax [Data Source](../datasource/introduction.md)

Member

zhongjiajie Feb 13, 2022

So as others change, others LGTM

Member

zhongjiajie commented Feb 13, 2022

Hi @hongshuboy I add some suggestion above, PTAL


          use related path instead of the full path

67eed5b

Contributor Author

hongshuboy commented Feb 13, 2022 •

edited

@zhongjiajie hi, TBR

Contributor Author

hongshuboy commented Feb 13, 2022

I accidentally removed assignment in apache/dolphinscheduler#8020, could you reassin this issue to me

zhongjiajie approved these changes

View reviewed changes

Member

zhongjiajie left a comment

LGTM, thanks

zhongjiajie merged commit b6fde72 into apache:master

hongshuboy deleted the Feature-8020 branch

February 14, 2022 13:52

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment