JDBC Driver for SharePoint

Build 20.0.7655

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 Establishing a Connection.
Auth SchemeThe scheme used for authenticating to SharePoint. For On-Premise instances, accepted entries are NTLM, Basic, Digest, Forms, None, and Negotiate. NTLM is the default. For Sharepoint Online, the only accepted entry is OAuth.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Azure EnvironmentThe Azure Environment to use when establishing a connection.
Azure TenantThe Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
Batch SizeThe maximum size of each batch operation to submit.
Cache ConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
Cache DriverThe database driver to be used to cache data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Calculated Data TypeThe data type to be used for calculated fields.
Callback URLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your Add-In settings.
Connection Life TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On OpenThis property species whether to connect to the SharePoint when the connection is opened.
Continue On ErrorIndicates whether or not to continue updating items in a batch after an error.
Create ID ColumnsIndicates whether or not to create supplemental ID columns for SharePoint columns that use values from information stored in other Lists.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Folder OptionAn option to determine how to display folders in results. Enter either FilesOnly, FilesAndFolders, Recursive, or RecursiveAll.
Include Lookup ColumnsThis option controls whether the driver returns the lookup columns defined on a table.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Kerberos KDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
Kerberos Keytab FileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
Kerberos RealmThe Kerberos Realm used to authenticate the user with.
Kerberos Service KDCThe Kerberos KDC of the service.
Kerberos Service RealmThe Kerberos realm of the service.
Kerberos SPNThe service principal name (SPN) for the Kerberos Domain Controller.
Kerberos Ticket CacheThe full file path to an MIT Kerberos credential cache file.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Expires InThe lifetime in seconds of the OAuth AccessToken.
OAuth Grant TypeThe grant type for the OAuth flow.
OAuth Refresh TokenThe OAuth refresh token for the corresponding OAuth access token.
OAuth Settings LocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth Token TimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from SharePoint.
PasswordThe password used to authenticate the user.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to SharePoint from the provider.
RTKThe runtime key used for licensing.
SchemaThe type of schema to use.
Share Point EditionThe edition of SharePoint being used. Set either SharePoint Online or SharePoint On-Premise.
Show Hidden ColumnsBoolean determining if hidden columns should be shown or not. If false, all hidden columns will be removed from the column listing.
Show Predefined ColumnsBoolean determining if predefined columns should be shown or not. If false, all columns derived from a base type will be removed from the column listing.
Show Version ViewsIndicate whether to display the view of list versions. Such as ListA_Versions.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
SSO DomainThe domain of the user when using single sign-on (SSO).
SSO Login URLThe identity provider's login URL.
SSO PasswordThe password of the SSOProvider used to authenticate the user.
SSO PropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.
SSO ProviderThe name of the SSO provider you are trying to authenticate.
SSO UserThe SSOProvider user account used to authenticate.
STSURLThe URL of the security token service (STS) when using single sign-on (SSO).
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
URLThe base URL for the site.
Use Connection PoolingThis property enables connection pooling.
Use Display NamesBoolean determining if the display names for the columns should be used instead of the API names.
Use NTLMV1Determines whether the driver will attempt to connect with NTLMv1 or NTLMv2 (default).
UserThe SharePoint user account used to authenticate.
Use Simple NamesBoolean determining if simple names should be used for tables and columns.
Use SSOWhether or not to use single sign-on (SSO) to authenticate to SharePoint Online.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7655