ODBC Driver for Avro

Build 25.0.9434

Other

Specifies 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.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Caching Configuration

PropertyDescription
CachePartial=TrueCaches only a subset of columns, which you can specify in your query.
QueryPassthrough=TruePasses the specified query to the cache database instead of using the SQL parser of the driver.

Integration and Formatting

PropertyDescription
SupportAccessLinkedModeIn Access' linked mode, it is generally a good idea to always use a cache as most data sources do not support multiple Id queries. However, if you want to use the driver in Access but not in linked mode, this property must be set to False to avoid using a cache of a SELECT * query for the given table.
DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT=TrueConverts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

OAuth Properties

InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect. The following options are available:
  • OFF: Indicates that the OAuth flow is handled entirely by the user. An OAuthAccessToken is required to authenticate.
  • GETANDREFRESH: Indicates that the entire OAuth flow is handled by the driver. If no token currently exists, it is obtained by prompting the user via the browser. If a token exists, it is refreshed when applicable.
  • REFRESH: Indicates that the driver only handles refreshing the OAuthAccessToken. The user is never prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthSettingsLocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to true. When InitiateOAuth is enabled, the driver saves OAuth values to a settings file to avoid requiring the user to manually enter OAuth connection properties. When the user's OAuth session expires, the driver automatically obtains a new access token if InitiateOAuth is enabled.

If InitiateOAuth is enabled but OAuthSettingsLocation is not defined, the driver uses a default settings file, %AppData%\CData\Avro Data Provider\OAuthSettings.txt on Windows. On macOS, this file is located in ~/Library/Application Support/CData/Avro Data Provider/OAuthSettings.txt. On Linux, ~/cdata/.config.

OAuthAccessToken The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthAccessTokenSecretThe OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.
OAuthRefreshTokenThe OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

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