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] Improve the format and language of the doc for sink #275

Merged
merged 4 commits into from
Sep 4, 2023

Conversation

hellolilyliuyi
Copy link
Contributor

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Which issues of this PR fixes :

Fixes #

Problem Summary(Required) :

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr will affect users' behaviors
  • This pr needs user documentation (for new or modified features or behaviors)
  • I have added documentation for my new feature or new function

@hellolilyliuyi hellolilyliuyi changed the title Update connector-sink.md Doc Update connector-sink.md Aug 31, 2023

## Version requirements

| Connector | Flink | StarRocks | Java | Scala |
|-----------|--------------------------|---------------| ---- |-----------|
| 1.2.7 | 1.11,1.12,1.13,1.14,1.15 | 2.1 and later | 8 | 2.11,2.12 |
| 1.2.7 | 1.11,1.12,1.13,1.14,1.15 | 2.5 and later| 8 | 2.11,2.12 |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

版本这边是不是可以写sr 2.5 及以后

Copy link
Collaborator

Choose a reason for hiding this comment

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

suggest not. Flink connector has been used for a long time, and there are still a lot of users using SR 2.3 and before. It will confuse them if we say only support since 2.5

@hellolilyliuyi hellolilyliuyi changed the title Doc Update connector-sink.md [Doc] Update connector-sink.md Sep 4, 2023
@hellolilyliuyi hellolilyliuyi changed the title [Doc] Update connector-sink.md [Doc] edit language Sep 4, 2023

## Version requirements

| Connector | Flink | StarRocks | Java | Scala |
|-----------|--------------------------|---------------| ---- |-----------|
| 1.2.7 | 1.11,1.12,1.13,1.14,1.15 | 2.1 and later | 8 | 2.11,2.12 |
| 1.2.7 | 1.11,1.12,1.13,1.14,1.15 | 2.5 and later| 8 | 2.11,2.12 |
Copy link
Collaborator

Choose a reason for hiding this comment

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

suggest not. Flink connector has been used for a long time, and there are still a lot of users using SR 2.3 and before. It will confuse them if we say only support since 2.5

Comment on lines 5 to 7
The Flink connector supports DataStream API, Table API & SQL, and Python API.

The Flink connector boasts a higher and more stable performance than [flink-connector-jdbc](https://nightlies.apache.org/flink/flink-docs-master/docs/connectors/table/jdbc/) provided by Apache Flink®.
Copy link
Collaborator

Choose a reason for hiding this comment

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

How about merge these two lines to one line?

| table-name | Yes | NONE | The name of the table that you want to use to load data into StarRocks. |
| username | Yes | NONE | The username of the account that you want to use to load data into StarRocks. |
| table-name | Yes | NONE | The name of the table that you want to use to load data into StarRocks. |
| username | Yes | NONE | The username of the account that you want to use to load data into StarRocks. The account must have load permissions on the StarRocks table. See [User privileges](https://docs.starrocks.io/en-us/latest/administration/User_privilege). |
Copy link
Collaborator

Choose a reason for hiding this comment

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

also need SELECT privileges

@banmoy banmoy changed the title [Doc] edit language [Doc] Improve the format and language of sink Sep 4, 2023
@banmoy banmoy changed the title [Doc] Improve the format and language of sink [Doc] Improve the format and language of the doc for sink Sep 4, 2023
@banmoy banmoy merged commit 6dc043f into main Sep 4, 2023
5 checks passed
banmoy pushed a commit to banmoy/starrocks-connector-for-apache-flink that referenced this pull request Sep 6, 2023
)

Signed-off-by: hellolilyliuyi <hellolilyliuyi123@163.com>
banmoy pushed a commit to banmoy/starrocks-connector-for-apache-flink that referenced this pull request Sep 6, 2023
)

Signed-off-by: hellolilyliuyi <hellolilyliuyi123@163.com>
banmoy pushed a commit that referenced this pull request Sep 11, 2023
Signed-off-by: hellolilyliuyi <hellolilyliuyi123@163.com>
banmoy pushed a commit that referenced this pull request Sep 11, 2023
Signed-off-by: hellolilyliuyi <hellolilyliuyi123@163.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants