|
Connection String Parameters - FreshBooks ODBC Driver |
|
|
|
Connection String Parameters - FreshBooks ODBC Driver |
|
The following table lists the connection string parameters for FreshBooks.
| Parameter | Description | |
|---|---|---|
|
|
Used to specify the required FreshBooks version. The available values are:
The default value - New. |
|
FreshBooks New: |
||
|
|
The company name used when creating a FreshBooks account. |
|
|
|
Access token is used to securely connect ODBC Driver for FreshBooks to your account. For information on obtaining an access token, see Requesting Access Token. To save your authentication token in the DSN settings, select the |
|
FreshBooks Classic: |
||
|
|
The URL of the FreshBooks server to connect to. |
|
|
|
API/authentication token is used to securely connect ODBC Driver for FreshBooks to your account. For information on obtaining an authentication token, see Obtaining API Key. To save your authentication token in the DSN settings, select the |
|
Proxy Settings |
||
|
|
The proxy hostname or IP address. |
|
|
|
The proxy port. |
|
|
|
The proxy username. |
|
|
|
The proxy password. |
|
Advanced Settings |
||
|
|
Some parameters don't accept null values when retrieving metadata. If a third-party tool passes a null value to such a parameter, the driver returns an error. By default, these options are enabled for compatibility with such third-party tools. |
|
|
|
||
Cache Metadata |
This is a configurable parameter, which allows caching and storing metadata in a temporary database. The parameter settings specify the frequency of resetting cached metadata ranging from 1 hour...to 1 month.
False
The metadata caching is disabled.
Hour
Cached metadata is reset one time per hour.
Day
Cached metadata is reset once a day (i.e. every 24 hours).
Month
Cached metadata is reset once per month.
True
Metadata caching won't reset until the driver is unloaded.
|
|
|
|
The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60. |
|
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 an incorrect value. In this case, the behavior can be explicitly set in the connection string.
0
The default value. ODBC behavior is determined by a third-party tool.
2
ODBC 2.x behavior is explicitly set.
3
ODBC 3.x behavior is explicitly set.
|
|
|
|
The time to wait for a query execution result before terminating and generating an error. |
|
|
|
Enables the use of local regional settings when converting dates and times to strings. |
|
|
|
Enables the use of local regional settings when converting numbers to strings. |
|
|
|
Use the parameter 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. |
|
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.
Note: Set the parameter to
Ansi or Unicode if your third-party tool supports only ANSI or Unicode strings.
|
|
|
|
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. |
|
|
DRIVER={Devart ODBC Driver for FreshBooks};Version=Classic;Server=https://mycompany-billing.freshbooks.com/api/2.1/xml-in;Authentication Token=vs1b0ca04c5848d74w0d37q764509ee5d80ee5d80 |
|
DRIVER={Devart ODBC Driver for FreshBooks};Version=New;Company Name=Your_company_name;Access Token=d3b765fgdf907f067q764509ee5d80h987v5848s1b0ca04cdid92376847g74w0 |