danny0405 commented on a change in pull request #12610: URL: https://github.com/apache/flink/pull/12610#discussion_r439189092
########## File path: docs/dev/table/connectors/datagen.md ########## @@ -0,0 +1,149 @@ +--- +title: "DataGen SQL Connector" +nav-title: DataGen +nav-parent_id: sql-connectors +nav-pos: 4 +--- +<!-- +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">Scan Source: Bounded</span> +<span class="label label-primary">Scan Source: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Datagen connector allows for reading by data generation rules. + +The Datagen connector can work with [Computed Column syntax]({{ site.baseurl }}/dev/table/sql/create.html#create-table). +This allows you to generate records flexibly. + +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. + Review comment: `Not support complex types` -> `Complex types are not supported` ########## 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 +---------------- Review comment: an Blackhole -> `a Blackhole` ########## 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). + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE blackhole_table () WITH ('connector' = 'blackhole') +LIKE source_table (EXCLUDING ALL) +{% endhighlight %} Review comment: The `()` can be dropped. ########## File path: docs/dev/table/connectors/datagen.md ########## @@ -0,0 +1,149 @@ +--- +title: "DataGen SQL Connector" +nav-title: DataGen +nav-parent_id: sql-connectors +nav-pos: 4 +--- +<!-- +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">Scan Source: Bounded</span> +<span class="label label-primary">Scan Source: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Datagen connector allows for reading by data generation rules. + +The Datagen connector can work with [Computed Column syntax]({{ site.baseurl }}/dev/table/sql/create.html#create-table). +This allows you to generate records flexibly. + +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. + +How to create an Datagen table +---------------- Review comment: `an` -> `a` ########## File path: docs/dev/table/connectors/datagen.md ########## @@ -0,0 +1,149 @@ +--- +title: "DataGen SQL Connector" +nav-title: DataGen +nav-parent_id: sql-connectors +nav-pos: 4 +--- +<!-- +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">Scan Source: Bounded</span> +<span class="label label-primary">Scan Source: UnBounded</span> + +* This will be replaced by the TOC +{:toc} + +The Datagen connector allows for reading by data generation rules. + +The Datagen connector can work with [Computed Column syntax]({{ site.baseurl }}/dev/table/sql/create.html#create-table). +This allows you to generate records flexibly. + +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. + +How to create an Datagen table +---------------- + +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. Review comment: `default` -> `By default`. ---------------------------------------------------------------- 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: us...@infra.apache.org
