Skip to content

Commit 75f4675

Browse files
committed
Update Amazon Redshift v2 doc
1 parent 39f053f commit 75f4675

File tree

2 files changed

+63
-18
lines changed

2 files changed

+63
-18
lines changed

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

Lines changed: 63 additions & 18 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
@@ -78,14 +78,42 @@ The following properties are supported for Amazon Redshift linked service:
7878
| Property | Description | Required |
7979
|:--- |:--- |:--- |
8080
| type | The type property must be set to: **AmazonRedshift** | Yes |
81+
| version | The version that you specify. | Yes |
8182
| server |IP address or host name of the Amazon Redshift server. |Yes |
8283
| port |The number of the TCP port that the Amazon Redshift server uses to listen for client connections. |No, default is 5439 |
8384
| database |Name of the Amazon Redshift database. |Yes |
8485
| username |Name of user who has access to the database. |Yes |
8586
| 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 |
8687
| 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 |
8788

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

90118
```json
91119
{
@@ -234,26 +262,43 @@ For this sample use case, copy activity unloads data from Amazon Redshift to Ama
234262

235263
## Data type mapping for Amazon Redshift
236264

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 |
265+
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).
266+
267+
| Amazon Redshift data type | Interim service data type (for version 2.0 (Preview)) | Interim service data type (for version 1.0) |
268+
|:--- |:--- |:--- |
269+
| BIGINT |Int64 |Int64 |
270+
| BOOLEAN |Boolean |String |
271+
| CHAR |String |String |
272+
| DATE |DateTime |DateTime |
273+
| DECIMAL |String |Decimal |
274+
| DOUBLE PRECISION |Double |Double |
275+
| INTEGER |Int32 |Int32 |
276+
| REAL |Single |Single |
277+
| SMALLINT |Int16 |Int16 |
278+
| TEXT |String |String |
279+
| TIMESTAMP |DateTime |DateTime |
280+
| VARCHAR |String |String |
253281

254282
## Lookup activity properties
255283

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

286+
## Upgrade the Amazon Redshift connector
287+
288+
Here are steps that help you upgrade the Amazon Redshift connector:
289+
290+
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).
291+
292+
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).
293+
294+
## Differences between Amazon Redshift connector version 2.0 (Preview) and version 1.0
295+
296+
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.
297+
298+
| Version 2.0 (Preview) | Version 1.0 |
299+
| :----------- | :------- |
300+
| Only support the self-hosted integration runtime. | Support the Azure integration runtime and self-hosted integration runtime. |
301+
| 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|
302+
258303
## Related content
259304
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).
-6.67 KB
Loading

0 commit comments

Comments
 (0)