Configuring an ADF Linked Service Connection for Vertica
For information on how to enable a connection for use with linked services, see Configuring a Linked Service Connection.
After selecting Vertica from the Linked Service Type dropdown, the form required for creating a Vertica Linked Service will appear.
The Vertica option is offered on connections that use the Vertica System Type.
BimlFlex authors the Vertica linked service at connector version 2.0.
Source Only Connector
A Vertica connection is used as a source. It is not available as a target.
A Vertica connection drives a Copy dataset from metadata, with the Schema and Table of the source object.
The dataset element is Vertica and the copy source is VerticaSource.
The copy source carries the query that BimlFlex composes from the columns and the source filters of the source object, with identifiers quoted in double quotes (").
Required Fields
The required fields are:
- Connect via Integration Runtime
- Server
- Database Name
- User Name
- Password, on the Azure Key Vault tab
Optional fields are:
Connect via Integration Runtime
Connect via Integration Runtime names the integration runtime for a Vertica Linked Service connection.
The default value is AutoResolveIntegrationRuntime.
To use another runtime, select it from the dropdown or choose + New to add one.
The custom values that appear in this dropdown can be maintained in Settings under Azure, in the AzureIntegrationRuntime setting.
Azure Data Factory connects to Vertica at version 2.0 through a self-hosted integration runtime only, at runtime version 5.44.8984.1 or higher.
Install the Vertica ODBC driver on the machine that runs the self-hosted integration runtime.
BimlFlex writes the selected runtime to the linked service when it is not AutoResolveIntegrationRuntime.
Server
The Server is the name or IP address of the Vertica server.
Server is required.
The form saves it in the LS_Server column, and BimlFlex writes it to the linked service as the server property.
Port
The Port is the port number of the Vertica server listener.
Port is optional, and the form shows 5433 as a placeholder.
The form saves it in the LS_Port column, and BimlFlex writes it to the linked service as the port property.
When Port is empty, BimlFlex writes no port property and the Azure Data Factory default of 5433 applies.
Database Name
The Database Name is the name of the Vertica database.
Database Name is required.
The form saves it in the LS_Db column, and BimlFlex writes it to the linked service as the database property.
User Name
The User Name is the user ID that connects to the Vertica database.
The form does not mark User Name as required, but the Vertica linked service requires it.
The form saves it in the LS_Username column, and BimlFlex writes it to the linked service as the uid property.
Password
The Password field has a Password tab for the password as text, and an Azure Key Vault tab beside it for a reference that resolves to the password at runtime.
The form saves the tab that is selected: a password entered as text in the LS_Password column, or the Azure Key Vault reference in the LS_PasswordKVS columns.
The Vertica linked service takes its password from Azure Key Vault alone.
The Azure Key Vault reference is named by the AKV Linked Service, the Secret Name and an optional Secret Version.
BimlFlex writes it as the pwd secret of the linked service when both the AKV Linked Service and the Secret Name are filled.
A password entered as text on the Password tab is not written to the linked service. The build reports a warning that names the connection:
Connection '<connection name>': the password column is not written to the Vertica linked service, which takes its password from Key Vault alone. Name the secret in the PasswordKVS columns.
Use Azure Key Vault for the Vertica password, on the Azure Key Vault tab of the Password field.
Azure Data Factory Linked Services Additional Information
For additional information on ADF Linked Service types and their connection requirements see the Azure Data Factory Vertica Connector documentation.