Help > ODBC Drivers > API Driver > Connection String Attributes

Introduction

This page lists all possible attributes you can use in ConnectionString or WITH clause of SQL Query. If you are not sure how to write correct connection string then perform following steps.

1. Search for odbcad32 in the start menu. Click to launch it.
2. Configure desired properties in the grid and check Query Preview to make sure everything is correct.
3. Click on [Copy Connection String] button to generate full connection string.

Connection String Examples

Syntax: (Direct Connection string without DSN)

Driver={ZappySys Api Driver}[,Attribute1=Value;][,Attribute2=Value;]........[,Attribute3=Value;] 

Syntax: (Using DSN)

DSN=YourDsnName;[,Attribute1=Value;][,Attribute2=Value;]........[,Attribute3=Value;]

Connection String Attributes

Attribute	Label	Description
ConnectionStringFile (Setting of ApiConfigurationParams)	ConnectionStringFile
Cache Settings
CacheEntryTtl (Setting of ApiConfigurationParams)	Cache entry lifetime, sec	This property indicates how many seconds data is kept in cache (in case caching is enabled)
CacheFileLocation (Setting of ApiConfigurationParams)	Cache file location	This property allows you to set cache file location (you have to set Cache persistence mode to Storage)
CacheStorage (Setting of ApiConfigurationParams)	Cache storage	Specifies cache storage - in-memory only or local data file Available Options Option Description Memory Memory File File
CachingMode (Setting of ApiConfigurationParams)	Cache mode	Enables or disables cache usage for metadata / data Available Options Option Description Disabled Caching disabled Metadata Cache metadata All Cache all
Error Handling Settings
ConvErrorHandlingMode (Setting of ApiConfigurationParams)	Error handling for data conversion	Determines whether some data conversion errors are ignored or stop query processing. Available Options Option Description ThrowError Stop execution on data conversion error Ignore Ignore data conversion errors
Log Settings
LoggingLevel (Setting of ApiConfigurationParams)	Log level	Sets level of messages logged Available Options Option Description None None Error Error Debug Debug Info Info
LogPath (Setting of ApiConfigurationParams)	Log file location	Sets location for the log file (empty value means no log written)
LogSize (Setting of ApiConfigurationParams)	Maximum log file size (Mb)	Sets limit for log file size (0 means no limit, old log entries will be discarded if size limit is reached)
Metadata Settings
TreatBlankBoolAsNull (Setting of ApiConfigurationParams)	Treat blank BOOLEAN value as NULL
TreatBlankDateAsNull (Setting of ApiConfigurationParams)	Treat blank DATE/TIME value as NULL
TreatBlankNumberAsNull (Setting of ApiConfigurationParams)	Treat blank NUMERIC value as NULL
Other Settings
RowsToScanToGuessMeta (Setting of ApiConfigurationParams)	Number of rows to scan to detect column types
SqlEngineMode (Setting of ApiConfigurationParams)	SQL Engine Mode	Defines how sql is executed (i.e. at server side or at client side). If you choose ServerSide then SQL must be compatible with provider's SQL standard (Do not use ZappySys syntax / functions). If API connector doesn't support serverside SQL then it will throw error. After you set this to ServerSide make sure to add #ClientSide prefix to queries which are not treated as Server side (e.g. #ClientSide select * from list_datasets) Available Options Option Description Default Default ClientSide ClientSide ServerSide ServerSide
Output Settings
DefaultRowLimit (Setting of ApiConfigurationParams)	Default data row limit (i.e. LIMIT / TOP clause)	Use this option if you like to limit number of rows fetched by any query. If you use LIMIT clause in the query then this option is ignored.
OutputOption (Setting of ApiConfigurationParams)	Default Output Option for Insert/Update/Delete	By default Output=1 for WITH clause in INSERT/UPDATE/DELETE when not specified. Use this option to control default option. This is useful when ODBC Bulk INSERT invoked by some ETL Tools where you cannot supply WITH clause and like to mimic Output=0 so some errors are thrown if some insert records failed. By default when Output=1 then errors not thrown rather displayed in the output as rows.
Query Engine Temp Storage
TempStorageMode (Setting of ApiConfigurationParams)	Intermediate results storage	Use [Disk] if number of resulting rows or row data size is large Available Options Option Description Memory Memory Disk Disk
AccessToken (Setting of ISqlDataConnection)	AccessToken
AuthName (Setting of ISqlDataConnection)	AuthName
AuthScheme (Setting of ISqlDataConnection)	AuthScheme
ClientId (Setting of ISqlDataConnection)	ClientId
ClientSecret (Setting of ISqlDataConnection)	ClientSecret
ConfigFile (Setting of ISqlDataConnection)	ConfigFile
ConfigText (Setting of ISqlDataConnection)	ConfigText
ConnectionString (Setting of ISqlDataConnection)	ConnectionString
ConnectionStringFile (Setting of ISqlDataConnection)	ConnectionStringFile
ConnectionStringFull (Setting of ISqlDataConnection)	ConnectionStringFull
ConnectionStringNonDefaultsOnly (Setting of ISqlDataConnection)	ConnectionStringNonDefaultsOnly
ConnectionStringNonDefaultsOnlyFull (Setting of ISqlDataConnection)	ConnectionStringNonDefaultsOnlyFull
DisableCustomUrl (Setting of ISqlDataConnection)	DisableCustomUrl
DisableSockProxySupport (Setting of ISqlDataConnection)	DisableSockProxySupport
DisableTest (Setting of ISqlDataConnection)	DisableTest
DisableThirdPartWebRequest (Setting of ISqlDataConnection)	DisableThirdPartWebRequest
ExtraHeaders (Setting of ISqlDataConnection)	ExtraHeaders
HasInnerConnectionSupport (Setting of ISqlDataConnection)	HasInnerConnectionSupport
MetaBody (Setting of ISqlDataConnection)	MetaBody
MetaContentType (Setting of ISqlDataConnection)	MetaContentType	Available Options Option Description None None Json Json Xml Xml Regex Regex
MetaFields (Setting of ISqlDataConnection)	MetaFields
MetaFilters (Setting of ISqlDataConnection)	MetaFilters
MetaHeaders (Setting of ISqlDataConnection)	MetaHeaders
MetaMethod (Setting of ISqlDataConnection)	MetaMethod
MetaTemplate (Setting of ISqlDataConnection)	MetaTemplate
MetaUrl (Setting of ISqlDataConnection)	MetaUrl
Parameters (Setting of ISqlDataConnection)	Parameters
Password (Setting of ISqlDataConnection)	Password
PreferProxyUrl (Setting of ISqlDataConnection)	PreferProxyUrl
Provider (Setting of ISqlDataConnection)	Provider	Available Options Option Description Notset Notset Custom Custom Connector (i.e. Search Online -OR- Use Local File) OData OData ZohoCrm Zoho CRM AmazonMws Amazon MWS (Marketplace Webservice) GoogleSheets Google Sheets GoogleBigQuery Google BigQuery Zendesk Zendesk Jira JIRA (Atlassian) SharePoint SharePoint Online GoogleDrive Google Drive OneDrive OneDrive HubSpot HubSpot DropBox DropBox GoogleCalendar Google Calendar ElasticSearch ElasticSearch Stripe Stripe Zoom Zoom ManagedEngineServiceDeskPlus ManagedEngine ServiceDesk Plus (By Zoho) Youtube Google Youtube AmazonAds Amazon Ads Shopify Shopify OutlookMail Outlook Mail (Office 365) AzureDevOps Azure DevOps (TFS Online) CosmosDB Cosmos DB MailChimp Mailchimp ServiceNow ServiceNow Connector PowerBI PowerBI FastSpring FastSpring SalesIQ Zoho SalesIQ Smartsheet Smartsheet AmazonSP Amazon Selling Partner (SP-API) (Beta) Asana Asana (Beta)
RefreshToken (Setting of ISqlDataConnection)	RefreshToken
RefreshTokenFilePath (Setting of ISqlDataConnection)	RefreshTokenFilePath
RetainSameConnection (Setting of ISqlDataConnection)	RetainSameConnection
RetryCountMax (Setting of ISqlDataConnection)	RetryCountMax
RetryMessageList (Setting of ISqlDataConnection)	RetryMessageList
RetryMode (Setting of ISqlDataConnection)	RetryMode	Available Options Option Description None Do not retry RetryAny Retry for any web, io, timeout errors RetryWhenStatusCodeMatch Retry for matching response status code(s) (e.g. 429|501) RetryWhenMessageMatch Retry if error message contains specified string(s) (e.g. nessage1|message2)
RetryMultiplyWaitTime (Setting of ISqlDataConnection)	RetryMultiplyWaitTime
RetryStatusCodeList (Setting of ISqlDataConnection)	RetryStatusCodeList
RetryWaitTimeMs (Setting of ISqlDataConnection)	RetryWaitTimeMs
ReturnUrl (Setting of ISqlDataConnection)	ReturnUrl
ServiceUrl (Setting of ISqlDataConnection)	ServiceUrl
SupportDualProxyMode (Setting of ISqlDataConnection)	SupportDualProxyMode
Timeout (Setting of ISqlDataConnection)	Timeout
TokenCacheFilePath (Setting of ISqlDataConnection)	TokenCacheFilePath
TrustedDomains (Setting of ISqlDataConnection)	TrustedDomains
Url (Setting of ISqlDataConnection)	Url
UseEmbeddedConfig (Setting of ISqlDataConnection)	UseEmbeddedConfig
UserName (Setting of ISqlDataConnection)	UserName
UseThirdPartyWebRequest (Setting of ISqlDataConnection)	UseThirdPartyWebRequest
UseWebProxy (Setting of ISqlDataConnection)	UseWebProxy

---

Copyrights reserved. ZappySys LLC.