Skip to content

Commit 00b87e2

Browse files
chl-wxpchl-wxp
authored
[Improve][doc]Optimize the introduction of schema parameters in documents (#10385)
1 parent d2d5241 commit 00b87e2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+277
-274
lines changed

‎docs/en/connectors/source/AmazonSqs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Read data from Amazon SQS.
2929
|-------------------------|--------|----------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3030
| url | String | Yes | - | The Queue URL to read from Amazon SQS. |
3131
| region | String | No | - | The AWS region for the SQS service |
32-
| schema | Config | No | - | The structure of the data, including field names and field types. |
32+
| schema | Config | No | - | The structure of the data, including field names and field types. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md). |
3333
| format | String | No | json | Data format. The default format is json. Optional text format, canal-json and debezium-json.If you use json or text format. The default field separator is ", ". If you customize the delimiter, add the "field_delimiter" option.If you use canal format, please refer to [canal-json](../formats/canal-json.md) for details.If you use debezium format, please refer to [debezium-json](../formats/debezium-json.md) for details. |
3434
| format_error_handle_way | String | No | fail | The processing method of data format error. The default value is fail, and the optional value is (fail, skip). When fail is selected, data format error will block and an exception will be thrown. When skip is selected, data format error will skip this line data. |
3535
| field_delimiter | String | No | , | Customize the field delimiter for data format. |

‎docs/en/connectors/source/CosFile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ Only need to be configured when the file_format_type are text, json, excel, xml
289289

290290
#### fields [Config]
291291

292-
The schema of upstream data.
292+
The schema of upstream data. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md).
293293

294294
### sheet_name [string]
295295

‎docs/en/connectors/source/FakeSource.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ just for some test cases such as type conversion or connector new feature testin
2929
| Name | Type | Required | Default | Description |
3030
|-------------------------|----------|----------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
3131
| tables_configs | list | no | - | Define Multiple FakeSource, each item can contains the whole fake source config description below |
32-
| schema | config | yes | - | Define Schema information |
32+
| schema | config | yes | - | Define Schema information. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md). |
3333
| auto.increment.enabled | boolean | no | false | Enable auto increment ID generation |
3434
| auto.increment.start | int | no | | Starting value for auto increment ID |
3535
| rows | config | no | - | The row list of fake data output per degree of parallelism see title `Options rows Case`. |

‎docs/en/connectors/source/FtpFile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ then SeaTunnel will skip the first 2 lines from source files
360360

361361
Only need to be configured when the file_format_type are text, json, excel, xml or csv ( Or other format we can't read the schema from metadata).
362362

363-
The schema information of upstream data.
363+
The schema information of upstream data. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md).
364364

365365
### read_columns [list]
366366

‎docs/en/connectors/source/GoogleSheets.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ the range of the sheet you want to import
5151

5252
#### fields [config]
5353

54-
the schema fields of upstream data
54+
The schema fields of upstream data. Please refer to [Schema Feature](../../introduction/concepts/schema-feature.md).
5555

5656
## Example
5757

‎docs/en/connectors/source/HdfsFile.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Read data from hdfs file system.
6767
| kerberos_principal | string | no | - | The principal of kerberos |
6868
| kerberos_keytab_path | string | no | - | The keytab path of kerberos |
6969
| skip_header_row_number | long | no | 0 | Skip the first few lines, but only for the txt and csv.For example, set like following:`skip_header_row_number = 2`.then Seatunnel will skip the first 2 lines from source files |
70-
| schema | config | no | - | the schema fields of upstream data |
70+
| schema | config | no | - | the schema fields of upstream data. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md). |
7171
| sheet_name | string | no | - | Reader the sheet of the workbook,Only used when file_format is excel. |
7272
| xml_row_tag | string | no | - | Specifies the tag name of the data rows within the XML file, only used when file_format is xml. |
7373
| xml_use_attr_format | boolean | no | - | Specifies whether to process data using the tag attribute format, only used when file_format is xml. |

‎docs/en/connectors/source/Http.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ They can be downloaded via install-plugin.sh or from the Maven central repositor
4747
| Name | Type | Required | Default | Description |
4848
|-------------------------------|---------|----------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
4949
| url | String | Yes | - | Http request url. |
50-
| schema | Config | No | - | Http and seatunnel data structure mapping |
50+
| schema | Config | No | - | Http and seatunnel data structure mapping. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md). |
5151
| schema.fields | Config | No | - | The schema fields of upstream data |
5252
| json_field | Config | No | - | This parameter helps you configure the schema,so this parameter must be used with schema. |
5353
| pageing | Config | No | - | This parameter is used for paging queries |

‎docs/en/connectors/source/InfluxDB.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ select name,age from test
5959

6060
#### fields [Config]
6161

62-
The schema information of upstream data.
62+
The schema information of upstream data. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md).
6363
e.g.
6464

6565
```

‎docs/en/connectors/source/IoTDB.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Used to read data from IoTDB.
5151
| username | string | yes | - | IoTDB user username |
5252
| password | string | yes | - | IoTDB user password |
5353
| sql | string | yes | - | execute sql statement |
54-
| schema | config | yes | - | the data schema |
54+
| schema | config | yes | - | The data schema. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md). |
5555
| fetch_size | int | no | - | the fetch_size of the IoTDB when you select |
5656
| lower_bound | long | no | - | the lower_bound of the IoTDB when you select |
5757
| upper_bound | long | no | - | the upper_bound of the IoTDB when you select |

‎docs/en/connectors/source/IoTDBv2.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Used to read data from IoTDB.
5858
| sql_dialect | String | No | tree | The sql dialect of IoTDB, options available is `"tree"` or `"table"` |
5959
| database | String | No | - | The database selected (only valid when `sql_dielct` is `"table"`) |
6060
| sql | String | Yes | - | The sql statement to be executed |
61-
| schema | Config | Yes | - | The data schema |
61+
| schema | Config | Yes | - | The data schema. For more details, please refer to [Schema Feature](../../introduction/concepts/schema-feature.md). |
6262
| fetch_size | Integer | No | - | The fetch_size of the IoTDB when you select |
6363
| lower_bound | Long | No | - | The lower_bound of the IoTDB when you select |
6464
| upper_bound | Long | No | - | The upper_bound of the IoTDB when you select |

0 commit comments

Comments
 (0)