sjwiesman commented on a change in pull request #12610: URL: https://github.com/apache/flink/pull/12610#discussion_r439012197
########## File path: docs/dev/table/connectors/blackhole.md ########## @@ -0,0 +1,94 @@ +--- +title: "Blackhole SQL Connector" +nav-title: Blackhole +nav-parent_id: sql-connectors +nav-pos: 6 +--- +<!-- +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. +--> + +<span class="label label-primary">Sink: Bounded</span> +<span class="label label-primary">Sink: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Blackhole connector allows for swallowing all input records. It is designed for: + +- high performance testing. +- UDF to output, not substantive sink. + +Just like /dev/null device on Unix-like operating systems. + +The Print connector is built-in. + +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. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE blackhole_table ( + f0 INT, + f1 INT, + f2 STRING, + f3 DOUBLE +) WITH ( + 'connector' = 'blackhole' +) +{% endhighlight %} +</div> +</div> + +Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table). Review comment: ```suggestion Alternativly, it may be based on an existing schema using the [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table). ``` ########## File path: docs/dev/table/connectors/blackhole.md ########## @@ -0,0 +1,94 @@ +--- +title: "Blackhole SQL Connector" +nav-title: Blackhole +nav-parent_id: sql-connectors +nav-pos: 6 +--- +<!-- +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. +--> + +<span class="label label-primary">Sink: Bounded</span> +<span class="label label-primary">Sink: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Blackhole connector allows for swallowing all input records. It is designed for: + +- high performance testing. +- UDF to output, not substantive sink. + +Just like /dev/null device on Unix-like operating systems. + +The Print connector is built-in. + +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. Review comment: I understand what you are trying to say but the statement sounds like a put down on Flink. Lets just drop it. ```suggestion ``` ########## File path: docs/dev/table/connectors/blackhole.md ########## @@ -0,0 +1,94 @@ +--- +title: "Blackhole SQL Connector" +nav-title: Blackhole +nav-parent_id: sql-connectors +nav-pos: 6 +--- +<!-- +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. +--> + +<span class="label label-primary">Sink: Bounded</span> +<span class="label label-primary">Sink: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Blackhole connector allows for swallowing all input records. It is designed for: + +- high performance testing. +- UDF to output, not substantive sink. + +Just like /dev/null device on Unix-like operating systems. + +The Print connector is built-in. Review comment: ```suggestion The Black connector is built-in. ``` ########## File path: docs/dev/table/connectors/print.md ########## @@ -0,0 +1,119 @@ +--- +title: "Print SQL Connector" +nav-title: Print +nav-parent_id: sql-connectors +nav-pos: 5 +--- +<!-- +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. +--> + +<span class="label label-primary">Sink: Bounded</span> +<span class="label label-primary">Sink: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Print connector allows for writing every row to the standard output or standard error stream. + +It is designed for: + +- Easy test for streaming job. +- Very useful in production debugging. + +Four possible format options: + +- PRINT_IDENTIFIER:taskId> output <- PRINT_IDENTIFIER provided, parallelism > 1 +- PRINT_IDENTIFIER> output <- PRINT_IDENTIFIER provided, parallelism == 1 +- 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)". + +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. + +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. Review comment: Same as above, lets drop this. ```suggestion ``` ########## File path: docs/dev/table/connectors/print.md ########## @@ -0,0 +1,119 @@ +--- +title: "Print SQL Connector" +nav-title: Print +nav-parent_id: sql-connectors +nav-pos: 5 +--- +<!-- +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. +--> + +<span class="label label-primary">Sink: Bounded</span> +<span class="label label-primary">Sink: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Print connector allows for writing every row to the standard output or standard error stream. + +It is designed for: + +- Easy test for streaming job. +- Very useful in production debugging. + +Four possible format options: + +- PRINT_IDENTIFIER:taskId> output <- PRINT_IDENTIFIER provided, parallelism > 1 +- PRINT_IDENTIFIER> output <- PRINT_IDENTIFIER provided, parallelism == 1 +- 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)". + +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. + +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. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE print_table ( + f0 INT, + f1 INT, + f2 STRING, + f3 DOUBLE +) WITH ( + 'connector' = 'print' +) +{% endhighlight %} +</div> +</div> + +Another way is using [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table). Review comment: ```suggestion Alternatively, it may be based on an existing schema using the [LIKE Clause]({{ site.baseurl }}/dev/table/sql/create.html#create-table). ``` ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: [email protected]
