JDBC Driver for OData

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.
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.
ConnectOnOpenSpecifies whether the provider establishes a connection to OData immediately upon opening the connection. The default value is false. Enable this property only if immediate connectivity verification is necessary.
ContinueOnErrorSpecifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
CookiesAllows cookies to be manually specified in name=value pairs separated by a semicolon.
CustomHeadersSpecifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs.
CustomUrlParamsA string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3.
DataFormatThe data format to retrieve data in. Select either ATOM or JSON.
DecodeXMLNamesSpecifies whether to decode column names containing Unicode characters.
EnableAtomicBatchOperationsSpecifies whether or not batch Create, Update, and Delete (CUD) operations execute independently (if one request fails, the others in the batch continue to execute) or atomically (if one request fails, the whole batch operation fails).
ExcludeControlInformationRootTypeIndicates wheather or not the OData should use the odata.type control information for the root element.
ExpandAsteriskIndicates whether the asterisk should be expanded in the $select query parameter.
IncludeNavigationParentColumnsIndicates if navigation parent columns should be included on navigation views.
IncludeReferenceColumnAdds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent.
MaxFilterLengthThe maximum number of characters for the $filter query parameter.
MaxRowsSpecifies the maximum rows returned for queries without aggregation or GROUP BY.
MaxSelectLengthThe $Select query parameter has a maximum character limit. Setting this property to 0 prevents the driver from submitting the $Select parameter to the service, which is helpful for services that do not support it.
NavigationPropertiesAsViewsA boolean indicating navigation properties should be promoted to full views.
ODataVersionThe version of OData to use. By default the provider will attempt to autodetect the version.
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.
PagesizeSpecifies the maximum number of results to return from OData, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
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.
ReadonlyToggles read-only access to OData from the provider.
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.
ServerTimeZoneThe timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine.
StoredProceduresAsViewsA boolean indicating if we should list stored procedures which return a collection of entities as views.
SupportsExpandWhether you need to specify the base entity's key to query navigation property views.
SupportsFilterSet this to true if your OData service supports filters.
SupportsFormulasA boolean indicating if the odata service supports server side formulas.
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.
UseClientSidePagingSpecifies whether or not OData should return data using client-side paging, if your source supports it. If set to false, OData uses server-side paging.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UseEtagsWhether or not the OData source uses Etags.
UseIdURLBoolean determining if the Id column representing the direct URL to a given entity will be displayed.
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNamesBoolean determining if simple names should be used for tables and columns.

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