ODBC Driver for Microsoft Excel Online

Connection String Parameters - ODBC Driver for Microsoft Excel Online



ODBC Driver for Microsoft Excel Online ODBC Connection String Parameters

The following table lists the connection string parameters for ODBC Driver for Microsoft Excel Online.

Parameter Description

Refresh Token

The refresh token that authorizes the driver to access your account data.

Workbook Name

The name of the currently active workbook. You can use only one workbook within one connection.

Workbook Id

The unique id of the active workbook consisting of the specific string of characters.

Proxy Settings

Proxy Server

The proxy hostname or IP address.

Proxy User ID

The proxy username.

Proxy Password

The proxy password.

Port

The proxy port.

Advanced Settings

Allow NULL Strings

To retrieve metadata, not all parameters, according to MSDN, can accept a null value. If NULL, the driver should return an error. But some 3rd-party tools pass NULL to the parameters. These options should be enabled for compatibility with such tools.

Empty Strings as NULL

ReturnForeignKeys

Use the option to specify whether the driver must return foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even whey they do not actually need this information. Note that enabling the option may degrade performance of data access operations. The default value is False.

Use Header to Detect Column Names

Use this parameter to define how to read the first row of a sheet. If there are no column names in the spreadsheet, then standard Excel column names will be displayed (A-Z).

Connection Timeout

The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60.

Query Timeout

The time to wait for a query execution result before terminating and generating an error.

UTC Dates

Specifies whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time and whether the date values specified on the application side (e.g., in SQL statements) are considered UTC or local. The default value is false.

Sheet Tables

Determines whether tables on worksheets should be used as separate objects.

Max Cell Length

Allows to specify the maximum text length in a cell.

Min Column Count

Sets the minimum column count with data on a sheet. This parameter is in use when Use Header to Detect Column Names is disabled, or when the sheet is lacking headers. The default value is 26 (A-Z range).

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

ODBC Behavior

Sets the behavior corresponding to the ODBC specification version expected by a third-party tool. The behavior of the ODBC driver can be changed by calling the SQLSetEnvAttr function to set the SQL_ATTR_ODBC_VERSION environment attribute. Some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the needed version, or pass the incorrect value. In this case, the behavior can be explicitly set in the Connection String.
  • Default - The default value. The ODBC behavior is determined by a third-party tool.
  • Ver 2.x - ODBC 2.x behavior is explicitly set.
  • Ver 3.x - ODBC 3.x behavior is explicitly set.

String Types

Sets the string value types returned by the driver as Default, ANSI, or Unicode.
  • Default - The driver defines the string types.
  • Ansi - All string types are returned as SQL_CHAR, SQL_VARCHAR, and SQL_LONGVARCHAR.
  • Unicode - All string types are returned as SQL_WCHAR, SQL_WVARCHAR, and SQL_WLONGVARCHAR.

Set the parameter to Ansi or Unicode, if your third-party tool supports only Ansi or Unicode strings.

Sample Microsoft Excel Online ODBC Connection String

DRIVER={Devart ODBC Driver for ODBC Driver for Microsoft Excel Online};Refresh Token=myrefreshtoken;WorkBook=My Book.xlsx;WorkBook Id=myworkbookid

© 2015-2024 Devart. All Rights Reserved. Request Support ODBC Forum Provide Feedback