[FLINK-17686][doc] Add document to dataGen, print, blackhole connectors #12610

JingsongLi · 2020-06-11T13:43:19Z

What is the purpose of the change

Add document to dataGen, print, blackhole connectors

Verifying this change

flinkbot · 2020-06-11T13:45:42Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit cb675d7 (Thu Jun 11 13:45:42 UTC 2020)

✅no warnings

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

Details

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2020-06-11T14:25:12Z

CI report:

4cfae48 Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

sjwiesman

Mostly looks good, just a few nits.

sjwiesman · 2020-06-11T19:10:55Z

docs/dev/table/connectors/blackhole.md

+How to create an Blackhole table
+----------------
+
+Although it doesn't make sense to define the fields of print table, you need to write them all in DDL.


I understand what you are trying to say but the statement sounds like a put down on Flink. Lets just drop it.

Suggested change

Although it doesn't make sense to define the fields of print table, you need to write them all in DDL.

sjwiesman · 2020-06-11T19:11:15Z

docs/dev/table/connectors/blackhole.md

+
+Just like /dev/null device on Unix-like operating systems.
+
+The Print connector is built-in.


Suggested change

The Print connector is built-in.

The Black connector is built-in.

sjwiesman · 2020-06-11T19:11:52Z

docs/dev/table/connectors/print.md

+How to create an Print table
+----------------
+
+Although it doesn't make sense to define the fields of print table, you need to write them all in DDL.


Same as above, lets drop this.

Suggested change

Although it doesn't make sense to define the fields of print table, you need to write them all in DDL.

sjwiesman · 2020-06-11T19:14:12Z

docs/dev/table/connectors/blackhole.md

+</div>
+</div>
+
+Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).


Suggested change

Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).

Alternativly, it may be based on an existing schema using the [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).

sjwiesman · 2020-06-11T19:14:44Z

docs/dev/table/connectors/print.md

+</div>
+</div>
+
+Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).


Suggested change

Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).

Alternatively, it may be based on an existing schema using the [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).

godfreyhe

Thanks for the contribution, I left some minor comments

godfreyhe · 2020-06-12T02:23:47Z

docs/dev/table/connectors/datagen.md

+For each field, there are two ways to generate data:
+
+- Random generator: default, you can specify random max and min values. For char/varchar/string, the length can be specified.
+- Sequence generator: you can specify sequence start and end values.


explain more about the behavior of after reaching the end value ?

default -> By default.

godfreyhe · 2020-06-12T02:31:50Z

docs/dev/table/connectors/print.md

+
+Four possible format options:
+
+- PRINT_IDENTIFIER:taskId> output  <- PRINT_IDENTIFIER provided, parallelism > 1


The web display is not friendly

godfreyhe · 2020-06-12T02:35:02Z

docs/dev/table/connectors/print.md

+- taskId> output         		   <- no PRINT_IDENTIFIER provided, parallelism > 1
+- output                 		   <- no PRINT_IDENTIFIER provided, parallelism == 1
+
+The output string format is "$RowKind(f0,f1,f2...)", example is: "+I(1,1)".


explain more about RowKind here or give a link where already explained it?

danny0405 · 2020-06-12T03:14:36Z

docs/dev/table/connectors/blackhole.md

+The Print connector is built-in.
+
+How to create an Blackhole table
+----------------


an Blackhole -> a Blackhole

danny0405 · 2020-06-12T03:35:08Z

docs/dev/table/connectors/blackhole.md

+{% highlight sql %}
+CREATE TABLE blackhole_table () WITH ('connector' = 'blackhole')
+LIKE source_table (EXCLUDING ALL)
+{% endhighlight %}


The () can be dropped.

danny0405 · 2020-06-12T03:36:13Z

docs/dev/table/connectors/datagen.md

+The Datagen connector is built-in.
+
+<span class="label label-danger">Attention</span> Not support complex types: Array, Map, Row. Please construct these types by computed column.
+


Not support complex types -> Complex types are not supported

danny0405 · 2020-06-12T03:36:29Z

docs/dev/table/connectors/datagen.md

+<span class="label label-danger">Attention</span> Not support complex types: Array, Map, Row. Please construct these types by computed column.
+
+How to create an Datagen table
+----------------


an -> a

danny0405 · 2020-06-12T03:38:04Z

docs/dev/table/connectors/datagen.md

+For each field, there are two ways to generate data:
+
+- Random generator: default, you can specify random max and min values. For char/varchar/string, the length can be specified.
+- Sequence generator: you can specify sequence start and end values.


default -> By default.

JingsongLi · 2020-06-12T05:52:51Z

Thanks @sjwiesman @godfreyhe @danny0405 for your review, updated.

godfreyhe · 2020-06-12T12:56:44Z

docs/dev/table/connectors/print.md

+    </tbody>
+</table>
+
+The output string format is "$row_kind(f0,f1,f2...)", row_kind is the short string of [RowKind](https://ci.apache.org/projects/flink/flink-docs-master/api/java/org/apache/flink/types/RowKind.html), example is: "+I(1,1)".


The url should be changed with flink version. such as for 1.11, flink-doces-master should be changed to flink-docs-release-1.11

Use { site.baseurl }

Changed to {{ site.baseurl }}

godfreyhe

LGTM

godfreyhe · 2020-06-15T02:01:00Z

docs/dev/table/connectors/print.md

+
+The Print connector is built-in.
+
+<span class="label label-danger">Attention</span> Print sink print records in tasks, you need to observe the task log.


nit: Print sink print ... -> Print sink prints ...

This closes apache#12610

This closes #12610

JingsongLi · 2020-06-15T02:21:05Z

Thanks all for your review, merged~

This closes apache#12610

rmetzger added review=description? component=Documentation component=TableSQL/Ecosystem labels Jun 11, 2020

sjwiesman requested changes Jun 11, 2020

View reviewed changes

godfreyhe reviewed Jun 12, 2020

View reviewed changes

danny0405 reviewed Jun 12, 2020

View reviewed changes

JingsongLi force-pushed the datagen_doc branch from 05e89e0 to 8b07356 Compare June 12, 2020 07:27

godfreyhe reviewed Jun 12, 2020

View reviewed changes

godfreyhe approved these changes Jun 15, 2020

View reviewed changes

JingsongLi added 3 commits June 15, 2020 10:17

[FLINK-17686][doc] Add document to dataGen connector

e04894c

[FLINK-17686][doc] Add document to blackhole connector

f3637ca

[FLINK-17686][doc] Add document to print connector

97fc6b3

This closes apache#12610

JingsongLi force-pushed the datagen_doc branch from 4cfae48 to 97fc6b3 Compare June 15, 2020 02:18

JingsongLi closed this in 97fc6b3 Jun 15, 2020

JingsongLi merged commit 97fc6b3 into apache:master Jun 15, 2020

JingsongLi added a commit that referenced this pull request Jun 15, 2020

[FLINK-17686][doc] Add document to print connector

2b18ae6

This closes #12610

bigdata-ny pushed a commit to bigdata-ny/flink that referenced this pull request Jun 19, 2020

[FLINK-17686][doc] Add document to print connector

60c9639

This closes apache#12610

zhangjun0x01 pushed a commit to zhangjun0x01/flink that referenced this pull request Jul 8, 2020

[FLINK-17686][doc] Add document to print connector

d63d11f

This closes apache#12610

JingsongLi deleted the datagen_doc branch November 5, 2020 09:45


		Just like /dev/null device on Unix-like operating systems.

		The Print connector is built-in.

	The Print connector is built-in.
	The Black connector is built-in.

	Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).
	Alternativly, it may be based on an existing schema using the [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).

	Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).
	Alternatively, it may be based on an existing schema using the [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table).


		Four possible format options:

		- PRINT_IDENTIFIER:taskId> output <- PRINT_IDENTIFIER provided, parallelism > 1

		The Datagen connector is built-in.

		<span class="label label-danger">Attention</span> Not support complex types: Array, Map, Row. Please construct these types by computed column.

[FLINK-17686][doc] Add document to dataGen, print, blackhole connectors #12610

[FLINK-17686][doc] Add document to dataGen, print, blackhole connectors #12610

Uh oh!

Conversation

JingsongLi commented Jun 11, 2020

What is the purpose of the change

Verifying this change

Uh oh!

flinkbot commented Jun 11, 2020

Automated Checks

Review Progress

Uh oh!

flinkbot commented Jun 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CI report:

Uh oh!

sjwiesman left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

godfreyhe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JingsongLi commented Jun 12, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

godfreyhe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JingsongLi commented Jun 15, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

flinkbot commented Jun 11, 2020 •

edited

Loading