dailai commented on code in PR #6757:
URL: https://github.com/apache/seatunnel/pull/6757#discussion_r1593337097
##########
docs/en/concept/sql-config.md:
##########
@@ -0,0 +1,189 @@
+# SQL Configuration File
+
+## Structure of SQL Configuration File
+
+The `SQL` configuration file appears as follows.
+
+### SQL
+
+```sql
+/* config
+env {
+ parallelism = 1
+ job.mode = "BATCH"
+}
+*/
+
+CREATE TABLE source_table WITH (
+ 'connector'='jdbc',
+ 'type'='source',
+ 'url' = 'jdbc:mysql://localhost:3306/seatunnel',
+ 'driver' = 'com.mysql.cj.jdbc.Driver',
+ 'user' = 'root',
+ 'password' = '123456',
+ 'query' = 'select * from source',
+ 'properties'= '{
+ useSSL = false,
+ rewriteBatchedStatements = true
+ }'
+);
+
+CREATE TABLE sink_table WITH (
+ 'connector'='jdbc',
+ 'type'='sink',
+ 'url' = 'jdbc:mysql://localhost:3306/seatunnel',
+ 'driver' = 'com.mysql.cj.jdbc.Driver',
+ 'user' = 'root',
+ 'password' = '123456',
+ 'generate_sink_sql' = 'true',
+ 'database' = 'seatunnel',
+ 'table' = 'sink'
+);
+
+INSERT INTO sink_table SELECT id, name, age, email FROM source_table;
+```
+
+## Explanation of `SQL` Configuration File
+
+### General Configuration in SQL File
+
+```sql
+/* config
+env {
+ parallelism = 1
+ job.mode = "BATCH"
+}
+*/
+```
+
+In the `SQL` file, common configuration sections are defined using `/* config
*/` comments. Inside, common configurations like `env` can be defined using
`HOCON` format.
+
+### SOURCE SQL Syntax
+
+```sql
+CREATE TABLE source_table WITH (
+ 'connector'='jdbc',
+ 'type'='source',
+ 'url' = 'jdbc:mysql://localhost:3306/seatunnel',
+ 'driver' = 'com.mysql.cj.jdbc.Driver',
+ 'user' = 'root',
+ 'password' = '123456',
+ 'query' = 'select * from source',
+ 'properties' = '{
+ useSSL = false,
+ rewriteBatchedStatements = true
+ }'
+);
+```
+
+* Using `CREATE TABLE ... WITH (...)` syntax creates a mapping for the source
table. The `TABLE` name is the name of the source-mapped table, and the `WITH`
syntax contains source-related configuration parameters.
+* There are two fixed parameters in the WITH syntax: `connector` and `type`,
representing connector plugin name (such as `jdbc`, `FakeSource`, etc.) and
source type (fixed as `source`), respectively.
+* Other parameter names can reference relevant configuration parameters of the
corresponding connector plugin, but the format needs to be changed to `'key' =
'value',`.
+* If `'value'` is a sub-configuration, you can directly use a string in
`HOCON` format. Note: if using a sub-configuration in `HOCON` format, the
internal property items must be separated by `,`, like this:
+
+```sql
+'properties' = '{
+ useSSL = false,
+ rewriteBatchedStatements = true
+}'
+```
+
+* If using `'` within `'value'`, it needs to be escaped with `''`, like this:
+
+```sql
+'query' = 'select * from source where name = ''Joy Ding'''
+```
+
+### SINK SQL Syntax
+
+```sql
+CREATE TABLE sink_table WITH (
+ 'connector'='jdbc',
+ 'type'='sink',
+ 'url' = 'jdbc:mysql://localhost:3306/seatunnel',
+ 'driver' = 'com.mysql.cj.jdbc.Driver',
+ 'user' = 'root',
+ 'password' = '123456',
+ 'generate_sink_sql' = 'true',
+ 'database' = 'seatunnel',
+ 'table' = 'sink'
+);
+```
+
+* Using `CREATE TABLE ... WITH (...)` syntax creates a mapping for the target
table. The `TABLE` name is the name of the target-mapped table, and the `WITH`
syntax contains sink-related configuration parameters.
+* There are two fixed parameters in the `WITH` syntax: `connector` and `type`,
representing connector plugin name (such as `jdbc`, `console`, etc.) and target
type (fixed as `sink`), respectively.
+* Other parameter names can reference relevant configuration parameters of the
corresponding connector plugin, but the format needs to be changed to `'key' =
'value',`.
+
+### INSERT INTO SELECT Syntax
+
+```sql
+INSERT INTO sink_table SELECT id, name, age, email FROM source_table;
+```
+
+* The `SELECT FROM` part is the table name of the source-mapped table.
+* The `INSERT INTO` part is the table name of the target-mapped table.
+* Note: This syntax does **not support** specifying fields in `INSERT`, like
this: `INSERT INTO sink_table (id, name, age, email) SELECT id, name, age,
email FROM source_table;`
+
+### INSERT INTO SELECT TABLE Syntax
+
+```sql
+INSERT INTO sink_table SELECT source_table;
+```
+
+* The `SELECT` part directly uses the name of the source-mapped table,
indicating that all data from the source table will be inserted into the target
table.
+* sing this syntax does not generate related `transform` configurations. This
syntax is generally used in multi-table synchronization scenarios. For example:
Review Comment:
The first letter needs to be capitalized.
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
