FireDAC Components for Basecamp

Build 20.0.7587

Connection Parameters

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.
Account IdAccount Id of the currently authenticated user.
Auth SchemeThe type of authentication to use when connecting to Basecamp.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
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 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 ProviderThe name of the provider to be used to cache data.
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. This value must match the callback URL you specify in your app settings.
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.
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 filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Maximum Column SizeThe maximum column size.
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 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 Expires InThe lifetime in seconds of the OAuth AccessToken.
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 Token TimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.
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.
PasswordPassword of the currently authenticated user.
Project IdThe Project Id of the currently authenticated user.
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 destination hostnames 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 Basecamp from the provider.
RTKThe runtime key used for licensing.
SchemaSpecify the Basecamp version to connect with.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserUsername of the currently authenticated user.
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.

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