Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration


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

Integration and Formatting


SupportAccessLinkedMode	In 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.
DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

OAuth Properties


InitiateOAuth	Set 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 will be handled entirely by the user. An OAuthAccessToken will be required to authenticate. GETANDREFRESH: Indicates that the entire OAuth flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthSettingsLocation	The 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 will automatically obtain a new access token if InitiateOAuth is set. If InitiateOAuth is enabled but OAuthSettingsLocation is not defined, the driver uses a default settings file, %AppData%\CData\Xero Data Provider\OAuthSettings.txt on Windows. On macOS, this file is located in ~/Library/Application Support/CData/Xero 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.
OAuthRefreshToken	The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.