Skip to content

Commit 9b962ab

Browse files
ttorblettorble
authored
Merge pull request #300497 from Lucky-Wang16/0528-Update_Amazon_Redshift_v2
Update Amazon Redshift v2 doc
2 parents 3f2b4dc + 8f84589 commit 9b962ab

File tree

3 files changed

+79
-27
lines changed

3 files changed

+79
-27
lines changed

‎articles/data-factory/connector-amazon-redshift.md

Lines changed: 75 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: jianleishen
77
ms.subservice: data-movement
88
ms.custom: synapse
99
ms.topic: conceptual
10-
ms.date: 09/12/2024
10+
ms.date: 05/28/2025
1111
---
1212

1313
# Copy data from Amazon Redshift using Azure Data Factory or Synapse Analytics
@@ -16,20 +16,25 @@ ms.date: 09/12/2024
1616

1717
This article outlines how to use the Copy Activity in Azure Data Factory and Synapse Analytics pipelines to copy data from an Amazon Redshift. It builds on the [copy activity overview](copy-activity-overview.md) article that presents a general overview of copy activity.
1818

19+
> [!IMPORTANT]
20+
> The Amazon Redshift version 2.0 (Preview) provides improved native Amazon Redshift support. If you are using the Amazon Redshift version 1.0 in your solution, you are recommended to [upgrade your Amazon Redshift connector](#upgrade-the-amazon-redshift-connector) at your earliest convenience. Refer to this [section](#differences-between-amazon-redshift-connector-version-20-and-version-10) for details on the difference between version 2.0 (Preview) and version 1.0.
21+
1922
## Supported capabilities
2023

2124
This Amazon Redshift connector is supported for the following capabilities:
2225

2326
| Supported capabilities|IR |
2427
|---------| --------|
25-
|[Copy activity](copy-activity-overview.md) (source/-)|① ②|
26-
|[Lookup activity](control-flow-lookup-activity.md)|① ②|
28+
|[Copy activity](copy-activity-overview.md) (source/-)|① (only for version 1.0) ②|
29+
|[Lookup activity](control-flow-lookup-activity.md)|① (only for version 1.0) ②|
2730

2831
*① Azure integration runtime ② Self-hosted integration runtime*
2932

3033
For a list of data stores that are supported as sources or sinks by the copy activity, see the [Supported data stores](copy-activity-overview.md#supported-data-stores-and-formats) table.
3134

32-
Specifically, this Amazon Redshift connector supports retrieving data from Redshift using query or built-in Redshift UNLOAD support.
35+
For version 2.0 (Preview), you need to [install the Amazon Redshift ODBC driver](https://docs.aws.amazon.com/redshift/latest/mgmt/odbc20-install-win.html) manually. For version 1.0, the service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver.
36+
37+
The Amazon Redshift connector supports retrieving data from Redshift using query or built-in Redshift UNLOAD support.
3338

3439
The connector supports the Windows versions in this [article](create-self-hosted-integration-runtime.md#prerequisites).
3540

@@ -38,7 +43,7 @@ The connector supports the Windows versions in this [article](create-self-hosted
3843
3944
## Prerequisites
4045

41-
* If you are copying data to an on-premises data store using [Self-hosted Integration Runtime](create-self-hosted-integration-runtime.md), grant Integration Runtime (use IP address of the machine) the access to Amazon Redshift cluster. See [Authorize access to the cluster](https://docs.aws.amazon.com/redshift/latest/gsg/rs-gsg-authorize-cluster-access.html) for instructions.
46+
* If you are copying data to an on-premises data store using [Self-hosted Integration Runtime](create-self-hosted-integration-runtime.md), grant Integration Runtime (use IP address of the machine) the access to Amazon Redshift cluster. See [Authorize access to the cluster](https://docs.aws.amazon.com/redshift/latest/gsg/rs-gsg-authorize-cluster-access.html) for instructions. If you use the version 2.0, your self-hosted integration runtime version should be 5.54.0.0 or above.
4247
* If you are copying data to an Azure data store, see [Azure Data Center IP Ranges](https://www.microsoft.com/download/details.aspx?id=41653) for the Compute IP address and SQL ranges used by the Azure data centers.
4348

4449
## Getting started
@@ -78,14 +83,42 @@ The following properties are supported for Amazon Redshift linked service:
7883
| Property | Description | Required |
7984
|:--- |:--- |:--- |
8085
| type | The type property must be set to: **AmazonRedshift** | Yes |
86+
| version | The version that you specify. | Yes for version 2.0 (Preview). |
8187
| server |IP address or host name of the Amazon Redshift server. |Yes |
8288
| port |The number of the TCP port that the Amazon Redshift server uses to listen for client connections. |No, default is 5439 |
8389
| database |Name of the Amazon Redshift database. |Yes |
8490
| username |Name of user who has access to the database. |Yes |
8591
| password |Password for the user account. Mark this field as a SecureString to store it securely, or [reference a secret stored in Azure Key Vault](store-credentials-in-key-vault.md). |Yes |
86-
| 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 |
92+
| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to be used to connect to the data store. <br>If you select version 2.0 (Preview), you can only use the self-hosted integration runtime and its version should be 5.54.0.0 or above.<br>If you select version 1.0, 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 |
8793

88-
**Example:**
94+
**Example: version 2.0 (Preview)**
95+
96+
```json
97+
{
98+
"name": "AmazonRedshiftLinkedService",
99+
"properties":
100+
{
101+
"type": "AmazonRedshift",
102+
"version": "2.0",
103+
"typeProperties":
104+
{
105+
"server": "<server name>",
106+
"database": "<database name>",
107+
"username": "<username>",
108+
"password": {
109+
"type": "SecureString",
110+
"value": "<password>"
111+
}
112+
},
113+
"connectVia": {
114+
"referenceName": "<name of Integration Runtime>",
115+
"type": "IntegrationRuntimeReference"
116+
}
117+
}
118+
}
119+
```
120+
121+
**Example: version 1.0**
89122

90123
```json
91124
{
@@ -234,26 +267,45 @@ For this sample use case, copy activity unloads data from Amazon Redshift to Ama
234267

235268
## Data type mapping for Amazon Redshift
236269

237-
When copying data from Amazon Redshift, the following mappings are used from Amazon Redshift data types to interim data types used internally within the service. See [Schema and data type mappings](copy-activity-schema-and-type-mapping.md) to learn about how copy activity maps the source schema and data type to the sink.
238-
239-
| Amazon Redshift data type | Interim service data type |
240-
|:--- |:--- |
241-
| BIGINT |Int64 |
242-
| BOOLEAN |String |
243-
| CHAR |String |
244-
| DATE |DateTime |
245-
| DECIMAL |Decimal |
246-
| DOUBLE PRECISION |Double |
247-
| INTEGER |Int32 |
248-
| REAL |Single |
249-
| SMALLINT |Int16 |
250-
| TEXT |String |
251-
| TIMESTAMP |DateTime |
252-
| VARCHAR |String |
270+
When you copy data from Amazon Redshift, the following mappings apply from Amazon Redshift's data types to the internal data types used by the service. To learn about how the copy activity maps the source schema and data type to the sink, see [Schema and data type mappings](copy-activity-schema-and-type-mapping.md).
271+
272+
| Amazon Redshift data type | Interim service data type (for version 2.0 (Preview)) | Interim service data type (for version 1.0) |
273+
|:--- |:--- |:--- |
274+
| BIGINT |Int64 |Int64 |
275+
| BOOLEAN |Boolean |String |
276+
| CHAR |String |String |
277+
| DATE |DateTime |DateTime |
278+
| DECIMAL |String |Decimal |
279+
| DOUBLE PRECISION |Double |Double |
280+
| INTEGER |Int32 |Int32 |
281+
| REAL |Single |Single |
282+
| SMALLINT |Int16 |Int16 |
283+
| TEXT |String |String |
284+
| TIMESTAMP |DateTime |DateTime |
285+
| VARCHAR |String |String |
253286

254287
## Lookup activity properties
255288

256289
To learn details about the properties, check [Lookup activity](control-flow-lookup-activity.md).
257290

291+
## Upgrade the Amazon Redshift connector
292+
293+
Here are steps that help you upgrade the Amazon Redshift connector:
294+
295+
1. In **Edit linked service** page, select version 2.0 (Preview) and configure the linked service by referring to [linked service properties](#linked-service-properties).
296+
297+
2. The data type mapping for the Amazon Redshift linked service version 2.0 (Preview) is different from that for the version 1.0. To learn the latest data type mapping, see [Data type mapping for Amazon Redshift](#data-type-mapping-for-amazon-redshift).
298+
299+
3. Apply a self-hosted integration runtime with version 5.54.0.0 or above. Azure integration runtime is not supported by version 2.0 (Preview).
300+
301+
## <a name="differences-between-amazon-redshift-connector-version-20-and-version-10"></a>Differences between Amazon Redshift connector version 2.0 (Preview) and version 1.0
302+
303+
The Amazon Redshift connector version 2.0 (Preview) offers new functionalities and is compatible with most features of version 1.0. The following table shows the feature differences between version 2.0 (Preview) and version 1.0.
304+
305+
| Version 2.0 (Preview) | Version 1.0 |
306+
| :----------- | :------- |
307+
| Only support the self-hosted integration runtime with version 5.54.0.0 or above. | Support the Azure integration runtime and self-hosted integration runtime. |
308+
| The following mappings are used from Amazon Redshift data types to interim service data type.<br><br>BOOLEAN -> Boolean <br>DECIMAL -> String| The following mappings are used from Amazon Redshift data types to interim service data type.<br><br>BOOLEAN -> String <br>DECIMAL -> Decimal|
309+
258310
## Related content
259311
For a list of data stores supported as sources and sinks by the copy activity, see [supported data stores](copy-activity-overview.md#supported-data-stores-and-formats).

‎articles/data-factory/connector-release-stages-and-timelines.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@ ms.author: jianleishen
66
ms.service: azure-data-factory
77
ms.subservice: data-movement
88
ms.topic: concept-article
9-
ms.custom:
10-
- references_regions
11-
- build-2025
12-
ms.date: 05/27/2025
9+
ms.custom: references_regions
10+
ms.date: 05/28/2025
1311
---
1412

1513
# Connector release stages and timelines
@@ -25,6 +23,8 @@ For comprehensive details on support levels and recommended usage at each stage,
2523
| [Amazon Marketplace Web Service](connector-amazon-marketplace-web-service.md) | / | Removed | / | / |
2624
| [Amazon RDS for Oracle](connector-amazon-rds-for-oracle.md) | version 2.0 | GA | / | / |
2725
| | version 1.0 | End of support announced | August 31, 2025 | October 31, 2025 |
26+
| [Amazon Redshift](connector-amazon-redshift.md) | version 2.0 | Public Preview | / | / |
27+
| | version 1.0 | GA | To be determined | / |
2828
| [Azure Database for MariaDB](connector-azure-database-for-mariadb.md) | / | End of support | December 31, 2024 | December 31, 2024 |
2929
| [Azure Database for PostgreSQL](connector-azure-database-for-postgresql.md) | version 2.0 | GA | / | / |
3030
| | version 1.0 | GA | To be determined | / |

‎articles/data-factory/media/connector-amazon-redshift/configure-amazon-redshift-linked-service.png

-6.67 KB
Loading

0 commit comments

Comments
 (0)