ODBC Driver for OData

Build 25.0.9434

Miscellaneous

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


PropertyDescription
AllowNavigationDisassociationSpecifies whether the provider binds navigation properties to null values.
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 .
ConnectOnOpenSpecifies whether the provider establishes a connection to OData immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
ContinueOnErrorSpecifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.).
CookiesThis property can be manually specified in the format of name=value pairs, which are separated by semicolons.
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.
DataFormatSpecifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON.
DecodeXMLNamesSpecifies whether to decode column names containing Unicode characters.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableAtomicBatchOperationsThis property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
ExcludeControlInformationRootTypeIndicates whether OData should use the odata.type control information for the root element.
ExpandAsteriskThe OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
IncludeNavigationParentColumnsSpecifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views.
IncludeReferenceColumnAdds an input-only ParentReference column designed for bulk INSERT operations, ensuring that child records are correctly linked to their respective parents during a deep INSERT process.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaxFilterLengthSpecifies the maximum number of characters permitted in the $filter query parameter of a OData request.
MaximumColumnSizeThe maximum column size.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxSelectLengthThis property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it.
NavigationPropertiesAsViewsA boolean indicating navigation properties should be promoted to full views.
ODataVersionThe version of OData that should be utilized. By default, the provider is designed to automatically detect and adapt to the appropriate version, ensuring seamless integration and functionality.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from OData.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
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. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
ServerTimeZoneThe timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client.
StoredProceduresAsViewsA boolean value indicating whether stored procedures returning collections of entities should be treated as views.
SupportsExpandDetermines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties.
SupportsFilterSpecifies whether the OData service supports the $filter query parameter.
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.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UseClientSidePagingSpecifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False.
UseEtagsThe purpose of this property is to optionally hide the Etag column if the service does not return a value for it. Otherwise, it will be included but remain empty.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseSimpleNamesSpecifies whether or not simple names should be used for tables and columns.

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