JDBC Driver for Elasticsearch

Build 25.0.9539

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
AWSCertificateThe absolute path to the certificate file or the certificate content in PEM format encoded in base64.
AWSCertificatePasswordThe password for the certificate if applicable, otherwise leave blank.
AWSCertificateTypeThe type of AWSCertificate .
AWSPrivateKeyThe absolute path to the private key file or the private key content in PEM format encoded in base64.
AWSPrivateKeyPasswordThe password for the private key if it is encrypted, otherwise leave blank.
AWSPrivateKeyTypeThe type of AWSPrivateKey .
AWSProfileARNProfile to pull policies from.
AWSSessionDurationDuration, in seconds, for the resulting session.
AWSTrustAnchorARNTrust anchor to use for authentication.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ClientSideEvaluationSet ClientSideEvaluation to true to perform Evaluation client side on nested objects.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
ConnectOnOpenSpecifies whether the provider establishes a connection to Elasticsearch immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
MaxResultsThe maximum number of total results to return from Elasticsearch when using the default Search API.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
PageSizeThe number of results to return per request from Elasticsearch.
PaginationModeSpecifies whether to use PIT with search_after or scrolls to page through query results.
PITDurationSpecifies the time unit to use for keep alive when retrieving results via PIT API.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool.
PoolMinSizeSpecifies the minimum number of connections to be maintained in the connection pool at all times.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryPassthroughThis option allows you to pass exact queries to Elasticsearch.
ReadonlyToggles read-only access to Elasticsearch from the provider.
ReplaceInvalidUTF8CharsSpecifies whether to replace invalid UTF8 byte sequences found in reads of indexed document content with the U+FFFD replacement character.
RowScanDepthThe maximum number of rows to scan when generating table metadata. Set this property to gain more control over how the provider detects arrays.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
ScrollDurationSpecifies the time unit to use for keep alive when retrieving results via the Scroll API.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UseFullyQualifiedNestedTableNameSet this to true to set the generated table name as the complete source path when flattening nested documents using Relational DataModel .
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539