Connection String Options

NameDefaultDescription
Server - The IP or hostname of the SharePoint server. Required.
Example: localhost, 192.168.0.1, http://mysharepointsite.com, https://mysharepointsite.com
  • You can add the https:// prefix to enable SSL/TLS encryption and override the SSL option.
  • You can specify the port to use in the server string, for example: 192.168.0.1:81 or https://mysharepointsite.com:444.
Database - Corresponds to a site path on the SharePoint server, e.g. "marketing" or "marketing/news".
This site is where your lists and libraries will be selected from. Leave empty to select the top site.
User - User name of the account used to access SharePoint. This account must have sufficient privileges to access the provided site. Required when server uses authentication mode [Ntlm] or [Basic].
Password - SharePoint account password.
Domain - The domain of the specified user.
Leave empty if domain user account is not used.
Authentication Ntlm

Indicates the authentication mode used to connect to the SharePoint server.
[Default]: Use the credentials from the current security context. No specific account details should be provided. Set this mode when the Connector is used in components running inside SharePoint, such as in webparts. The connector is then authenticated as the current user.
[Ntlm]: Specifies client authentication using Ntlm. This is the most common scenario.
[Basic]: Specifies that user authenticates to the server using basic authentication which is a simpler less secure form.
[365]: Specifies token base authentication against Office 365. Requires that Windows Identity Foundation is installed on the server.

SSL False Boolean value indicating whether connecting to SharePoint using HTTPS.
SSLAcceptAll True Specifies whether the Connector should accept all certificates over HTTPS (less secure), for example self signed certificates. Enhance the security by setting this to False. This however requires that the server certificate is valid.
MaxBytesPerRead 32768 Sets the maximum data size in bytes returned by the underlying connection per read. Increase this when necessary. Read more on msdn.
MaxReceivedMessageSize 524288 Sets the maximum total data size in bytes that can be received by the underlying connection. Increase this when necessary. Read more on msdn.
MaxArrayLength 16384 This option is rarely specified. Read more on msdn.
MaxDepth 32 This option is rarely specified. Read more on msdn.
MaxNameTableCharCount 16384 This option is rarely specified. Read more on msdn.
MaxStringContentLength 8192 This option is rarely specified. Read more on msdn.
TimeOut 60 Sets the timeout limit in seconds when receiving and sending data. Increase this when necessary.
RecursiveMode RecursiveAll Indicates how to handle SharePoint lists with subfolders when performing SELECT commands.
[FilesOnly]: Select list items (not folders) from the current folder only.
[Recursive]: Select list items (not folders) from the current folder and all subfolders recursively.
[RecursiveAll]: Select list items and folders from the current folder and all subfolders recursively.
StrictMode True When True the Connector always validates values being updated (size, limits, etc) before executing INSERT and UPDATE commands. Set to False to disable all validation and leave this to SharePoint. This option is rarely specified.
Note: The SharePoint API is much less restrictive than in the user interface and does not always respect column settings.
DecodeName True Obsolete! True means that special characters in column names are automatically decoded when performing SELECT commands. This option is rarely specified.
DefaultLimit 0 Indcates the default max number of rows returned from SELECT commands. Zero means SharePoint default setting, typically 100 rows. Increase this to select more data from larger lists.
Note: This value is always overridden if LIMIT clause is provided in the SELECT command.
CacheTimeOut 30 Controls the timeout limit in seconds for the built in schema caching mechanism. To increase performance, schemas are automatically cached for a limited amount of time.
NoListFilters False Specify True to disable all list filters when selecting data. By default, when selecting rows from a list, any filters configured on the views in SharePoint will also apply to the selected content. In some cases this is not the desired behavour.
ExpandUserFields False Specify True to make user columns include login name, e-mail address, Session Initiation Protocol (SIP) address, and title. By default, user columns show only ID and Name.
ServerUrlRelativeList True Specify True to ensure that the SharePoint ServerUrl column always show the path relative list.
StreamBuffering True Specifies send method for the UPLOAD procedure. When True, the data is buffered in memory so it is ready to be resent in the event of redirections or authentication requests. Setting this value to False can improve application performance but can cause problems if the SharePoint server does not support pre-authentication.
FullSchemaOnly False When CommandBehavior is set to SchemaOnly and when no view is provided this option specifies that all columns shall be included.
LogFile - File path to log file, e.g. "c:\log.sql". When specified all queries will be logged to this file.
MaxKeys 25 Specifies maximum number of key values that can be used to improve performance when joining between lists. Increasing this value may lead to improved performance because less data needs to be transfered between SharePoint and the Connector.
UseDefaultProxy False Specifies whether the auto-configured HTTP proxy of the system should be used. For performance reasons the default value is False. Specify True if the proxy settings should be read.

Skip Navigation Links.

Visa     MasterCard