wuchong commented on a change in pull request #12574: URL: https://github.com/apache/flink/pull/12574#discussion_r438523573
########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> + </tr> + <tr> + <td>CHAR / VARCHAR / STRING</td> + <td>string</td> + </tr> + <tr> + <td>BOOLEAN</td> + <td>boolean</td> + </tr> + <tr> + <td>BINARY / VARBINARY</td> + <td>string</td> + </tr> + <tr> + <td>DECIMAL</td> + <td>number</td> + </tr> + <tr> + <td>TINYINT</td> + <td>number</td> + </tr> + <tr> + <td>SMALLINT</td> + <td>number</td> + </tr> + <tr> + <td>INT/INTERVAL_YEAR_MONTH</td> + <td>number</td> + </tr> + <tr> + <td>BIGINT/INTERVAL_DAY_TIME</td> + <td>number</td> + </tr> + <tr> + <td>FLOAT</td> + <td>number</td> + </tr> + <tr> + <td>DOUBLE</td> + <td>number</td> + </tr> + <tr> + <td>DATE</td> + <td>string</td> Review comment: string with format: date ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> + </tr> + <tr> + <td>CHAR / VARCHAR / STRING</td> + <td>string</td> + </tr> + <tr> + <td>BOOLEAN</td> + <td>boolean</td> + </tr> + <tr> + <td>BINARY / VARBINARY</td> + <td>string</td> + </tr> + <tr> + <td>DECIMAL</td> + <td>number</td> + </tr> + <tr> + <td>TINYINT</td> + <td>number</td> + </tr> + <tr> + <td>SMALLINT</td> + <td>number</td> + </tr> + <tr> + <td>INT/INTERVAL_YEAR_MONTH</td> + <td>number</td> + </tr> + <tr> + <td>BIGINT/INTERVAL_DAY_TIME</td> + <td>number</td> + </tr> + <tr> + <td>FLOAT</td> + <td>number</td> + </tr> + <tr> + <td>DOUBLE</td> + <td>number</td> + </tr> + <tr> + <td>DATE</td> + <td>string</td> + </tr> + <tr> + <td>TIME</td> + <td>string + </td> + </tr> + <tr> + <td>TIMESTAMP</td> + <td>string</td> + </tr> + <tr> + <td>ARRAY</td> + <td>array</td> + </tr> + <tr> + <td>MAP/MULTISET</td> + <td>object + <span class="label label-danger">Note</span> Only serialization is supported. Review comment: Both is supported? ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> Review comment: NULL is not supported in Flink SQL, remove this to avoid confuses. ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> + </tr> + <tr> + <td>CHAR / VARCHAR / STRING</td> + <td>string</td> + </tr> + <tr> + <td>BOOLEAN</td> + <td>boolean</td> + </tr> + <tr> + <td>BINARY / VARBINARY</td> + <td>string</td> + </tr> + <tr> + <td>DECIMAL</td> + <td>number</td> + </tr> + <tr> + <td>TINYINT</td> + <td>number</td> + </tr> + <tr> + <td>SMALLINT</td> + <td>number</td> + </tr> + <tr> + <td>INT/INTERVAL_YEAR_MONTH</td> + <td>number</td> + </tr> + <tr> + <td>BIGINT/INTERVAL_DAY_TIME</td> + <td>number</td> + </tr> + <tr> + <td>FLOAT</td> + <td>number</td> + </tr> + <tr> + <td>DOUBLE</td> + <td>number</td> + </tr> + <tr> + <td>DATE</td> + <td>string</td> + </tr> + <tr> + <td>TIME</td> + <td>string + </td> + </tr> + <tr> + <td>TIMESTAMP</td> + <td>string</td> Review comment: string with format: date-time ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> + </tr> + <tr> + <td>CHAR / VARCHAR / STRING</td> + <td>string</td> + </tr> + <tr> + <td>BOOLEAN</td> + <td>boolean</td> + </tr> + <tr> + <td>BINARY / VARBINARY</td> + <td>string</td> + </tr> + <tr> + <td>DECIMAL</td> + <td>number</td> + </tr> + <tr> + <td>TINYINT</td> + <td>number</td> + </tr> + <tr> + <td>SMALLINT</td> + <td>number</td> + </tr> + <tr> + <td>INT/INTERVAL_YEAR_MONTH</td> + <td>number</td> + </tr> + <tr> + <td>BIGINT/INTERVAL_DAY_TIME</td> Review comment: Add a new row for interval? `INTERVAL_YEAR_MONTH` and `INTERVAL_DAY_TIME` are root name, not type name. We can call them `INTERVAL` as they all converted to number. ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> + </tr> + <tr> + <td>CHAR / VARCHAR / STRING</td> + <td>string</td> + </tr> + <tr> + <td>BOOLEAN</td> + <td>boolean</td> + </tr> + <tr> + <td>BINARY / VARBINARY</td> + <td>string</td> + </tr> + <tr> + <td>DECIMAL</td> + <td>number</td> + </tr> + <tr> + <td>TINYINT</td> + <td>number</td> + </tr> + <tr> + <td>SMALLINT</td> + <td>number</td> + </tr> + <tr> + <td>INT/INTERVAL_YEAR_MONTH</td> + <td>number</td> + </tr> + <tr> + <td>BIGINT/INTERVAL_DAY_TIME</td> + <td>number</td> + </tr> + <tr> + <td>FLOAT</td> + <td>number</td> + </tr> + <tr> + <td>DOUBLE</td> + <td>number</td> + </tr> + <tr> + <td>DATE</td> + <td>string</td> + </tr> + <tr> + <td>TIME</td> + <td>string Review comment: string with format: time ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | Review comment: ```suggestion | `flink-json` | Built-in | ``` ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. + +The following table lists the type mapping from Flink type to JSON type. + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left">Flink Data Type</th> + <th class="text-center">JSON Data Type</th> + </tr> + </thead> + <tbody> + <tr> + <td>NULL</td> + <td>null/empty</td> + </tr> + <tr> + <td>CHAR / VARCHAR / STRING</td> + <td>string</td> + </tr> + <tr> + <td>BOOLEAN</td> + <td>boolean</td> + </tr> + <tr> + <td>BINARY / VARBINARY</td> + <td>string</td> Review comment: string with encoding: base64 ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to specify whether to fail if a field is missing or not, false by default.</td> + </tr> + <tr> + <td><h5>ignore-parse-errors</h5></td> + <td>optional</td> + <td style="word-wrap: break-word;">false</td> + <td>Boolean</td> + <td>Flag to skip fields and rows with parse errors instead of failing; + fields are set to null in case of errors, false by default.</td> + </tr> + </tbody> +</table> + +Data Type Mapping +---------------- + +Currently, the JSON schema is always derived from table schema. Explicitly defining an JSON schema is not supported yet. + +Flink JSON format uses utility class `com.fasterxml.jackson.databind.node.JsonNodeFactory` (for serialization) and `com.fasterxml.jackson.databind.JsonNode` (for deserialization) provided by `jackson` to convert Flink Data Types to and from JSON data types. Review comment: ``` Flink JSON format uses [jackson databind API](https://github.com/FasterXML/jackson-databind) to parse and generate JSON string. ``` ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' +) +{% endhighlight %} +</div> +</div> + +Format Options +---------------- + +<table class="table table-bordered"> + <thead> + <tr> + <th class="text-left" style="width: 25%">Option</th> + <th class="text-center" style="width: 8%">Required</th> + <th class="text-center" style="width: 7%">Default</th> + <th class="text-center" style="width: 10%">Type</th> + <th class="text-center" style="width: 50%">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td><h5>format</h5></td> + <td>required</td> + <td style="word-wrap: break-word;">(none)</td> + <td>String</td> + <td>Specify what format to use, here should be 'json'.</td> + </tr> + <tr> + <td><h5>fail-on-missing-field</h5></td> Review comment: I suggest to use `json.fail-on-missing-field` as the option key, because this is all the current connector how to use it. ########## File path: docs/dev/table/connectors/formats/json.md ########## @@ -0,0 +1,201 @@ +--- +title: "JSON Format" +nav-title: JSON +nav-parent_id: sql-formats +nav-pos: 2 +--- +<!-- +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-info">Format: Serialization Schema</span> +<span class="label label-info">Format: Deserialization Schema</span> + +* This will be replaced by the TOC +{:toc} + +The [JSON](https://www.json.org/json-en.html) format allows to read and write JSON data based on an JSON schema. Currently, the JSON schema is derived from table schema. + +Dependencies +------------ + +In order to setup the JSON format, the following table provides dependency information for both projects using a build automation tool (such as Maven or SBT) and SQL Client with SQL JAR bundles. + +| Maven dependency | SQL Client JAR | +| :----------------- | :----------------------| +| `flink-json` | The `flink-json-{{site.version}}.jar` is a built-in jar of SQL-CLI. | + +How to create a table with JSON format +---------------- + +Here is an example to create a table using Kafka connector and JSON format. + +<div class="codetabs" markdown="1"> +<div data-lang="SQL" markdown="1"> +{% highlight sql %} +CREATE TABLE user_behavior ( + user_id BIGINT, + item_id BIGINT, + category_id BIGINT, + behavior STRING, + ts TIMESTAMP(3) +) WITH ( + 'connector' = 'kafka', + 'topic' = 'user_behavior', + 'properties.bootstrap.servers' = 'localhost:9092', + 'properties.group.id' = 'testGroup', + 'format' = 'json' Review comment: ```suggestion 'format' = 'json', 'json.fail-on-missing-field' = 'false', 'json.ignore-parse-errors' = 'true' ``` I suggest to list some of the options, otherwise, users may still don't know how to use it. ---------------------------------------------------------------- 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]
