Connection String Options
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.
| Property | Description |
| URL | Specifies the root URL of the OData service, also called the service root URL. For example, http://services.odata.org/V4/Northwind/Northwind.svc. |
| AuthScheme | Specifies the authentication scheme to use for connecting to OData. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| FeedURL | URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet. |
| SharePointUseSSO | Specifies whether to use single sign-on (SSO) to authenticate to SharePoint Online. |
| Property | Description |
| AzureADTenant | Specifies the Azure Active Directory tenant to authenticate against. Used only with Azure AD OAuth authentication. |
| AzureTenant | Identifies the OData tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureResource | The Azure Active resource to authenticate to (used during Azure OAuth exchange). |
| Property | Description |
| SharePointSSODomain | Specifies the user domain for SSO in OData when it differs from the domain configured in the SSO service. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthVersion | Identifies the version of OAuth being used. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to OData via OAuth (Custom OAuth applications only). |
| OAuthPasswordGrantMode | Specifies how the OAuth Client ID and Client Secret are sent to the authorization server. |
| OAuthIncludeCallbackURL | Whether to include the callback URL in an access token request. |
| OAuthAuthorizationURL | The authorization URL for the OAuth service. |
| OAuthAccessTokenURL | The URL from which the OAuth access token is retrieved. |
| OAuthRefreshTokenURL | The URL to refresh the OAuth token from. |
| OAuthRequestTokenURL | The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
| AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
| OAuthParams | A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| KerberosKDC | Identifies the Kerberos Key Distribution Center (KDC) service used to authenticate the user. (SPNEGO or Windows authentication only). |
| KerberosRealm | Identifies the Kerberos Realm used to authenticate the user. |
| KerberosSPN | Identifies the service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosUser | Confirms the principal name for the Kerberos Domain Controller, which uses the format host/user@realm. |
| KerberosKeytabFile | Identifies the Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | Identifies the service's Kerberos realm. (Cross-realm authentication only). |
| KerberosServiceKDC | Identifies the service's Kerberos Key Distribution Center (KDC). |
| KerberosTicketCache | Specifies the full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
| SSLClientCertType | Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
| SSLClientCertPassword | Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
| SSLClientCertSubject | Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live OData data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AllowNavigationDisassociation | Specifies whether the provider binds navigation properties to null values. |
| BatchSize | Specifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 . |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to OData immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| ContinueOnError | Specifies whether batch requests should continue after encountering an error. (OData 4.0 and higher only.). |
| Cookies | This property can be manually specified in the format of name=value pairs, which are separated by semicolons. |
| CustomHeaders | Specifies additional HTTP headers to append to the request headers created from other properties, such as ContentType and From. Use this property to customize requests for specialized or nonstandard APIs. |
| CustomURLParams | A string of custom URL parameters to be included with the HTTP request, in the form field1=value1&field2=value2&field3=value3. |
| DataFormat | Specifies the formatting of data when interacting with an OData service. The two formats supported are ATOM and JSON. |
| DecodeXMLNames | Specifies whether to decode column names containing Unicode characters. |
| EnableAtomicBatchOperations | This property indicates that all Create, Update, and Delete (CUD) requests in a batch are handled as a single action. The success of the entire batch depends on the outcome of all requests. If any single request fails, the whole batch fails and no changes are applied. |
| ExcludeControlInformationRootType | Indicates whether OData should use the odata.type control information for the root element. |
| ExpandAsterisk | The OData service should return everything if the $select query parameter is not specified by default. In certain cases, this functionality can be set to true, allowing retrieval of every column from the specified dataset. This applies specifically to SQL queries. |
| IncludeNavigationParentColumns | Specifies whether the columns that serve as parent navigational elements should be incorporated within the navigation views. |
| IncludeReferenceColumn | Adds an input-only ParentReference column designed for bulk INSERT operations, ensuring that child records are correctly linked to their respective parents during a deep INSERT process. |
| MaxFilterLength | Specifies the maximum number of characters permitted in the $filter query parameter of a OData request. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxSelectLength | This property limits the number of characters allowed in the $select query option. If the length of the generated $select parameter exceeds the values specified, the column selection is instead processed client-side. Setting this property to 0 prevents the provider from submitting the $select parameter to the service, which is useful for services that do not support it. |
| NavigationPropertiesAsViews | A boolean indicating navigation properties should be promoted to full views. |
| ODataVersion | The version of OData that should be utilized. By default, the provider is designed to automatically detect and adapt to the appropriate version, ensuring seamless integration and functionality. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from OData. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. |
| PoolMinSize | Specifies the minimum number of connections to be maintained in the connection pool at all times. |
| PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Readonly | Toggles read-only access to OData from the provider. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| ServerTimeZone | The timezone for representing or interpreting the server's Edm.DateTime values. The value of this property affects how Edm.DateTime filters and results are converted between the server and the client. |
| StoredProceduresAsViews | A boolean value indicating whether stored procedures returning collections of entities should be treated as views. |
| SupportsExpand | Determines whether navigation properties can be retrieved from the base entity set, which is more accurate. If this property is false, it prevents the provider from retrieving navigation properties. |
| SupportsFilter | Specifies whether the OData service supports the $filter query parameter. |
| SupportsFormulas | A boolean indicating if the odata service supports server side formulas. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseClientSidePaging | Specifies whether or not OData should return data using client-side paging, if your source supports it. To use client-side paging, set this to True. To use server-side paging, set this to False. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UseEtags | The purpose of this property is to optionally hide the Etag column if the service does not return a value for it. Otherwise, it will be included but remain empty. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |