NOTE: All option names are case-insensitive.
| Option | Description | Type |
|---|---|---|
DSN |
Data Source Name used for configuring the connection. | string |
Host / Server |
Hostname or IP address for the target cluster. | string |
Port |
Port number on which the cluster's REST interface is listening. | string |
| Option | Description | Type | Acceptable Values | Default |
|---|---|---|---|---|
Auth |
Authentication mechanism to use. | string | BASIC (basic HTTP), AWS_SIGV4 (AWS auth), NONE |
NONE |
User / UID |
[Auth=BASIC] Username for the connection. |
string | ||
Password / PWD |
[Auth=BASIC] Password for the connection. |
string | ||
Region |
[Auth=AWS_SIGV4] Region used for signing requests |
string | AWS region (eg. us-west-1) |
|
TunnelHost |
[Auth=AWS_SIGV4] VPC endpoint hostname if connected through tunnel or proxy |
string |
NOTE: To use AWS_SIGV4 authentication you need to create ~/.aws/credentials and add opensearchodbc profile with aws access key id, secret key and session token (if used).
| Option | Description | Type | Acceptable Values | Default |
|---|---|---|---|---|
UseSSL |
Whether to establish the connection over SSL/TLS | boolean | 0 or 1 |
0 (false) |
HostnameVerification |
Indicate whether certificate hostname verification should be performed for an SSL/TLS connection. | boolean | 0 or 1 |
1 (true) |
ResponseTimeout |
The maximum time to wait for responses from the Host, in seconds. |
integer | 10 |
|
FetchSize |
The page size for all cursor requests. The default value (-1) uses server-defined page size. Set FetchSize to 0 for non-cursor behavior. | integer | -1, 0 or any positive value |
-1 |
| Option | Description | Type | Acceptable Values | Default |
|---|---|---|---|---|
LogLevel |
Severity level for driver logs. | integer | 0 -- OFF 1 -- FATAL 2 -- ERROR 3 -- WARNING 4 -- INFO 5 -- DEBUG 6 -- TRACE 7 -- ALL |
3 |
LogOutput |
Location for storing driver logs. | string | WIN: C:\ MAC: /Library/ODBC/opensearch-sql-odbc |
NOTE: Administrative privileges are required to change the value of logging options on Windows.