You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by GitBox <gi...@apache.org> on 2021/08/06 05:13:34 UTC

[GitHub] [incubator-doris] morningman opened a new pull request #6389: [Doc] Add document for datax and sample codes

morningman opened a new pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389


   ## Proposed changes
   
   Add documents for datax in `extension` catalog.
   Add documents for sampes in `best-practice` catalog.
   
   ## Types of changes
   
   What types of changes does your code introduce to Doris?
   _Put an `x` in the boxes that apply_
   
   - [ ] Bugfix (non-breaking change which fixes an issue)
   - [ ] New feature (non-breaking change which adds functionality)
   - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
   - [x] Documentation Update (if none of the other choices apply)
   - [ ] Code refactor (Modify the code structure, format the code, etc...)
   - [ ] Optimization. Including functional usability improvements and performance improvements.
   - [ ] Dependency. Such as changes related to third-party components.
   - [ ] Other.
   
   ## Checklist
   
   _Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
   
   - [ ] I have created an issue on (Fix #ISSUE) and described the bug/feature there in detail
   - [ ] Compiling and unit tests pass locally with my changes
   - [ ] I have added tests that prove my fix is effective or that my feature works
   - [ ] If these changes need document changes, I have updated the document
   - [ ] Any dependent changes have been merged
   
   ## Further comments
   
   If this is a relatively large or complex change, kick off the discussion at dev@doris.apache.org by explaining why you chose the solution you did and what alternatives you considered, etc...
   


-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] EmmyMiao87 commented on a change in pull request #6389: [Doc] Add document for datax and sample codes

Posted by GitBox <gi...@apache.org>.
EmmyMiao87 commented on a change in pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389#discussion_r683976251



##########
File path: docs/zh-CN/extending-doris/datax.md
##########
@@ -0,0 +1,41 @@
+---
+{
+    "title": "DataX doriswriter",
+    "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# DataX doriswriter
+
+[DataX](https://github.com/alibaba/DataX) doriswriter 插件，用于通过 DataX 同步其他数据源的数据到 Doris 中。
+
+## 编译安装
+
+插件代码位于 [这里](https://github.com/apache/incubator-doris/tree/master/extension/DataX)
+
+该插件通过 Doris 的 Stream Load 功能进行数据的同步和导入。需要配合 DataX 服务使用。
+
+请参阅 [README](https://github.com/apache/incubator-doris/blob/master/extension/DataX/README) 文档进行编译安装操作。

Review comment:
       What's different between this and [https://github.com/apache/incubator-doris/blob/master/extension/DataX/doriswriter/README]?
   Should we keep only one?




-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] github-actions[bot] commented on pull request #6389: [Doc] Add document for datax and sample codes

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389#issuecomment-895763313






-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] EmmyMiao87 commented on a change in pull request #6389: [Doc] Add document for datax and sample codes

Posted by GitBox <gi...@apache.org>.
EmmyMiao87 commented on a change in pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389#discussion_r683974256



##########
File path: docs/zh-CN/best-practices/samples.md
##########
@@ -0,0 +1,57 @@
+---
+{
+    "title": "使用示例",
+    "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 使用示例
+
+Doris 代码库中提供了丰富的使用示例，能够帮助 Doris 用户快速上手体验 Doris 的功能。
+
+## 示例说明
+
+示例代码都存放在 Doris 代码库的 [`samples/`](https://github.com/apache/incubator-doris/tree/master/samples) 目录下。
+
+```
+.
+├── connect
+├── doris-demo
+├── insert
+└── mini_load
+```
+
+* `connect/`
+
+    该目录下主要展示了各个程序语言连接 Doris 的代码示例。
+    
+* `doris-demo/`
+
+    该目下主要以 Maven 工程的形式，展示了 Doris 多个功能的代码示例。如 spark-connector 和 flink-connector 的使用示例、与 Spring 框架集成的示例、Stream Load 导入示例等等。

Review comment:
       这四个文件夹感觉并不是平级关系？




-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] morningman commented on a change in pull request #6389: [Doc] Add document for datax and sample codes

Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389#discussion_r684640980



##########
File path: docs/zh-CN/extending-doris/datax.md
##########
@@ -0,0 +1,41 @@
+---
+{
+    "title": "DataX doriswriter",
+    "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# DataX doriswriter
+
+[DataX](https://github.com/alibaba/DataX) doriswriter 插件，用于通过 DataX 同步其他数据源的数据到 Doris 中。
+
+## 编译安装
+
+插件代码位于 [这里](https://github.com/apache/incubator-doris/tree/master/extension/DataX)
+
+该插件通过 Doris 的 Stream Load 功能进行数据的同步和导入。需要配合 DataX 服务使用。
+
+请参阅 [README](https://github.com/apache/incubator-doris/blob/master/extension/DataX/README) 文档进行编译安装操作。

Review comment:
       I will move README of DataX to this document




-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] morningman merged pull request #6389: [Doc] Add document for datax and sample codes

Posted by GitBox <gi...@apache.org>.
morningman merged pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389


   


-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org

[GitHub] [incubator-doris] hf200012 commented on a change in pull request #6389: [Doc] Add document for datax and sample codes

Posted by GitBox <gi...@apache.org>.
hf200012 commented on a change in pull request #6389:
URL: https://github.com/apache/incubator-doris/pull/6389#discussion_r684640417



##########
File path: docs/zh-CN/best-practices/samples.md
##########
@@ -0,0 +1,57 @@
+---
+{
+    "title": "使用示例",
+    "language": "zh-CN"
+}
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 使用示例
+
+Doris 代码库中提供了丰富的使用示例，能够帮助 Doris 用户快速上手体验 Doris 的功能。
+
+## 示例说明
+
+示例代码都存放在 Doris 代码库的 [`samples/`](https://github.com/apache/incubator-doris/tree/master/samples) 目录下。
+
+```
+.
+├── connect
+├── doris-demo
+├── insert
+└── mini_load
+```
+
+* `connect/`
+
+    该目录下主要展示了各个程序语言连接 Doris 的代码示例。
+    
+* `doris-demo/`
+
+    该目下主要以 Maven 工程的形式，展示了 Doris 多个功能的代码示例。如 spark-connector 和 flink-connector 的使用示例、与 Spring 框架集成的示例、Stream Load 导入示例等等。

Review comment:
       主要是原先有三个，其实还需要在整理一下按照语言分类，该删除的删除，改迁移到doris-demo下的迁移




-- 
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@doris.apache.org

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



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org