|
| TIMESTAMP
| TIMESTAMP |
| TIME
| TIME |
| DATE
| DATE |
| OTHER DATA TYPES | NOT SUPPORTED YET |
### Options[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#options)
| Name | Type | Required | Default | Description |
| ----------------------------------------------- | ------- | -------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| url | String | Yes | - | The URL of the JDBC connection. Refer to a case: jdbc:postgresql://localhost:5432/test
if you would use json or jsonb type insert please add jdbc url stringtype=unspecified option
|
| driver | String | Yes | - | The jdbc class name used to connect to the remote data source,
if you use PostgreSQL the value is org.postgresql.Driver.
|
| user | String | No | - | Connection instance user name |
| password | String | No | - | Connection instance password |
| query | String | No | - | Use this sql write upstream input datas to database. e.g `INSERT ...`,`query` have the higher priority |
| database | String | No | - | Use this database and table-name auto-generate sql and receive upstream input datas write to database.
This option is mutually exclusive with query and has a higher priority.
|
| table | String | No | - | Use database and this table-name auto-generate sql and receive upstream input datas write to database.
This option is mutually exclusive with query and has a higher priority.The table parameter can fill in the name of an unwilling table, which will eventually be used as the table name of the creation table, and supports variables (${table\_name}, ${schema\_name}). Replacement rules: ${schema\_name} will replace the SCHEMA name passed to the target side, and ${table\_name} will replace the name of the table passed to the table at the target side.
|
| primary\_keys | Array | No | - | This option is used to support operations such as `insert`, `delete`, and `update` when automatically generate sql. |
| support\_upsert\_by\_query\_primary\_key\_exist | Boolean | No | false | Choose to use INSERT sql, UPDATE sql to process update events(INSERT, UPDATE\_AFTER) based on query primary key exists. This configuration is only used when database unsupport upsert syntax. **Note**: that this method has low performance |
| connection\_check\_timeout\_sec | Int | No | 30 | The time in seconds to wait for the database operation used to validate the connection to complete. |
| max\_retries | Int | No | 0 | The number of retries to submit failed (executeBatch) |
| batch\_size | Int | No | 1000 | For batch writing, when the number of buffered records reaches the number of batch\_size or the time reaches checkpoint.interval
, the data will be flushed into the database
|
| is\_exactly\_once | Boolean | No | false | Whether to enable exactly-once semantics, which will use Xa transactions. If on, you need to
set xa\_data\_source\_class\_name.
|
| generate\_sink\_sql | Boolean | No | false | Generate sql statements based on the database table you want to write to. |
| xa\_data\_source\_class\_name | String | No | - | The xa data source class name of the database Driver, for example, PostgreSQL is org.postgresql.xa.PGXADataSource, and
please refer to appendix for other data sources
|
| max\_commit\_attempts | Int | No | 3 | The number of retries for transaction commit failures |
| transaction\_timeout\_sec | Int | No | -1 | The timeout after the transaction is opened, the default is -1 (never timeout). Note that setting the timeout may affect
exactly-once semantics
|
| auto\_commit | Boolean | No | true | Automatic transaction commit is enabled by default |
| field\_ide | String | No | - | Identify whether the field needs to be converted when synchronizing from the source to the sink. `ORIGINAL` indicates no conversion is needed;`UPPERCASE` indicates conversion to uppercase;`LOWERCASE` indicates conversion to lowercase. |
| properties | Map | No | - | Additional connection configuration parameters,when properties and URL have the same parameters, the priority is determined by the
specific implementation of the driver. For example, in MySQL, properties take precedence over the URL.
|
| common-options | | no | - | Sink plugin common parameters, please refer to [Sink Common Options](/data-integration-with-nexus/nexus-elements/connectors/sink/sink-common-options.md) for details |
| schema\_save\_mode | Enum | no | CREATE\_SCHEMA\_WHEN\_NOT\_EXIST | Before the synchronous task is turned on, different treatment schemes are selected for the existing surface structure of the target side. |
| data\_save\_mode | Enum | no | APPEND\_DATA | Before the synchronous task is turned on, different processing schemes are selected for data existing data on the target side. |
| custom\_sql | String | no | - | When data\_save\_mode selects CUSTOM\_PROCESSING, you should fill in the CUSTOM\_SQL parameter. This parameter usually fills in a SQL that can be executed. SQL will be executed before synchronization tasks. |
| enable\_upsert | Boolean | No | true | Enable upsert by primary\_keys exist, If the task has no key duplicate data, setting this parameter to `false` can speed up data import |
#### table \[string][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#table-string)
Use `database` and this `table-name` auto-generate sql and receive upstream input datas write to database.
This option is mutually exclusive with `query` and has a higher priority.
The table parameter can fill in the name of an unwilling table, which will eventually be used as the table name of the creation table, and supports variables (`${table_name}`, `${schema_name}`). Replacement rules: `${schema_name}` will replace the SCHEMA name passed to the target side, and `${table_name}` will replace the name of the table passed to the table at the target side.
for example:
1. ${schema\_name}.${table\_name} \_test
2. dbo.tt\_${table\_name} \_sink
3. public.sink\_table
#### schema\_save\_mode\[Enum][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#schema_save_modeenum)
Before the synchronous task is turned on, different treatment schemes are selected for the existing surface structure of the target side.\
Option introduction：\
`RECREATE_SCHEMA` ：Will create when the table does not exist, delete and rebuild when the table is saved\
`CREATE_SCHEMA_WHEN_NOT_EXIST` ：Will Created when the table does not exist, skipped when the table is saved\
`ERROR_WHEN_SCHEMA_NOT_EXIST` ：Error will be reported when the table does not exist
#### data\_save\_mode\[Enum][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#data_save_modeenum)
Before the synchronous task is turned on, different processing schemes are selected for data existing data on the target side.\
Option introduction：\
`DROP_DATA`： Preserve database structure and delete data\
`APPEND_DATA`：Preserve database structure, preserve data\
`CUSTOM_PROCESSING`：User defined processing\
`ERROR_WHEN_DATA_EXISTS`：When there is data, an error is reported
#### custom\_sql\[String][](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#custom_sqlstring)
When data\_save\_mode selects CUSTOM\_PROCESSING, you should fill in the CUSTOM\_SQL parameter. This parameter usually fills in a SQL that can be executed. SQL will be executed before synchronization tasks.
#### Tips[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#tips)
> If partition\_column is not set, it will run in single concurrency, and if partition\_column is set, it will be executed in parallel according to the concurrency of tasks.
### Task Example[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#task-example)
#### Simple:[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#simple)
> This example defines a Nexus synchronization task that automatically generates data through FakeSource and sends it to JDBC Sink. FakeSource generates a total of 16 rows of data (row\.num=16), with each row having two fields, name (string type) and age (int type). The final target table is test\_table will also be 16 rows of data in the table. Before run this job, you need create database test and table test\_table in your PostgreSQL.
```
# Defining the runtime environment
env {
parallelism = 1
job.mode = "BATCH"
}
source {
FakeSource {
parallelism = 1
result_table_name = "fake"
row.num = 16
schema = {
fields {
name = "string"
age = "int"
}
}
}
# If you would like to get more information about how to configure Nexus and see full list of source plugins,
# please go to source page
}
transform {
# If you would like to get more information about how to configure Nexus and see full list of transform plugins,
# please go to transform page
}
sink {
jdbc {
# if you would use json or jsonb type insert please add jdbc url stringtype=unspecified option
url = "jdbc:postgresql://localhost:5432/test"
driver = "org.postgresql.Driver"
user = root
password = 123456
query = "insert into test_table(name,age) values(?,?)"
}
# If you would like to get more information about how to configure Nexus and see full list of sink plugins,
# please go to sink page
}
```
#### Generate Sink SQL[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#generate-sink-sql)
> This example not need to write complex sql statements, you can configure the database name table name to automatically generate add statements for you
```
sink {
Jdbc {
# if you would use json or jsonb type insert please add jdbc url stringtype=unspecified option
url = "jdbc:postgresql://localhost:5432/test"
driver = org.postgresql.Driver
user = root
password = 123456
generate_sink_sql = true
database = test
table = "public.test_table"
}
}
```
#### Exactly-once :[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#exactly-once-)
> For accurate write scene we guarantee accurate once
```
sink {
jdbc {
# if you would use json or jsonb type insert please add jdbc url stringtype=unspecified option
url = "jdbc:postgresql://localhost:5432/test"
driver = "org.postgresql.Driver"
max_retries = 0
user = root
password = 123456
query = "insert into test_table(name,age) values(?,?)"
is_exactly_once = "true"
xa_data_source_class_name = "org.postgresql.xa.PGXADataSource"
}
}
```
#### CDC(Change Data Capture) Event[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#cdcchange-data-capture-event)
> CDC change data is also supported by us In this case, you need config database, table and primary\_keys.
```
sink {
jdbc {
# if you would use json or jsonb type insert please add jdbc url stringtype=unspecified option
url = "jdbc:postgresql://localhost:5432/test"
driver = "org.postgresql.Driver"
user = root
password = 123456
generate_sink_sql = true
# You need to configure both database and table
database = test
table = sink_table
primary_keys = ["id","name"]
field_ide = UPPERCASE
}
}
```
#### Save mode function[](https://seatunnel.apache.org/docs/2.3.7/connector-v2/sink/PostgreSql#save-mode-function)
```
sink {
Jdbc {
# if you would use json or jsonb type insert please add jdbc url stringtype=unspecified option
url = "jdbc:postgresql://localhost:5432/test"
driver = org.postgresql.Driver
user = root
password = 123456
generate_sink_sql = true
database = test
table = "public.test_table"
schema_save_mode = "CREATE_SCHEMA_WHEN_NOT_EXIST"
data_save_mode="APPEND_DATA"
}
}
```