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.
For more information on establishing a connection, see Basic Tab.
| Property | Description |
| URL | URL to the Organization root or the OData services file. For example, http://MySite/MyOrganization. |
| AuthScheme | The scheme used for authentication. Accepted entries are NTLM, BASIC, DIGEST, NONE, NEGOTIATE, or SHAREPOINTONLINE. |
| User | The OData user account used to authenticate. |
| Password | The password used to authenticate the user. |
| FeedURL | URL to the OData entity set. For example, http://MySite/MyOrganization/EntitySet. |
| SharePointUseSSO | Whether or not to use single sign-on (SSO) to authenticate to SharePoint Online. |
| Property | Description |
| AzureADTenant | The Azure Active Directory tenant to authenticate against (only used with Azure AD OAuth). |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
| AzureResource | The Azure Active resource to authenticate to (used during Azure OAuth exchange). |
| Property | Description |
| SharePointSSODomain | The domain of the user when using single sign-on (SSO). |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| OAuthVersion | The version of OAuth being used. |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthAccessTokenSecret | The OAuth access token secret for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. |
| CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| OAuthGrantType | The grant type for the OAuth flow. |
| OAuthIncludeCallbackURL | Whether to include the callback URL in an access token request. |
| OAuthAuthorizationURL | The authorization URL for the OAuth service. |
| OAuthAccessTokenURL | The URL to retrieve the OAuth access token from. |
| 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 | The verifier code returned from the OAuth authorization URL. |
| 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 | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| KerberosKDC | The Kerberos Key Distribution Center (KDC) service used to authenticate the user. |
| KerberosRealm | The Kerberos Realm used to authenticate the user. |
| KerberosSPN | The service principal name (SPN) for the Kerberos Domain Controller. |
| KerberosKeytabFile | The Keytab file containing your pairs of Kerberos principals and encrypted keys. |
| KerberosServiceRealm | The Kerberos realm of the service. |
| KerberosServiceKDC | The Kerberos KDC of the service. |
| KerberosTicketCache | The full file path to an MIT Kerberos credential cache file. |
| Property | Description |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Property | Description |
| ContinueOnError | Whether or not to continue after encountering an error on a batch request. |
| Cookies | Allows cookies to be manually specified in name=value pairs separated by a semicolon. |
| CustomHeaders | Other headers as determined by the user (optional). |
| CustomUrlParams | The custom query string to be included in the request. |
| DataFormat | The data format to retrieve data in. Select either ATOM or JSON. |
| EnableAtomicBatchOperations | Whether or not the CData ADO.NET Provider for OData should use atomic batch operations. |
| ExpandAsterisk | Indicates whether the asterisk should be expanded in the $select query parameter. |
| IncludeNavigationParentColumns | Indicates if navigation parent columns should be included on navigation views. |
| IncludeReferenceColumn | Adds a input only ParentReference column for bulk INSERTs to properly associate children during a deep insert with the same parent. |
| MaxFilterLength | The maximum number of characters for the $filter query parameter. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| MaxSelectLength | The maximum number of characters for the $Select query parameter. |
| NavigationPropertiesAsViews | A boolean indicating navigation properties should be promoted to full views. |
| ODataVersion | The version of OData to use. By default the provider will attempt to autodetect the version. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from OData. |
| Readonly | You can use this property to enforce read-only access to OData from the provider. |
| ServerTimeZone | The timezone by which the server's Edm.DateTime values are represented. The value of this property will affect how Edm.DateTime filters and results are converted between the server and the client machine. |
| StoredProceduresAsViews | A boolean indicating if we should list stored procedures which return a collection of entities as views. |
| SupportsExpand | Whether you need to specify the base entity's key to query navigation property views. |
| SupportsFilter | Set this to true if your OData service supports filters. |
| SupportsFormulas | A boolean indicating if the odata service supports server side formulas. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseClientSidePaging | Whether or not the CData ADO.NET Provider for OData should use client side paging. |
| UseEtags | Whether or not the OData source uses Etags. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |