Skip to content
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

[Doc] update iotdb document #5404

Merged
merged 3 commits into from
Sep 5, 2023
Merged

[Doc] update iotdb document #5404

merged 3 commits into from
Sep 5, 2023

Conversation

liunaijie
Copy link
Contributor

@liunaijie liunaijie commented Aug 30, 2023

Purpose of this pull request

  1. close [Bug] [Docs] IoTDB Source example error #5399
  2. update document format to v2
  3. move host,port config as they duplicated with node_url config and node_url is required.

Check list

@liunaijie
Copy link
Contributor Author

@hailin0 PTAL

@zhilinli123
Copy link
Contributor

Hi @liunaijie Would you like to contribute v2.0 documentation to the Iotdb connector? I look forward to your contribution
issues:#4572
reference:https://github.com/apache/seatunnel/blob/dev/docs/en/connector-v2/source/Mysql.md
https://github.com/apache/seatunnel/blob/dev/docs/en/connector-v2/sink/Mysql.md

@liunaijie
Copy link
Contributor Author

sure

@ruanwenjun
Copy link
Member

LGTM, it's better to use v2.0 doc style as @zhilinli123 said.


Upstream SeaTunnelRow data format is the following:
Copy link
Member

Choose a reason for hiding this comment

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

why delete?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the sink example, I only add 1 case (fakesource to iotdb)(also 1 case in source example, use iotdb to console)

the key_timestamp is optional, so i remove it.
for example data, remove some filed to keep consistent with example code.

key_device = "device_name"
key_timestamp = "ts"
Copy link
Member

Choose a reason for hiding this comment

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

why delete?

```

Upstream SeaTunnelRow data format is the following:

| ts | device_name | field_1 | field_2 | temperature | moisture |
Copy link
Member

Choose a reason for hiding this comment

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

whl update ?

@liunaijie
Copy link
Contributor Author

@hailin0 when i update the doc, i find in source, node_url is required, and host, port is optional. but they all represent same thing.
I see you recommend set host,port in single node, but in this case node_url is still need to fill. is this duplicate? i want update the code, remove host,port option.

@EricJoy2048
Copy link
Member

We hope that there should be more examples in the document to demonstrate the scenarios in which different parameters are used. In general, we recommend at least three examples.

@liunaijie liunaijie force-pushed the iotdb_doc branch 2 times, most recently from f9e166c to 06028ad Compare September 1, 2023 09:05
@liunaijie
Copy link
Contributor Author

We hope that there should be more examples in the document to demonstrate the scenarios in which different parameters are used. In general, we recommend at least three examples.

updated

Copy link
Member

@ruanwenjun ruanwenjun left a comment

Choose a reason for hiding this comment

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

LGTM

@zhilinli123
Copy link
Contributor

thanks contribution PTAL: @EricJoy2048

@liugddx liugddx merged commit 856aedb into apache:dev Sep 5, 2023
44 checks passed
Zhouwen-CN pushed a commit to Zhouwen-CN/seatunnel that referenced this pull request Sep 11, 2023
* [Doc] update iotdb document, remove duplicated config

* [Doc] update iotdb document

* [Doc] update iotdb document
Zhouwen-CN pushed a commit to Zhouwen-CN/seatunnel that referenced this pull request Sep 11, 2023
* [Doc] update iotdb document, remove duplicated config

* [Doc] update iotdb document

* [Doc] update iotdb document
Zhouwen-CN pushed a commit to Zhouwen-CN/seatunnel that referenced this pull request Sep 11, 2023
* [Doc] update iotdb document, remove duplicated config

* [Doc] update iotdb document

* [Doc] update iotdb document
@liunaijie liunaijie deleted the iotdb_doc branch October 31, 2023 01:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug] [Docs] IoTDB Source example error
6 participants