Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
| Auth Scheme | The scheme used for authentication. Accepted entries are None, Basic, Negotiate (Kerberos), AwsRootKeys, and AwsIAMRoles. None is the default. |
| AWS Access Key | Your AWS account access key. This value is accessible from your AWS security credentials page. |
| AWS Region | The hosting region for your Amazon Web Services. |
| AWS Role ARN | The Amazon Resource Name of the role to use when authenticating. |
| AWS Secret Key | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| AWS Session Token | Your AWS session token. |
| Client Side Evaluation | Set ClientSideEvaluation to true to perform Evaluation client side on nested objects. |
| Data Model | Specifies the data model to use when parsing Elasticsearch documents and generating the database metadata. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Flatten Arrays | Set FlattenArrays to the number of nested array elements you want to return as table columns. By default, nested arrays are returned as strings of JSON. |
| Flatten Objects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| Generate Schema Files | Indicates the user preference as to when schemas should be generated and saved. |
| Kerberos KDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| Kerberos Keytab File | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| Kerberos Realm | The Kerberos Realm used to authenticate the user with. |
| Kerberos Service KDC | The Kerberos KDC of the service. |
| Kerberos Service Realm | The Kerberos realm of the service. |
| Kerberos SPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| Kerberos Ticket Cache | The full file path to an MIT Kerberos credential cache file. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Log Modules | Core modules to be included in the log file. |
| Max Results | The maximum number of total results to return from Elasticsearch when using the default Search API. |
| Max Rows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| Page Size | The number of results to return per request from Elasticsearch. |
| Password | The password used to authenticate to Elasticsearch. |
| Port | The port for the Elasticsearch REST server. |
| Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| Proxy Auto Detect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
| Proxy Port | The TCP port the ProxyServer proxy is running on. |
| Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
| Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
| Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
| Query Passthrough | This option allows you to pass exact queries to Elasticsearch. |
| Readonly | You can use this property to enforce read-only access to Elasticsearch from the provider. |
| Row Scan Depth | The maximum number of rows to scan when generating table metadata. Set this property to gain more control over how the provider detects arrays. |
| Scroll Duration | Specifies the time unit to use when retrieving results via the Scroll API. |
| Server | The host name or IP address of the Elasticsearch REST server. |
| SSL Client Cert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSL Client Cert Password | The password for the TLS/SSL client certificate. |
| SSL Client Cert Subject | The subject of the TLS/SSL client certificate. |
| SSL Client Cert Type | The type of key store containing the TLS/SSL client certificate. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Temporary Token Duration | The amount of time (in seconds) an AWS temporary token will last. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| User | The user who is authenticating to Elasticsearch. |