This is the multi-page printable view of this section. Click here to print.
The Vertica OLE DB driver for Windows is installed as part of the Client Drivers and Tools for Windows. See the Client Drivers downloads page.
The values for the OLE DB driver's settings are stored in the Windows registry under the path HKEY_LOCAL_MACHINE\SOFTWARE\Vertica\OLEDB\Driver.
For information on how the OLE DB driver integrates with Microsoft components previously installed on your system, see Microsoft component configuration.
Use the Connection Manager to set the OLE DB connection string properties, which define your connection. You access the Connection Manager from within Visual Studio.
These connection parameters appear on the Connection page.
| Parameters | Action |
|---|---|
| Provider | Select the native OLE DB provider for the connection. |
| OLE DB Provider | Indicates Vertica OLE DB Provider. |
| Server or file name | Enter the server or file name. |
| Location | Not supported. |
| Use Windows NT Integrated Security | Not supported. |
| Use a specific user name and password |
Enter a user name and password. Connect with No Password: Select the Blank password check box. Save and Encrypt Password: Select Allow saving password. |
| Initial Catalog | The name of the database running on the server. |
The All page from the Connection Manager dialog box includes all possible connection string properties for the provider.
The table that follows lists the connection parameters for the All page.
For OLE DB properties information specific to Microsoft, see the Microsoft documentation OLE DB Properties.
| Parameters | Action |
|---|---|
| Extended Properties | Not supported. |
| Locale Identifier |
Indicates the Locale ID. Default: 0 |
| Mode |
Specifies access permissions. Default: 0 |
| Connect Timeout |
Not supported. Default: 0 |
| General Timeout | Not supported. |
| File Name | Not supported. |
| OLE DB Services | Specifies which OLE DB services to enable or disable. |
| Password |
Specifies the password for the user ID. For no password, insert an empty string. |
| Persist Security Info |
A security measure. When False, security sensitive-information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state. Default: true |
| User ID | The database username. |
| Data Source |
The host name or IP address of any active node in a Vertica cluster. You can provide an IPv4 address, IPv6 address, or host name. In mixed IPv4/IPv6 networks, the DNS server configuration determines which IP version address is sent first. Use the |
| Initial Catalog | The name of the database running on the server. |
| Provider |
The name of the OLE DB Provider to use when connecting to the Data Source. Default: VerticaOLEDB.1 |
| BackupServerNode |
A designated host name or IP address to use if the ServerName host is unavailable. Enter as a string. Connection attempts continue until successful or until the list of server nodes is exhausted. Valid values: Comma-separated list of servers optionally followed by a colon and port number. For example:
|
| ConnectionLoadBalance |
A Boolean value that determines whether the connection can be redirected to a host in the database other than the ServerNode. This parameter affects the connection only if load balancing is set to a value other than NONE. When the node differs from the node that the client is connected to, the client disconnects and reconnects to the targeted node. See About Native Connection Load Balancing in the Administration Guide. Default: false |
| ConnSettings |
SQL commands that the driver should execute immediately after connecting to the server. Use to configure the connection, such as setting a schema search path. Reserved symbol:';' To set multiple parameters in this field use '%3B' for ','. Spaces: Use '+'. |
| ConvertSquareBracketIdentifiers |
Controls whether square-bracket query identifiers are converted to a double quote identifier for compatibility when making queries to a Vertica database. Default: false |
| DirectBatchInsert | Deprecated, always set to true. |
| KerberosHostName |
Provides the instance or host name portion of the Vertica Kerberos principal; for example: vertica/host@EXAMPLE.COM |
| KerberosServiceName |
Provides the service name portion of the Vertica Kerberos principal; for example: vertica/host@EXAMPLE.COM |
| Label | Sets a label for the connection on the server. This value appears in the session_id column of system table SESSIONS . |
| LogLevel | Specifies the amount of information included in the log. Leave this field blank or set to 0 unless otherwise instructed by Vertica Customer Support. |
| LogPath | The path for the log file. |
| Port |
The port number on which Vertica listens for OLE DB connections. Default: port 5433 |
| PreferredAddressFamily |
The IP version to use if the client and server have both IPv4 and IPv6 addresses and you have provided a host name, one of the following:
|
| SSLCertFile | The absolute path of the client's public certificate file. This file can reside anywhere on the system. |
| SSLKeyFile | The absolute path to the client's private key file. This file can reside anywhere on the system. |
| SSLMode |
Controls whether the connection to the database uses SSL encryption, one of the following:
Default: |
On Windows clients, you can direct Vertica to send OLE DB log entries to Event Tracing for Windows (ETW). Once set, OLE DB log entries appear in the Windows Event Viewer. To use ETW:
Register the driver as a Windows Event Log provider, and enable the logs.
Activate ETW by adding a string value to your Windows Registry.
Understand how Vertica compresses log levels for the Windows Event Viewer.
Know where to find the logs within Event Viewer.
Understand the meaning of the Event IDs in your log entries.
To use ETW logging, you must register the OLE DB driver as a Windows Event Log provider. You can choose to register either the 32-bit or 64-bit driver. Once you have registered the driver, you must enable the logs.
Open a command prompt window as Administrator, or launch the command prompt with the Run as Administrator option.
Run the command wevtutil im to register either the 32-bit or 64-bit version of the driver.
For the 64-bit OLE DB driver, run:
wevtutil im "c:\Program Files\Vertica Systems\OLEDB64\lib\VerticaOLEDB64.man"
/resourceFilePath:"c:\Program Files\Vertica Systems\OLEDB64\lib\vertica_8.1_oledb.dll"
/messageFilePath:"c:\Program Files\Vertica Systems\OLEDB64\lib\vertica_8.1_oledb.dll"
For the 32-bit OLE DB driver, run:
wevtutil im "c:\Program Files (x86)\Vertica Systems\OLEDB32\lib\VerticaOLEDB32.man"
/resourceFilePath:"c:\Program Files (x86)\Vertica Systems\OLEDB32\lib\vertica_8.1_oledb.dll"
/messageFilePath:"c:\Program Files (x86)\Vertica Systems\OLEDB32\lib\vertica_8.1_oledb.dll"
Run the command wevtutil sl to enable the logs.
For 64-bit OLE DB driver logs, run:
wevtutil sl VerticaOLEDB64/e:true
For the 32-bit ODBC driver logs, run:
wevtutil sl VerticaOLEDB32/e:true
wevtutil sl command, substituting /e:false in place of /e:true when you issue the statement. Alternatively, you can enable or disable logs within the Windows Event Viewer itself.
By default, Vertica does not send OLE DB log entries to ETW. To activate ETW, add the string LogType to your Windows registry, and set its value to ETW.
Start the registry editor by typing regedit.exe in the Windows Run command box.
Navigate to the correct location in the registry.
HKEY_LOCAL_MACHINE\SOFTWARE\Vertica\OLEDB\Driver
Right-click in the right pane of the Registry Editor window. Select New and then select String Value.
Change the name of the string value from New Value #1 to LogType.
Double-click the new LogType entry. When prompted for a new value, enter ETW.
Exit the registry editor.
ETW is off by default. When ETW is activated, you can subsequently turn it off by clearing the value ETW from the LogType string.
The LogLevel parameter setting is described in the section, Additional parameter settings. The parameter allows you to specify a LogLevel of 0 through 6. Be aware that Vertica compresses the log levels for the Windows Event Viewer. The six levels are compressed to four in Event Viewer.
| Vertica LogLevel Setting | Vertica LogLevel Description | Entries are sent to Event Viewer as log level... | Event Viewer Displays... |
|---|---|---|---|
| 0 | (No logging) | 0 | (No logging) |
| 1 | Fatal Errors | 1 | Critical |
| 2 | Errors | 2 | Error |
| 3 | Warnings | 3 | Warning |
| 4 | Info | 4 | Information |
| 5 | Debug | 4 | |
| 6 | Trace (all messages) | 4 |
Examples:
A LogLevel setting of 5 sends fatal errors, errors, warnings, info and debug log level entries to Event Viewer as Level 4 (Information).
A LogLevel setting of 6 sends fatal errors, errors, warnings, debug and trace log level entries to Event Viewer as Level 4.
Launch the Windows Event Viewer.
From Event Viewer (Local), expand Applications and Services Logs.
Expand the folder that contains the log you want to review (for example, VerticaOLEDB64).
Select the Vertica OLE DB log under the folder. Entries appear in the right pane.
Once you have chosen an OLE DB log in Event Viewer, note the value in the Event ID field.
Each Event Log entry includes one of four Event IDs. An Event ID of 0 is informational (debug, info, and trace events), 1 is an error, 2 is a fatal event, and 3 is a warning.