Skip to content

Commit f9bf126

Browse files
authored
Merge pull request #89276 from v-rihow/connector-azure-database-for-postgresql
edit pass: connector-azure-database-for-postgresql
2 parents ea5afef + 59a0517 commit f9bf126

File tree

1 file changed

+33
-31
lines changed

1 file changed

+33
-31
lines changed

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

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,47 +16,47 @@ ms.date: 09/16/2019
1616
ms.author: jingwang
1717

1818
---
19-
# Copy data to and from Azure Database for PostgreSQL using Azure Data Factory
19+
# Copy data to and from Azure Database for PostgreSQL by using Azure Data Factory
2020

21-
This article outlines how to use the Copy Activity in Azure Data Factory to copy data from Azure Database for PostgreSQL. It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity.
21+
This article describes how to use the copy activity feature in Azure Data Factory to copy data from Azure Database for PostgreSQL. It builds on the [Copy activity in Azure Data Factory](copy-activity-overview.md) article, which presents a general overview of copy activity.
2222

23-
This connector is specialized for [Azure Database for PostgreSQL service](../postgresql/overview.md). To copy data from generic PostgreSQL database located on-premises or in the cloud, use [PostgreSQL connector](connector-postgresql.md).
23+
This connector is specialized for the [Azure Database for PostgreSQL service](../postgresql/overview.md). To copy data from a generic PostgreSQL database located on-premises or in the cloud, use the [PostgreSQL connector](connector-postgresql.md).
2424

2525
## Supported capabilities
2626

2727
This Azure Database for PostgreSQL connector is supported for the following activities:
2828

29-
- [Copy activity](copy-activity-overview.md) with [supported source/sink matrix](copy-activity-overview.md)
29+
- [Copy activity](copy-activity-overview.md) with a [supported source/sink matrix](copy-activity-overview.md)
3030
- [Lookup activity](control-flow-lookup-activity.md)
3131

32-
You can copy data from Azure Database for PostgreSQL to any supported sink data store. Or, you can copy data from any supported source data store to Azure Database for PostgreSQL. For a list of data stores that are supported as sources/sinks by the copy activity, see the [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats) table.
32+
You can copy data from Azure Database for PostgreSQL to any supported sink data store. Or, you can copy data from any supported source data store to Azure Database for PostgreSQL. For a list of data stores that the copy activity supports as sources and sinks, see the [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats) table.
3333

34-
Azure Data Factory provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.
34+
Azure Data Factory provides a built-in driver to enable connectivity. Therefore, you don't need to manually install any driver to use this connector.
3535

3636
## Getting started
3737

3838
[!INCLUDE [data-factory-v2-connector-get-started](../../includes/data-factory-v2-connector-get-started.md)]
3939

40-
The following sections provide details about properties that are used to define Data Factory entities specific to Azure Database for PostgreSQL connector.
40+
The following sections offer details about properties that are used to define Data Factory entities specific to Azure Database for PostgreSQL connector.
4141

4242
## Linked service properties
4343

44-
The following properties are supported for Azure Database for PostgreSQL linked service:
44+
The following properties are supported for the Azure Database for PostgreSQL linked service:
4545

4646
| Property | Description | Required |
4747
|:--- |:--- |:--- |
48-
| type | The type property must be set to: **AzurePostgreSql** | Yes |
49-
| connectionString | An ODBC connection string to connect to Azure Database for PostgreSQL.<br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put password in Azure Key Vault and pull the `password` configuration out of the connection string. Refer to the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) article with more details. | Yes |
50-
| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to be used to connect to the data store. You can use Azure Integration Runtime or Self-hosted Integration Runtime (if your data store is located in private network). If not specified, it uses the default Azure Integration Runtime. |No |
48+
| type | The type property must be set to: **AzurePostgreSql**. | Yes |
49+
| connectionString | An ODBC connection string to connect to Azure Database for PostgreSQL.<br/>Mark this field as a SecureString to store it securely in Data Factory. You can also put a password in Azure Key Vault and pull the `password` configuration out of the connection string. See the following samples and [Store credentials in Azure Key Vault](store-credentials-in-key-vault.md) for more details. | Yes |
50+
| connectVia | This property represents the [integration runtime](concepts-integration-runtime.md) to be used to connect to the data store. You can use Azure Integration Runtime or Self-hosted Integration Runtime (if your data store is located in private network). If not specified, it uses the default Azure Integration Runtime. |No |
5151

52-
A typical connection string is `Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;Password=<Password>`. More properties you can set per your case:
52+
A typical connection string is `Server=<server>.postgres.database.azure.com;Database=<database>;Port=<port>;UID=<username>;Password=<Password>`. Here are more properties you can set per your case:
5353

5454
| Property | Description | Options | Required |
5555
|:--- |:--- |:--- |:--- |
56-
| EncryptionMethod (EM)| The method the driver uses to encrypt data sent between the driver and the database server. E.g., `EncryptionMethod=<0/1/6>;`| 0 (No Encryption) **(Default)** / 1 (SSL) / 6 (RequestSSL) | No |
57-
| ValidateServerCertificate (VSC) | Determines whether the driver validates the certificate that is sent by the database server when SSL encryption is enabled (Encryption Method=1). E.g., `ValidateServerCertificate=<0/1>;`| 0 (Disabled) **(Default)** / 1 (Enabled) | No |
56+
| EncryptionMethod (EM)| The method the driver uses to encrypt data sent between the driver and the database server. For example, `EncryptionMethod=<0/1/6>;`| 0 (No Encryption) **(Default)** / 1 (SSL) / 6 (RequestSSL) | No |
57+
| ValidateServerCertificate (VSC) | Determines whether the driver validates the certificate that's sent by the database server when SSL encryption is enabled (Encryption Method=1). For example, `ValidateServerCertificate=<0/1>;`| 0 (Disabled) **(Default)** / 1 (Enabled) | No |
5858

59-
**Example:**
59+
**Example**:
6060

6161
```json
6262
{
@@ -73,7 +73,9 @@ A typical connection string is `Server=<server>.postgres.database.azure.com;Data
7373
}
7474
```
7575

76-
**Example: store password in Azure Key Vault**
76+
**Example**:
77+
78+
***Store password in Azure Key Vault***
7779

7880
```json
7981
{
@@ -100,16 +102,16 @@ A typical connection string is `Server=<server>.postgres.database.azure.com;Data
100102

101103
## Dataset properties
102104

103-
For a full list of sections and properties available for defining datasets, see the [datasets](concepts-datasets-linked-services.md) article. This section provides a list of properties supported by Azure Database for PostgreSQL dataset.
105+
For a full list of sections and properties available for defining datasets, see [Datasets in Azure Data Factory](concepts-datasets-linked-services.md). This section provides a list of properties that Azure Database for PostgreSQL supports in datasets.
104106

105107
To copy data from Azure Database for PostgreSQL, set the type property of the dataset to **AzurePostgreSqlTable**. The following properties are supported:
106108

107109
| Property | Description | Required |
108110
|:--- |:--- |:--- |
109-
| type | The type property of the dataset must be set to: **AzurePostgreSqlTable** | Yes |
110-
| tableName | Name of the table. | No (if "query" in activity source is specified) |
111+
| type | The type property of the dataset must be set to **AzurePostgreSqlTable** | Yes |
112+
| tableName | Name of the table | No (if "query" in activity source is specified) |
111113

112-
**Example**
114+
**Example**:
113115

114116
```json
115117
{
@@ -127,18 +129,18 @@ To copy data from Azure Database for PostgreSQL, set the type property of the da
127129

128130
## Copy activity properties
129131

130-
For a full list of sections and properties available for defining activities, see the [Pipelines](concepts-pipelines-activities.md) article. This section provides a list of properties supported by Azure Database for PostgreSQL source.
132+
For a full list of sections and properties available for defining activities, see [Pipelines and activities in Azure Data Factory](concepts-pipelines-activities.md). This section provides a list of properties supported by an Azure Database for PostgreSQL source.
131133

132134
### Azure Database for PostgreSql as source
133135

134136
To copy data from Azure Database for PostgreSQL, set the source type in the copy activity to **AzurePostgreSqlSource**. The following properties are supported in the copy activity **source** section:
135137

136138
| Property | Description | Required |
137139
|:--- |:--- |:--- |
138-
| type | The type property of the copy activity source must be set to: **AzurePostgreSqlSource** | Yes |
139-
| query | Use the custom SQL query to read data. For example: `"SELECT * FROM MyTable"`. | No (if "tableName" in dataset is specified) |
140+
| type | The type property of the copy activity source must be set to **AzurePostgreSqlSource** | Yes |
141+
| query | Use the custom SQL query to read data. For example: `"SELECT * FROM MyTable"` | No (if the tableName property in the dataset is specified) |
140142

141-
**Example:**
143+
**Example**:
142144

143145
```json
144146
"activities":[
@@ -176,12 +178,12 @@ To copy data to Azure Database for PostgreSQL, the following properties are supp
176178

177179
| Property | Description | Required |
178180
|:--- |:--- |:--- |
179-
| type | The type property of the copy activity sink must be set to: **AzurePostgreSQLSink** | Yes |
180-
| preCopyScript | Specify a SQL query for the copy activity to execute before writing data into Azure Database for PostgreSQL in each run. You can use this property to clean up the preloaded data. | No |
181-
| writeBatchSize | Inserts data into the Azure Database for PostgreSQL table when the buffer size reaches writeBatchSize.<br>Allowed value is integer representing number of rows. | No (default is 10,000) |
182-
| writeBatchTimeout | Wait time for the batch insert operation to complete before it times out.<br>Allowed values are Timespan. An example is 00:30:00 (30 minutes). | No (default is 00:00:30) |
181+
| type | The type property of the copy activity sink must be set to **AzurePostgreSQLSink**. | Yes |
182+
| 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 |
183+
| writeBatchSize | Inserts data into the Azure Database for PostgreSQL table when the buffer size reaches writeBatchSize.<br>Allowed value is an integer that represents the number of rows. | No (default is 10,000) |
184+
| 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:00:30) |
183185

184-
**Example:**
186+
**Example**:
185187

186188
```json
187189
"activities":[
@@ -216,7 +218,7 @@ To copy data to Azure Database for PostgreSQL, the following properties are supp
216218

217219
## Lookup activity properties
218220

219-
To learn details about the properties, check [Lookup activity](control-flow-lookup-activity.md).
221+
For more information about the properties, see [Lookup activity in Azure Data Factory](control-flow-lookup-activity.md).
220222

221223
## Next steps
222-
For a list of data stores supported as sources and sinks by the copy activity in Azure Data Factory, see [supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).
224+
For a list of data stores supported as sources and sinks by the copy activity in Azure Data Factory, see [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).

0 commit comments

Comments
 (0)