ODBC Driver for Excel Services

Build 20.0.7587

Connection Properties

The connection 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 settings for this provider. Click the links for further details.

For more information on establishing a connection, see Getting Started.
Auth SchemeThe scheme used for authentication. Accepted entries are NTLM, Basic, Digest, Forms, None, and Negotiate.
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 .
Default DomainThis property is used for the Oracle Database Gateway for ODBC.
Define TablesDefine the tables within a spreadsheet on SharePoint Online.
Enable Foreign Key DetectionWhether to detect the foreign keys in ODBC.
FileThe name of the Excel file to which to connect.
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.
FolderThe folder containing the workbook specified by the File property.
HeaderIndicates whether the first row should be used as a column header when using the REST API.
Ignore Calc ErrorIndicates whether to ignore errors that occurred during the calculation.
Include Dual TableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
LibraryThe Document Library to which to connect.
Limit Key SizeThe maximum length of a primary key column.
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.
Map To IntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
Map To Long VarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
Map To WVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
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.
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.
PasswordThe password of the SharePoint Online account used to authenticate to the SharePoint Online server.
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.
Row Scan DepthThe maximum number of rows to scan to look for the columns available in a table.
RTKThe runtime key used for licensing.
Share Point EditionThe edition of SharePoint being used. Set either SharePoint Online or SharePoint On-Premise.
Share Point VersionThe version of the SharePoint server to which you are connecting.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
SSO DomainThe domain of the user when using single sign-on (SSO).
STSURLThe URL of the security token service (STS) when using Single Sign On (SSO).
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.
Type Detection SchemeDetermines how to determine the data type of columns.
Upper Case IdentifiersThis 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.
URLThe base URL for a site or site collection.
Use NTLMV1Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).
UserThe username of the SharePoint Online account used to authenticate to the server.
Use RESTAPIWhether or not the REST API is used for retrieving data.
Use SSOWhether or not to use Single Sign On (SSO) to authenticate to SharePoint Online.
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