ADO.NET Provider for Elasticsearch

Build 24.0.9175

Miscellaneous

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


PropertyDescription
BatchSizeSpecifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request.
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. Set to 0 or leave empty for no time limit.
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 rows returned for queries without aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
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.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling.
PoolMinSizeSpecifies the minimum number of connections maintained in the connection pool. The default value is 1.
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. The default is 60 seconds.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryPassthroughThis option allows you to pass exact queries to Elasticsearch.
ReadonlyToggles read-only access to Elasticsearch from the provider.
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. Use this property only 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. The default is 60 seconds. Set to 0 to disable the timeout.
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 defining custom views. The provider automatically detects and uses the views specified in this file.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175