You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: integ-test/src/test/java/com/amazon/opendistroforelasticsearch/sql/correctness/tests/ESConnectionTest.java
@@ -58,11 +58,11 @@ To setup a connection, the driver requires a JDBC connection URL. The connection
58
58
| ------------- |-------------| -----|---------|
59
59
| user | Connection username. mandatory if `auth` property selects a authentication scheme that mandates a username value | any string |`null`|
60
60
| password | Connection password. mandatory if `auth` property selects a authentication scheme that mandates a password value | any string |`null`|
61
-
| fetchSize | Cursor page size | positive integer value. Max value is limited by `index.max_result_window`Elasticsearch setting |`0` (for non-paginated response) |
61
+
| fetchSize | Cursor page size | positive integer value. Max value is limited by `index.max_result_window`OpenSearch setting |`0` (for non-paginated response) |
62
62
| logOutput | location where driver logs should be emitted | a valid file path |`null` (logs are disabled) |
63
63
| logLevel | severity level for which driver logs should be emitted | in order from highest(least logging) to lowest(most logging): OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL | OFF (logs are disabled) |
64
64
| auth | authentication mechanism to use |`NONE` (no auth), `BASIC` (HTTP Basic), `AWS_SIGV4` (AWS SIGV4) |`basic` if username and/or password is specified, `NONE` otherwise |
65
-
| awsCredentialsProvider | The AWS credential provider to be used when authentication mechanism is `AWS_SIGV4` (AWS SIGV4). If not set, the driver will use DefaultAWSCredentialsProviderChain to sign the request. Note that the driver renamed the namespaces of its dependencies, so the value has to be an instance of com.amazonaws.opendistro.elasticsearch.sql.jdbc.shadow.com.amazonaws.auth.AWSCredentialsProvider| Instance of an AWSCredentialProvider | DefaultAWSCredentialsProviderChain |
65
+
| awsCredentialsProvider | The AWS credential provider to be used when authentication mechanism is `AWS_SIGV4` (AWS SIGV4). If not set, the driver will use DefaultAWSCredentialsProviderChain to sign the request. Note that the driver renamed the namespaces of its dependencies, so the value has to be an instance of com.amazonaws.opendistro.opensearch.sql.jdbc.shadow.com.amazonaws.auth.AWSCredentialsProvider| Instance of an AWSCredentialProvider | DefaultAWSCredentialsProviderChain |
66
66
| region | if authentication type is `aws_sigv4`, then this is the region value to use when signing requests. Only needed if the driver can not determine the region for the host endpoint. The driver will detect the region if the host endpoint matches a known url pattern. | a valid AWS region value e.g. us-east-1 |`null` (auto-detected if possible from the host endpoint) |
67
67
| requestCompression | whether to indicate acceptance of compressed (gzip) responses when making server requests |`true` or `false`|`false`|
68
68
| useSSL | whether to establish the connection over SSL/TLS |`true` or `false`|`false` if scheme is `http`, `true` if scheme is `https`|
The driver also provides a javax.sql.DataSource implementation via the `com.amazon.opendistroforelasticsearch.jdbc.ElasticsearchDataSource` class that can be used to obtain a connection. Here are some typical code samples:
324
+
The driver also provides a javax.sql.DataSource implementation via the `com.amazon.opendistroforelasticsearch.jdbc.OpenSearchDataSource` class that can be used to obtain a connection. Here are some typical code samples:
325
325
326
326
327
327
* Connect to localhost on port 9200 with no authentication over a plain connection
@@ -39,7 +39,7 @@ TDC file is required to add customization for the data connection. For reference
39
39
</connection-customization>
40
40
```
41
41
* Using a text editor, add `<connection-customization>` section.
42
-
* Name the file `elasticsearch.tdc` and save it to `My Tableau Repository\Datasources`.
42
+
* Name the file `opensearch.tdc` and save it to `My Tableau Repository\Datasources`.
43
43
* Restart Tableau to apply the change.
44
44
45
45
For futher details check [using a .tdc file with Tableau](https://kb.tableau.com/articles/howto/using-a-tdc-file-with-tableau-server)
@@ -49,11 +49,11 @@ For futher details check [using a .tdc file with Tableau](https://kb.tableau.com
49
49
You will need:
50
50
*[JDBC connection string](https://github.com/opendistro-for-elasticsearch/sql/blob/master/sql-jdbc/README.md#connection-url-and-other-settings) to enter in the URL field when you connect.
51
51
52
-
Sample connection string for connecting to localhost: `jdbc:elasticsearch://localhost:9200`.
52
+
Sample connection string for connecting to localhost: `jdbc:opensearch://localhost:9200`.
53
53
54
54
* Credentials for signing in to the server (user name and password).
55
55
* (Optional) JDBC properties file to customize the driver behavior. For more details check [Customize JDBC Connections Using a Properties File](https://community.tableau.com/docs/DOC-17978)
56
-
* Create a properties file called `elasticsearch.properties`.
56
+
* Create a properties file called `opensearch.properties`.
57
57
* Save the file to the `My Tableau Repository\Datasources` directory.
0 commit comments