Merge pull request #303707 from Lucky-Wang16/0801-Update_Azure_PostgreSQL_script_upsert

Update Azure PostgreSQL Script activity and Upsert

Author: prmerger-automator[bot]

articles/data-factory/connector-azure-database-for-postgresql.md

@@ -25,11 +25,12 @@ This connector is specialized for the [Azure Database for PostgreSQL service](/a
 
 This Azure Database for PostgreSQL connector is supported for the following capabilities:
 
-| Supported capabilities|IR | Managed private endpoint|
+| Supported capabilities | IR | Managed private endpoint | Connector supported versions |
 |---------| --------| --------|
-|[Copy activity](copy-activity-overview.md) (source/sink)|① ②|✓ |
-|[Mapping data flow](concepts-data-flow-overview.md) (source/sink)|① |✓ |
-|[Lookup activity](control-flow-lookup-activity.md)|① ②|✓ |
+|[Copy activity](copy-activity-overview.md) (source/sink)|① ②|✓ |1.0 & 2.0 |
+|[Mapping data flow](concepts-data-flow-overview.md) (source/sink)|① |✓ |1.0 & 2.0 |
+|[Lookup activity](control-flow-lookup-activity.md)|① ②|✓ |1.0 & 2.0 |
+|[Script activity](transform-data-using-script.md)|① ②|✓ |2.0 |
 
 *① Azure integration runtime ② Self-hosted integration runtime*
 
@@ -474,17 +475,20 @@ To copy data from Azure Database for PostgreSQL, set the source type in the copy
 
 ### Azure Database for PostgreSQL as sink
 
-To copy data to Azure Database for PostgreSQL, the following properties are supported in the copy activity **sink** section:
+To copy data to Azure Database for PostgreSQL, set the sink type in the copy activity to **SqlSink**. The following properties are supported in the copy activity **sink** section:
 
-| Property | Description | Required |
-|:--- |:--- |:--- |
-| type | The type property of the copy activity sink must be set to **AzurePostgreSqlSink**. | Yes |
-| preCopyScript | Specify a SQL query for the copy activity to execute before you write data into Azure Database for PostgreSQL in each run. You can use this property to clean up the preloaded data. | No |
-| writeMethod | The method used to write data into Azure Database for PostgreSQL.<br>Allowed values are: **CopyCommand** (default, which is more performant), **BulkInsert**. | No |
-| writeBatchSize | The number of rows loaded into Azure Database for PostgreSQL per batch.<br>Allowed value is an integer that represents the number of rows. | No (default is 1,000,000) |
-| writeBatchTimeout | Wait time for the batch insert operation to complete before it times out.<br>Allowed values are Timespan strings. An example is 00:30:00 (30 minutes). | No (default is 00:30:00) |
+| Property | Description | Required | Connector support version |
+|:--- |:--- |:--- |:--- |
+| type | The type property of the copy activity sink must be set to **AzurePostgreSQLSink**. | Yes | Version 1.0 & Version 2.0 |
+| preCopyScript | Specify a SQL query for the copy activity to execute before you write data into Azure Database for PostgreSQL in each run. You can use this property to clean up the preloaded data. | No | Version 1.0 & Version 2.0 |
+| writeMethod | The method used to write data into Azure Database for PostgreSQL.<br>Allowed values are: **CopyCommand** (default, which is more performant), **BulkInsert** and **Upsert** (Version 2.0 only). | No | Version 1.0 & Version 2.0 |
+| upsertSettings | Specify the group of the settings for write behavior. <br/> Apply when the WriteBehavior option is `Upsert`. | No | Version 2.0 |
+| ***Under `upsertSettings`:*** | | |
+| keys | Specify the column names for unique row identification. Either a single key or a series of keys can be used. Keys must be a primary key or unique column. If not specified, the primary key is used. | No | Version 2.0 |
+| writeBatchSize | The number of rows loaded into Azure Database for PostgreSQL per batch.<br>Allowed value is an integer that represents the number of rows. | No (default is 1,000,000) | Version 1.0 & Version 2.0 |
+| writeBatchTimeout | Wait time for the batch insert operation to complete before it times out.<br>Allowed values are Timespan strings. An example is 00:30:00 (30 minutes). | No (default is 00:30:00) | Version 1.0 & Version 2.0 |
 
-**Example**:
+**Example 1: Copy Command**
 
 ```json
 "activities":[
@@ -518,6 +522,47 @@ To copy data to Azure Database for PostgreSQL, the following properties are supp
 ]
 ```
 
+**Example 2: Upsert data**
+
+```json
+"activities":[
+    {
+        "name": "CopyToAzureDatabaseForPostgreSQL",
+        "type": "Copy",
+        "inputs": [
+            {
+                "referenceName": "<input dataset name>",
+                "type": "DatasetReference"
+            }
+        ],
+        "outputs": [
+            {
+                "referenceName": "<Azure PostgreSQL output dataset name>",
+                "type": "DatasetReference"
+            }
+        ],
+        "typeProperties": {
+            "source": {
+                "type": "<source type>"
+            },
+            "sink": {
+                "type": "AzurePostgreSQLSink",
+                "writeMethod": "Upsert",
+                "upsertSettings": {
+                    "keys": [
+                        "<column name>"
+                    ]
+                },
+            }
+        }
+    }
+]
+```
+
+### Upsert data
+
+Copy activity natively supports upsert operations. To perform an upsert, user should provide key column(s) that are either primary keys or unique columns. If the user does not provide key column(s) then primary key column(s) in the sink table are used. Copy Activity will update non-key column(s) in the sink table where the key column value(s) match those in the source table; otherwise, it will insert new data.
+
 ## Parallel copy from Azure Database for PostgreSQL
 
 The Azure Database for PostgreSQL connector in copy activity provides built-in data partitioning to copy data in parallel. You can find data partitioning options on the **Source** tab of the copy activity.
@@ -641,6 +686,17 @@ IncomingStream sink(allowSchemaDrift: true,
     skipDuplicateMapOutputs: true) ~> AzurePostgreSqlSink
 ```
 
+## Script activity
+
+> [!IMPORTANT]
+> Script activity is only supported in the version 2.0 connector.
+> [!IMPORTANT]
+> Multi-query statements using output parameters are not supported. It is recommended that you split any output queries into separate script blocks within the same or different script activity.
+>
+> Multi-query statements using positional parameters are not supported. It is recommended that you split any positional queries into separate script blocks within the same or different script activity.
+
+For more information about script activity, see [Script activity](transform-data-using-script.md).
+
 ## Lookup activity properties
 
 For more information about the properties, see [Lookup activity](control-flow-lookup-activity.md).

articles/data-factory/transform-data-using-script.md

@@ -6,7 +6,7 @@ ms.topic: conceptual
 author: nabhishek
 ms.author: abnarain
 ms.custom: synapse
-ms.date: 10/03/2024
+ms.date: 08/01/2025
 ms.subservice: orchestration
 ---
 
@@ -20,12 +20,12 @@ Using the script activity, you can execute common operations with Data Manipulat
 
 You can use the Script activity to invoke a SQL script in one of the following data stores in your enterprise or on an Azure virtual machine (VM): 
 
+- Azure Database for PostgreSQL (Version 2.0)
 - Azure SQL Database 
-- Azure Synapse Analytics 
-- SQL Server Database. If you're using SQL Server, install Self-hosted integration runtime on the same machine that hosts the database or on a separate machine that has access to the database. Self-Hosted integration runtime is a component that connects data sources on-premises/on Azure VM with cloud services in a secure and managed way. See the [Self-hosted integration runtime](create-self-hosted-integration-runtime.md) article for details. 
+- Azure Synapse Analytics
+- SQL Server Database. If you're using SQL Server, install Self-hosted integration runtime on the same machine that hosts the database or on a separate machine that has access to the database. Self-Hosted integration runtime is a component that connects data sources on-premises/on Azure VM with cloud services in a secure and managed way. See the [Self-hosted integration runtime](create-self-hosted-integration-runtime.md) article for details.
 - Oracle
 - Snowflake
-- Azure Database for PostgreSQL
 
 The script can contain either a single SQL statement or multiple SQL statements that run sequentially. You can use the Script task for the following purposes: