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.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The scheme used for authentication. Accepted entries are None, Basic, Negotiate (Kerberos), AwsRootKeys, AwsIAMRoles, AwsEC2Roles, APIKey, and TemporaryCredentials. None is the default. |
| User | The user who is authenticating to Elasticsearch. |
| Password | The password used to authenticate to Elasticsearch. |
| UseSSL | This property sets whether the provider attempts to negotiate TLS/SSL connections to the server. |
| Server | The host name or IP address of the Elasticsearch REST server. Alternatively, multiple nodes in a single cluster can be specified, though all such nodes must be able to support REST API calls. |
| Port | The port for the Elasticsearch REST server. |
| APIKey | The APIKey used to authenticate to Elasticsearch. |
| APIKeyId | The APIKey Id to authenticate to Elasticsearch. |
| Property | Description |
| DataModel | Specifies the data model to use when parsing Elasticsearch documents and generating the database metadata. |
| ExposeDotIndices | If false, indices whose name starts with a '.' (dot indices) will not be exposed as tables or views by the provider. If true, dot indices will be exposed as tables or views. |
| AliasesFilter | Comma-separated list of alias names or filters used to filter the aliases exposed as views. |
| IndicesAndDataStreamsFilter | Comma-separated list of index and data stream names or filters. |
| UseLakeFormation | When this property is set to true, AWSLakeFormation service will be used to retrieve temporary credentials, which enforce access policies against the user based on the configured IAM role. The service can be used when authenticating through OKTA, ADFS, AzureAD, PingFederate, while providing a SAML assertion. |
| Property | Description |
| AWSAccessKey | Your AWS account access key. This value is accessible from your AWS security credentials page. |
| AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
| AWSRoleARN | The Amazon Resource Name of the role to use when authenticating. |
| AWSRegion | The hosting region for your Amazon Web Services. |
| AWSSessionToken | Your AWS session token. |
| TemporaryTokenDuration | The amount of time (in seconds) an AWS temporary token will last. |
| AWSExternalId | A unique identifier that might be required when you assume a role in another account. |
| AWSWebIdentityToken | The OAuth 2.0 access token or OpenID Connect ID token that is provided by an identity provider. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosUser | The principal name for the Kerberos Domain Controller. Used in the format host/user@realm. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| FlattenArrays | 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. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheDriver | The database driver used to cache data. |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| BatchSize | The maximum size of each batch operation to submit. |
| ClientSideEvaluation | Set ClientSideEvaluation to true to perform Evaluation client side on nested objects. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectOnOpen | This property specifies whether to connect to the Elasticsearch when the connection is opened. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| MaxResults | The maximum number of total results to return from Elasticsearch when using the default Search API. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PageSize | The number of results to return per request from Elasticsearch. |
| PaginationMode | Specifies whether to use PIT with search_after or scrolls to page through query results. |
| PITDuration | Specifies the time unit to use for keep alive when retrieving results via PIT API. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| PseudoColumns | Specify a set of pseudocolumns to expose as columns. |
| QueryPassthrough | 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. |
| RowScanDepth | The maximum number of rows to scan when generating table metadata. Set this property to gain more control over how the provider detects arrays. |
| RTK | The runtime key used for licensing. |
| ScrollDuration | Specifies the time unit to use for keep alive when retrieving results via the Scroll API. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseConnectionPooling | This property enables connection pooling. |
| UseFullyQualifiedNestedTableName | Set this to true to set the generated table name as the complete source path when flattening nested documents using Relational DataModel . |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |