CData JDBC Driver for Xero 2019 - Online Help
Questions / Feedback?

Connection String Options

CData JDBC Driver for Xero 2019 - Build 19.0.7354

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Auto Expand DetailsSet this property to true automatically include extra details on BankTransfers, ContactGroups, ExpenseClaims, ExpenseClaimPayments, ExpenseClaimReceipts and Receipts.
Batch SizeThe maximum size of each batch operation to submit.
Cache ConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Cache DriverThe database driver to be used to cache data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Callback URLThe OAuth callback URL to return to when authenticating a partner app or a custom public app. This URL must have the same domain as the Callback Domain in your app settings.
Certificate StoreThe certificate store used with Xero Private Application authentication.
Certificate Store PasswordThe password of the certificate store used with Xero Private Application authentication.
Certificate Store TypeThe type of certificate store used with Xero Private Application authentication.
Certificate SubjectThe subject of the certificate used with Xero Private Application authentication.
Connection Life TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On OpenThis property species whether to connect to the Xero when the connection is opened.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Include ArchivedSet this property to include archived records.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA path to the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Access Token SecretThe OAuth access token secret for connecting using OAuth.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Settings LocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to Xero from the provider.
Retry Wait TimeHow long to wait when a request hits the Xero API limit, in milliseconds.
RTKThe runtime key used for licensing.
SchemaThe Xero API you want to access as a database schema.
ScopeThis determines the scopes that the OAuth application requests from Xero. Only applies when XeroAppAuthentication is set to OAUTH2.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLIf the property is set to true, handle SQL queries using a temporary database.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TenantSets the Xero organization to connect to. Can be a name or tenant ID.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Use Connection PoolingThis property enables connection pooling.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Xero App AuthenticationThe application authentication type you wish to use to connect to Xero.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0