Skip to content

Commit 0d599db

Browse files
Lucky-Wang16Lucky-Wang16
committed
Update
1 parent b05813d commit 0d599db

File tree

5 files changed

+147
-3
lines changed

5 files changed

+147
-3
lines changed

‎articles/data-factory/connector-amazon-rds-for-oracle.md

Lines changed: 147 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The following sections provide details about properties that are used to define
8181

8282
## Linked service properties
8383

84-
The Amazon RDS for Oracle connector now supports version 2.0. Refer to this [section](#upgrade-the-amazon-rds-for-oracle-connector) to upgrade your Amazon RDS for Oracle connector version from version 1.0. For the property details, see the corresponding sections.
84+
The Amazon RDS for Oracle connector version 2.0 supports TLS 1.3. Refer to this [section](#upgrade-the-amazon-rds-for-oracle-connector) to upgrade your Amazon RDS for Oracle connector version from version 1.0. For the property details, see the corresponding sections.
8585

8686
- [Version 2.0](#version-20)
8787
- [Version 1.0](#version-10)
@@ -177,6 +177,17 @@ For `server` property, you can specify it in one of the following three formats:
177177
|[Easy Connect (Plus) Naming](https://download.oracle.com/ocomdocs/global/Oracle-Net-Easy-Connect-Plus.pdf)|salesserver1:1521/sales.us.example.com|
178178
|[Oracle Net Services Name (TNS Alias)](https://docs.oracle.com/en/database/oracle/oracle-database/23/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-12C94B15-2CE1-4B98-9D0C-8226A9DDF4CB) (only for the self-hosted integration runtime)|sales|
179179

180+
The following list shows the supported parameters used in `server`. If you use parameters that are not in the following list, your connection fails.
181+
182+
- When using the Azure integration runtime:
183+
184+
HOST<br>PORT<br>PROTOCOL<br>SERVICE_NAME<br>SID<br>INSTANCE_NAME<br>SERVER<br>CONNECT_TIMEOUT<br>RETRY_COUNT<br>RETRY_DELAY<br>SSL_VERSION<br>SSL_SERVER_DN_MATCH<br>SSL_SERVER_CERT_DN
185+
186+
- When using the self-hosted integration runtime:
187+
188+
HOST<br>PORT<br>PROTOCOL<br>ENABLE<br>EXPIRE_TIME<br>FAILOVER<br>LOAD_BALANCE<br>RECV_BUF_SIZE<br>SDU<br>SEND_BUF_SIZE<br>SOURCE_ROUTE<br>TYPE_OF_SERVICE<br>COLOCATION_TAG<br>CONNECTION_ID_PREFIX<br>FAILOVER_MODE<br>GLOBAL_NAME<br>HS<br>INSTANCE_NAME<br>POOL_BOUNDARY<br>POOL_CONNECTION_CLASS<br>POOL_NAME<br>POOL_PURITY<br>RDB_DATABASE<br>SHARDING_KEY<br>SHARDING_KEY_ID<br>SUPER_SHARDING_KEY<br>SERVER<br>SERVICE_NAME<br>SID<br>TUNNEL_SERVICE_NAME<br>SSL_CLIENT_AUTHENTICATION<br>SSL_CERTIFICATE_ALIAS<br>SSL_CERTIFICATE_THUMBPRINT<br>SSL_VERSION<br>SSL_SERVER_DN_MATCH<br>SSL_SERVER_CERT_DN<br>WALLET_LOCATION<br>CONNECT_TIMEOUT<br>RETRY_COUNT<br>RETRY_DELAY<br>TRANSPORT_CONNECT_TIMEOUT<br>RECV_TIMEOUT<br>COMPRESSION<br>COMPRESSION_LEVELS
189+
190+
180191
### Version 1.0
181192

182193
The Amazon RDS for Oracle linked service supports the following properties:
@@ -329,7 +340,7 @@ To copy data from Amazon RDS for Oracle, set the source type in the copy activit
329340
|:--- |:--- |:--- |
330341
| type | The type property of the copy activity source must be set to `AmazonRdsForOracleSource`. | Yes |
331342
| oracleReaderQuery | Use the custom SQL query to read data. An example is `"SELECT * FROM MyTable"`.<br>When you enable partitioned load, you need to hook any corresponding built-in partition parameters in your query. For examples, see the [Parallel copy from Amazon RDS for Oracle](#parallel-copy-from-amazon-rds-for-oracle) section. | No |
332-
| convertDecimalToInteger | Oracle NUMBER type with zero or unspecified scale will be converted to corresponding integer. Allowed values are **true** and **false** (default). <br>If you are using Oracle version 2.0, this property will only be allowed to be set when supportV1DataTypes is true. | No |
343+
| convertDecimalToInteger | Amazon RDS for Oracle NUMBER type with zero or unspecified scale will be converted to corresponding integer. Allowed values are **true** and **false** (default). <br>If you are using Amazon RDS for Oracle version 2.0, this property will only be allowed to be set when supportV1DataTypes is true. | No |
333344
| partitionOptions | Specifies the data partitioning options used to load data from Amazon RDS for Oracle. <br>Allowed values are: **None** (default), **PhysicalPartitionsOfTable**, and **DynamicRange**.<br>When a partition option is enabled (that is, not `None`), the degree of parallelism to concurrently load data from an Amazon RDS for Oracle database is controlled by the [`parallelCopies`](copy-activity-performance-features.md#parallel-copy) setting on the copy activity. | No |
334345
| partitionSettings | Specify the group of the settings for data partitioning. <br>Apply when the partition option isn't `None`. | No |
335346
| partitionNames | The list of physical partitions that needs to be copied. <br>Apply when the partition option is `PhysicalPartitionsOfTable`. If you use a query to retrieve the source data, hook `?AdfTabularPartitionName` in the WHERE clause. For an example, see the [Parallel copy from Amazon RDS for Oracle](#parallel-copy-from-amazon-rds-for-oracle) section. | No |
@@ -464,6 +475,139 @@ Here are steps that help you upgrade the Amazon RDS for Oracle connector:
464475

465476
1. In **Edit linked service** page, select version 2.0 and configure the linked service by referring to [Linked service properties version 2.0](#version-20).
466477

478+
For the authentication related properties including username and password, specify the original values in the corresponding fields in version 2.0. Other connection properties such as host, port, and Amazon RDS for Oracle Service Name/Amazon RDS for Oracle SID in version 1.0 are now parameters of the [`server` property in version 2.0](#server-property-configuration).
479+
480+
For example, if you configure the version 1.0 linked service as shown below:
481+
482+
:::image type="content" source="media/connector-amazon-rds-for-oracle/version-1-linked-service.png" alt-text="Screenshot of version 1.0 linked service.":::
483+
484+
```json
485+
{
486+
"name": "AmazonRdsForOracleLinkedService",
487+
"properties": {
488+
"type": "AmazonRdsForOracle",
489+
"typeProperties": {
490+
"connectionString": "host=amazonrdsfororaclesample.com;port=1521;servicename=db1"
491+
},
492+
"connectVia": {
493+
"referenceName": "<name of Integration Runtime>",
494+
"type": "IntegrationRuntimeReference"
495+
}
496+
}
497+
}
498+
```
499+
500+
The identical version 2.0 linked service configuration using **Easy Connect (Plus) Naming** is:
501+
502+
:::image type="content" source="media/connector-amazon-rds-for-oracle/easy-connect-naming-linked-service.png" alt-text="Screenshot of linked service using easy connector (Plus) naming.":::
503+
504+
```json
505+
{
506+
"name": "AmazonRdsForOracleLinkedService",
507+
"properties": {
508+
"type": "AmazonRdsForOracle",
509+
"version": "2.0",
510+
"typeProperties": {
511+
"server": "amazonrdsfororaclesample.com:1521/db1",
512+
"username": "<user name>",
513+
"password": "<password>",
514+
"authenticationType": "<authentication type>"
515+
},
516+
"connectVia": {
517+
"referenceName": "<name of Integration Runtime>",
518+
"type": "IntegrationRuntimeReference"
519+
}
520+
}
521+
}
522+
```
523+
524+
The identical version 2.0 linked service configuration using **Connector Descriptor** is:
525+
526+
:::image type="content" source="media/connector-amazon-rds-for-oracle/connector-descriptor-linked-service.png" alt-text="Screenshot of linked service using connector descriptor.":::
527+
528+
```json
529+
{
530+
"name": "AmazonRdsForOracleLinkedService",
531+
"properties": {
532+
"type": "AmazonRdsForOracle",
533+
"version": "2.0",
534+
"typeProperties": {
535+
"server": "(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST= amazonrdsfororaclesample.com)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=db1)))",
536+
"username": "<user name>",
537+
"password": "<password>",
538+
"authenticationType": "<authentication type>"
539+
},
540+
"connectVia": {
541+
"referenceName": "<name of Integration Runtime>",
542+
"type": "IntegrationRuntimeReference"
543+
}
544+
}
545+
}
546+
```
547+
548+
> [!TIP]
549+
> Azure Key Vault is supported for the `server` property. You can edit the linked service JSON to add the Azure Key Vault reference, as shown below:<br>
550+
> :::image type="content" source="media/connector-amazon-rds-for-oracle/azure-key-vault-server.png" alt-text="Screenshot of using Azure Key Vault in server.":::
551+
552+
Note that:
553+
554+
- If you use **Oracle Service Name** in version 1.0, you can use **Easy Connect (Plus) Naming** or **Connector Descriptor** as the server format in version 2.0.
555+
556+
- If you use **Oracle SID** in version 1.0, you need to use **Connector Descriptor** as the server format in version 2.0.
557+
558+
- For some additional connection properties in version 1.0, we provide alternative properties or parameters in the `server` property in version 2.0. You can refer to the table below to upgrade the version 1.0 properties.
559+
560+
| Version 1.0 | Version 2.0 |
561+
|:--- |:--- |
562+
| encryptionmethod| PROTOCOL (parameter in `server`) |
563+
| tnsnamesfile | TNS_ADMIN (environment variable supported on the self-hosted integration runtime)  |
564+
| servername | server |
565+
| enablebulkload<br>Value: 1, 0 | enableBulkLoad <br>Value: true, false |
566+
| fetchtswtzastimestamp<br>Value: 1, 0 | fetchTswtzAsTimestamp <br>Value: true, false |
567+
| alternateservers | DESCRIPTION_LIST (parameter in `server`) |
568+
| arraysize | fetchSize |
569+
| cachedcursorlimit | statementCacheSize |
570+
| connectionretrycount | RETRY_COUNT (parameter in `server`) |
571+
| initializationstring | initializationString |
572+
| logintimeout | CONNECT_TIMEOUT (parameter in `server`) |
573+
| cryptoprotocolversion | SSL_VERSION (parameter in `server`) |
574+
| truststore | WALLET_LOCATION (parameter in `server`) |
575+
576+
For example, if you use `alternateservers` in version 1.0, you can set the `DESCRIPTION_LIST` parameter in the server property in version 2.0:
577+
578+
Version 1.0 linked service using `alternateservers`:
579+
580+
```json
581+
{
582+
"name": "AmazonRdsForOracleV1",
583+
"properties": {
584+
"type": "AmazonRdsForOracle",
585+
"typeProperties": {
586+
"connectionString": "host=amazonrdsfororaclesample.com;port=1521;servicename=db1;alternateservers=(HostName= amazonrdsfororaclesample2.com:PortNumber=1521:SID=db2,HostName=255.201.11.24:PortNumber=1522:ServiceName=db3)"
587+
}
588+
}
589+
}
590+
```
591+
592+
Identical version 2.0 linked service using `DESCRIPTION_LIST` parameter in **Connector Descriptor**:
593+
594+
```json
595+
{
596+
"name": "AmazonRdsForOracleV2",
597+
"properties": {
598+
"type": "AmazonRdsForOracle",
599+
"version": "2.0",
600+
"typeProperties": {
601+
"server": "(DESCRIPTION_LIST=(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=amazonrdsfororaclesample.com)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=db1)))(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=amazonrdsfororaclesample2.com)(PORT=1521))(CONNECT_DATA=(SID=db2)))(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=255.201.11.24)(PORT=1522))(CONNECT_DATA=(SERVICE_NAME=db3))))",
602+
"username": "<user name>",
603+
"password": "<password>",
604+
"authenticationType": "<authentication type>"
605+
}
606+
}
607+
}
608+
```
609+
610+
467611
2. The data type mapping for the Amazon RDS for Oracle linked service version 2.0 is different from that for the version 1.0. To learn the latest data type mapping, see [Data type mapping for Amazon RDS for Oracle](#data-type-mapping-for-amazon-rds-for-oracle).
468612

469613
An additional connection property `supportV1DataTypes` in version 2.0 can reduce upgrade difficulties caused by data type changes. Setting this property to `true` ensures that the data type in version 2.0 remains consistent with version 1.0.
@@ -476,7 +620,7 @@ The Amazon RDS for Oracle connector version 2.0 offers new functionalities and i
476620
|:--- |:--- |
477621
|The following mappings are used from Amazon RDS for Oracle data types to interim service data types used by the service internally. <br><br>NUMBER(p,s) -> Int16, Int32, Int64, Double, Single, Decimal <br>FLOAT(p)-> Double or Decimal based on its precision <br>NUMBER -> Decimal <br>TIMESTAMP WITH TIME ZONE -> DateTimeOffset <br>INTERVAL YEAR TO MONTH -> Int64 <br>INTERVAL DAY TO SECOND -> TimeSpan |The following mappings are used from Amazon RDS for Oracle data types to interim service data types used by the service internally. <br><br>NUMBER(p,s) -> Decimal or String based on its precision <br>FLOAT(p)-> Double <br>NUMBER -> Double <br>TIMESTAMP WITH TIME ZONE -> DateTime <br>INTERVAL YEAR TO MONTH -> String <br>INTERVAL DAY TO SECOND -> String |
478622
| Support convertDecimalToInteger in copy source when `supportV1DataTypes` is set to `true`. | Support convertDecimalToInteger in copy source.  |
479-
623+
| Support TLS 1.3.| TLS 1.3 is not supported. |
480624

481625
## Related content
482626
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/media/connector-amazon-rds-for-oracle/azure-key-vault-server.png

6 KB
Loading

‎articles/data-factory/media/connector-amazon-rds-for-oracle/connector-descriptor-linked-service.png

10.6 KB
Loading

‎articles/data-factory/media/connector-amazon-rds-for-oracle/easy-connect-naming-linked-service.png

8.32 KB
Loading

‎articles/data-factory/media/connector-amazon-rds-for-oracle/version-1-linked-service.png

27.5 KB
Loading

0 commit comments

Comments
 (0)