Merge branch 'main' of https://github.com/MicrosoftDocs/azure-docs-pr into devguide-sas

Author: pauljewellmsft

articles/data-factory/connector-vertica.md

@@ -6,7 +6,7 @@ author: jianleishen
 ms.subservice: data-movement
 ms.custom: synapse
 ms.topic: conceptual
-ms.date: 10/20/2023
+ms.date: 08/12/2024
 ms.author: jianleishen
 ---
 # Copy data from Vertica using Azure Data Factory or Synapse Analytics
@@ -20,18 +20,49 @@ This Vertica connector is supported for the following capabilities:
 
 | Supported capabilities|IR |
 |---------| --------|
-|[Copy activity](copy-activity-overview.md) (source/-)|① ②|
-|[Lookup activity](control-flow-lookup-activity.md)|① ②|
+|[Copy activity](copy-activity-overview.md) (source/-)|① (only for version 1.0) ②|
+|[Lookup activity](control-flow-lookup-activity.md)|① (only for version 1.0) ②|
 
 *① Azure integration runtime ② Self-hosted integration runtime*
 
 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.
 
 The service provides a built-in driver to enable connectivity, therefore you don't need to manually install any driver using this connector.
 
+For version 2.0 (Preview), you need to [install a Vertica ODBC driver](#install-vertica-odbc-driver-for-the-version-20-preview) 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. 
+
 ## Prerequisites
 
-[!INCLUDE [data-factory-v2-integration-runtime-requirements](includes/data-factory-v2-integration-runtime-requirements.md)]
+If your data store is located inside an on-premises network, an Azure virtual network, or Amazon Virtual Private Cloud, you need to configure a [self-hosted integration runtime](create-self-hosted-integration-runtime.md) to connect to it. If you use the version 2.0 (Preview), your self-hosted integration runtime version should be 5.44.8984.1 or above.
+
+For more information about the network security mechanisms and options supported by Data Factory, see [Data access strategies](data-access-strategies.md).
+
+### For version 1.0
+
+If your data store is a managed cloud data service, you can use the Azure Integration Runtime. If the access is restricted to IPs that are approved in the firewall rules, you can add [Azure Integration Runtime IPs](azure-integration-runtime-ip-addresses.md) to the allowlist.
+
+ You can also use the [managed virtual network integration runtime](tutorial-managed-virtual-network-on-premise-sql-server.md) feature in Azure Data Factory to access the on-premises network without installing and configuring a self-hosted integration runtime.
+
+
+### Install Vertica ODBC driver for the version 2.0 (Preview)
+
+To use Vertica connector with version 2.0 (Preview), install the Vertica ODBC driver on the machine running the self-hosted Integration runtime by following these steps:
+
+1. Download the Vertica client setup for ODBC driver from [Client Drivers | OpenText™ Vertica™](https://www.vertica.com/download/vertica/client-drivers/). Take Windows system setup as an example:
+
+   :::image type="content" source="media/connector-vertica/download.png" alt-text="Screenshot of a Windows system setup example.":::  
+
+1. Open the downloaded .exe to begin the installation process. 
+
+   :::image type="content" source="media/connector-vertica/install.png" alt-text="Screenshot of the installation process.":::
+
+1. Select **ODBC driver** under Vertica Component List, then select **Next** to start the installation.
+
+   :::image type="content" source="media/connector-vertica/select-odbc-driver.png" alt-text="Screenshot of selecting ODBC driver.":::
+
+1. After the installation process is successfully completed, you can go to  Start -> ODBC Data Source Administrator to confirm the successful installation.
+
+   :::image type="content" source="media/connector-vertica/confirm-the successful-installation.png" alt-text="Screenshot of confirming the successful installation.":::
 
 ## Getting started
 
@@ -66,13 +97,18 @@ The following sections provide details about properties that are used to define
 
 ## Linked service properties
 
-The following properties are supported for Vertica linked service:
+If you use version 2.0 (Preview), the following properties are supported for Vertica linked service:
 
 | Property | Description | Required |
 |:--- |:--- |:--- |
 | type | The type property must be set to: **Vertica** | Yes |
-| connectionString | An ODBC connection string to connect to Vertica.<br/>You can also put password in Azure Key Vault and pull the `pwd` 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 |
-| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to be used to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. If not specified, it uses the default Azure Integration Runtime. |No |
+| server | The name or the IP address of the server to which you want to connect. | Yes |
+| port | The port number of the server listener. | No, default is 5433 |
+| database | Name of the Vertica database. | Yes |
+| uid | The user ID that is used to connect to the database.  | Yes |
+| pwd | The password that the application uses to connect to the database. | Yes |
+| version | The version when you select version 2.0 (Preview). The value is `2.0`. | Yes |
+| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to be used to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. You can only use the self-hosted integration runtime and its version should be 5.44.8984.1 or above. |No |
 
 **Example:**
 
@@ -81,8 +117,16 @@ The following properties are supported for Vertica linked service:
     "name": "VerticaLinkedService",
     "properties": {
         "type": "Vertica",
+        "version": "2.0",
         "typeProperties": {
-            "connectionString": "Server=<server>;Port=<port>;Database=<database>;UID=<user name>;PWD=<password>"
+            "server": "<server>",
+            "port": 5433,
+            "uid": "<username>",
+            "database": "<database>",
+            "pwd": {
+                "type": "SecureString",
+                "value": "<password>"
+             }
         },
         "connectVia": {
             "referenceName": "<name of Integration Runtime>",
@@ -99,15 +143,19 @@ The following properties are supported for Vertica linked service:
     "name": "VerticaLinkedService",
     "properties": {
         "type": "Vertica",
+        "version": "2.0",
         "typeProperties": {
-            "connectionString": "Server=<server>;Port=<port>;Database=<database>;UID=<user name>;",
-            "pwd": { 
-                "type": "AzureKeyVaultSecret", 
-                "store": { 
-                    "referenceName": "<Azure Key Vault linked service name>", 
-                    "type": "LinkedServiceReference" 
-                }, 
-                "secretName": "<secretName>" 
+            "server": "<server>",
+            "port": 5433,
+            "uid": "<username>",
+            "database": "<database>",
+            "pwd": { 
+                "type": "AzureKeyVaultSecret", 
+                "store": { 
+                    "referenceName": "<Azure Key Vault linked service name>", 
+                    "type": "LinkedServiceReference" 
+                }, 
+                "secretName": "<secretName>" 
             }
         },
         "connectVia": {
@@ -118,6 +166,32 @@ The following properties are supported for Vertica linked service:
 }
 ```
 
+If you use version 1.0, the following properties are supported:
+
+| Property | Description | Required |
+|:--- |:--- |:--- |
+| type | The type property must be set to: **Vertica** | Yes |
+| connectionString | An ODBC connection string to connect to Vertica.<br/>You can also put password in Azure Key Vault and pull the `pwd` 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 |
+| connectVia | The [Integration Runtime](concepts-integration-runtime.md) to be used to connect to the data store. Learn more from [Prerequisites](#prerequisites) section. If not specified, it uses the default Azure Integration Runtime. |No |
+
+**Example:**
+
+```json
+{
+    "name": "VerticaLinkedService",
+    "properties": {
+        "type": "Vertica",
+        "typeProperties": {
+            "connectionString": "Server=<server>;Port=<port>;Database=<database>;UID=<user name>;PWD=<password>"
+        },
+        "connectVia": {
+            "referenceName": "<name of Integration Runtime>",
+            "type": "IntegrationRuntimeReference"
+        }
+    }
+}
+```
+
 ## Dataset properties
 
 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 Vertica dataset.
@@ -129,7 +203,6 @@ To copy data from Vertica, set the type property of the dataset to **VerticaTabl
 | type | The type property of the dataset must be set to: **VerticaTable** | Yes |
 | schema | Name of the schema. |No (if "query" in activity source is specified)  |
 | table | Name of the table. |No (if "query" in activity source is specified)  |
-| tableName | Name of the table with schema. This property is supported for backward compatibility. Use `schema` and `table` for new workload. | No (if "query" in activity source is specified) |
 
 **Example**
 
@@ -159,7 +232,7 @@ To copy data from Vertica, set the source type in the copy activity to **Vertica
 | Property | Description | Required |
 |:--- |:--- |:--- |
 | type | The type property of the copy activity source must be set to: **VerticaSource** | Yes |
-| query | Use the custom SQL query to read data. For example: `"SELECT * FROM MyTable"`. | No (if "tableName" in dataset is specified) |
+| query | Use the custom SQL query to read data. For example: `"SELECT * FROM MyTable"`. | No (if "schema+table" in dataset is specified) |
 
 **Example:**
 
@@ -197,5 +270,13 @@ To copy data from Vertica, set the source type in the copy activity to **Vertica
 
 To learn details about the properties, check [Lookup activity](control-flow-lookup-activity.md).
 
+## Upgrade the Vertica version 
+
+Here are steps that help you upgrade your Vertica version: 
+
+1. Install a Vertica ODBC driver by following the steps in [Prerequisites](#install-vertica-odbc-driver-for-the-version-20-preview). 
+1. In **Edit linked service page**, select **2.0 (Preview)** under **Version** and configure the linked service by referring to [Linked service properties](#linked-service-properties). 
+1. Apply a self-hosted integration runtime with version 5.44.8984.1 or above. Azure integration runtime is not supported by version 2.0 (Preview). 
+
 ## Related content
 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).