SharePoint Data Model

Connection String Options

  1. Auth Cookie
  2. Auth Scheme
  3. Auto Cache
  4. Batch Size
  5. Cache Connection
  6. Cache Driver
  7. Cache Location
  8. Cache Metadata
  9. Cache Query Result
  10. Cache Tolerance
  11. Calculated Data Type
  12. Connect On Open
  13. Continue On Error
  14. Create ID Columns
  15. Firewall Password
  16. Firewall Port
  17. Firewall Server
  18. Firewall Type
  19. Firewall User
  20. Folder Option
  21. Kerberos KDC
  22. Kerberos Realm
  23. Kerberos SPN
  24. Location
  25. Logfile
  26. Max Log File Size
  27. Offline
  28. Other
  29. Page Size
  30. Password
  31. Pool Idle Timeout
  32. Pool Max Size
  33. Pool Wait Time
  34. Proxy Auth Scheme
  35. Proxy Auto Detect
  36. Proxy Exceptions
  37. Proxy Password
  38. Proxy Port
  39. Proxy Server
  40. Proxy SSL Type
  41. Proxy User
  42. Pseudo Columns
  43. Readonly
  44. RTK
  45. Share Point Edition
  46. Show Hidden Columns
  47. Show Predefined Columns
  48. SSL Server Cert
  49. SSO Domain
  50. STSURL
  51. Support Enhanced SQL
  52. Tables
  53. Timeout
  54. URL
  55. Use Connection Pooling
  56. Use Display Names
  57. User
  58. Use Simple Names
  59. Use SSO
  60. Verbosity
  61. Views

Auth Cookie

Data Type

string

Default Value

""

Remarks

After logging in to http://yourdomain.sharepoint.com/TeamSite, the "keep me signed in" setting must be checked in order for the connection to be established.

 

Auth Scheme

Data Type

string

Default Value

"NTLM"

Remarks

Together with Password and User, this field is used to authenticate against the server. NTLM is the default option. Use the following options to select your authentication scheme:

  • NTLM: Set this to use your Windows credentials for authentication.
  • NEGOTIATE: If AuthScheme is set to NEGOTIATE, the driver will negotiate an authentication mechanism with the server. Set AuthScheme to NEGOTIATE if you want to use Kerberos authentication.
  • KERBEROSDELEGATION: Set this to use delegation through the Kerberos protocol. Set the User and Password of the account you want to impersonate.
  • NONE: Set this to use anonymous authentication; for example, to access a public site.
  • FORMS: Set this if your SharePoint instance uses a custom authentication method through a Web form.
  • DIGEST: Set this to use HTTP Digest authentication.
  • BASIC: Set this to use HTTP Basic authentication.

 

 

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the SharePoint data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query SharePoint in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Calendar#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

 

 

See Also

 

 

  • CacheTolerance: Control the tolerance for stale data in the cache.
  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the SharePoint metadata. Metadata then needs to be retrieved only once instead of every connection.
  • REPLICATE Statements: When you execute a SELECT statement with AutoCache set, the driver internally calls the REPLICATE statement. The REPLICATE statement enables incremental updates instead of first dropping the cached table.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Batch Size

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

 

Cache Connection

Data Type

string

Default Value

""

Remarks

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

 

Derby and Java DB

 

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheProvider and CacheConnection. Below is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

 

 

SQLite

 

To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
SQL Server

 

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

 

 

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath.

jdbc:sharepoint:CacheLocation='c:/Temp/cachedir';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:sharepoint:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:sharepoint:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:sharepoint:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for SharePoint 2017 installation directory.
SQL Server

 

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:sharepoint:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:sharepoint:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:sharepoint:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the SharePoint catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

-synch -port -rssis As you execute queries with this property set, table metadata in the SharePoint catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

 

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use REPLICATE Statements or CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Cache Tolerance

Data Type

string

Default Value

"600"

Remarks

The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver will check with the data source for newer records after the tolerance interval has expired. Otherwise it will return the data directly from the cache.

 

Calculated Data Type

Data Type

string

Default Value

""

Remarks

The data type to be used for calculated fields. By default, the data type is determined by the type of calculated field in SharePoint. However, in some cases these calculated fields may return values that are not appropriate for the specified type. In these instances, you may wish to set the Calculated Data Type to String.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to SharePoint when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to SharePoint and nothing from this initial connection is maintained.

Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).

 

Continue On Error

Data Type

bool

Default Value

true

Remarks

If this property is set to True (default), the driver will continue adding, updating, or deleting items when an error is encountered on one of the items. When set to False, the driver will stop adding, updating, or deleting items after an error is encountered (entries preceeding the problematic entry will still be added, updated, or deleted).

 

Create ID Columns

Data Type

bool

Default Value

true

Remarks

Indicates whether or not to create supplemental ID columns for SharePoint columns that use values from information stored in other Lists (like "Lookup" or "Person or Group" columns). The ID column that is created will contain the related entry's ID (in the context of its original List). If set to false, the ID columns will not be created, the ID will be ignored, and only the value of the referenced column will be returned.

 

Firewall Password

Data Type

string

Default Value

""

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

 

Firewall Port

Data Type

string

Default Value

""

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

 

Firewall Server

Data Type

string

Default Value

""

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

 

   
Type Default Port Description
TUNNEL 80 When this is set, the driver opens a connection to SharePoint and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

 

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

 

Folder Option

Data Type

string

Default Value

"RecursiveAll"

Remarks

An option to determine how to display folders in results. FilesOnly will display only files in specified lists or libraries. FilesAndFolders will display files and folders in the specified list. RecursiveAll will display files in the specified list and all subfolders.

 

Kerberos KDC

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using Windows Authentication. The driver will request session tickets and temporary session keys from the Kerberos Key Distribution Center (KDC) service. The Kerberos Key Distribution Center (KDC) service is conventionally colocated with the domain controller. If Kerberos KDC is not specified the driver will attempt to detect these properties automatically from the following locations:

  • Java System Properties: Kerberos settings can be configured in Java using the config file krb5.conf, or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The driver will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.
  • Domain Name and Host: The driver will infer the Kerberos Realm and Kerberos KDC from the configured domain name and host as a last resort.
Note: Windows authentication is supported in JRE 1.6 and above only.

 

 

Kerberos Realm

Data Type

string

Default Value

""

Remarks

The Kerberos properties are used when using SPNEGO or Windows Authentication. The Kerberos Realm is used to authenticate the user with the Kerberos Key Distribution Service (KDC). The Kerberos Realm can be configured by an administrator to be any string, but conventionally it is based on the domain name. If Kerberos Realm is not specified the driver will attempt to detect these properties automatically from the following locations:

  • Java System Properties: Kerberos settings can be configured in Java using a config file (krb5.conf) or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The driver will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.
  • Domain Name and Host: The driver will infer the Kerberos Realm and Kerberos KDC from the user-configured domain name and host as a last resort. This might work in some Windows environments.
Note: Kerberos-based authentication is supported in JRE 1.6 and above only.

 

 

Kerberos SPN

Data Type

string

Default Value

""

Remarks

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, set the Service Principal Name here.

 

Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

""

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. There is no limit by default. Values lower than 100kB will use 100kB as the value instead.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

 

Other

Data Type

string

Default Value

""

Remarks

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

Caching Configuration

 

   
CachePartial=True Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True Passes the specified query to the cache database instead of using the SQL parser of the driver.

 

Integration and Formatting

 

   
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

 

 

Page Size

Data Type

string

Default Value

"1000"

Remarks

The number of results to return per page of data retrieved from SharePoint. Higher page sizes will result in fewer requests, but timeouts may occur.

 

Password

Data Type

string

Default Value

""

Remarks

 

The User, Password, and AuthScheme are together used to authenticate with the server.

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time from when the connection is free to when the connection is released and returned to the pool. The default is 60 seconds.

 

Pool Max Size

Data Type

string

Default Value

"100"

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

 

Pool Wait Time

Data Type

string

Default Value

""

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

The ProxyServer will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

 

Proxy Password

Data Type

string

Default Value

""

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

 

Proxy Port

Data Type

string

Default Value

"80"

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

 

Proxy Server

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

   
AUTO Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS The connection is always SSL enabled.
NEVER The connection is not SSL enabled.
TUNNEL The connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

 

 

Proxy User

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; i.e., "*=*".

 

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

 

RTK

Data Type

string

Default Value

""

Remarks

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

Share Point Edition

Data Type

string

Default Value

"SharePoint OnPremise"

Remarks

The edition of SharePoint being used. Set either SharePoint Online or SharePoint On-Premise.

 

Show Hidden Columns

Data Type

bool

Default Value

false

Remarks

Boolean determining if hidden columns should be shown or not. If false, all hidden columns will be removed from the column listing.

 

Show Predefined Columns

Data Type

bool

Default Value

true

Remarks

Boolean 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. These columns are normally system columns such as CreatedBy and Author. But, predefined columns may also include common columns such as Title.

 

SSL Server Cert

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

   
Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

SSO Domain

Data Type

string

Default Value

""

Remarks

This property is only applicable when using single sign-on (UseSSO is set to true) and if the domain of the User (e.g. user@mydomain.com) is different than the domain configured within the SSO service (e.g. user@myssodomain.com).

This property may be required when using the AD FS, OneLogin, or OKTA SSO services.

 

STSURL

Data Type

string

Default Value

""

Remarks

The URL of the security token service (STS) when using single sign-on (SSO). This rarely needs to be set explicitly.

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to SharePoint and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the SharePoint API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

Tables

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

 

URL

Data Type

string

Default Value

""

Remarks

The following are examples of valid URLs:

  • http://server/SharePoint/
  • http://server/Sites/mysite/
  • http://server:90/
The provider will use URL to derive URLs for other calls to the server.

 

 

Use Connection Pooling

Data Type

bool

Default Value

false

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

Use Display Names

Data Type

bool

Default Value

true

Remarks

Boolean determining if the display names for the columns should be used instead of the API names.

 

User

Data Type

string

Default Value

""

Remarks

 

Together with Password, this field is used to authenticate against the SharePoint server.

For SharePoint On-Premise, User should include the domain and will look similar to the following: DOMAIN\Username.

For SharePoint Online, User will look similar to the following: username@domain.onmicrosoft.com.

 

 

Use Simple Names

Data Type

bool

Default Value

false

Remarks

Boolean determining if simple names should be used for tables and columns. SharePoint lists can have special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the driver easier to use with traditional database tools.

Setting UseSimpleNames to true will simplify the names of tables and columns returned. If set to false, the tables and columns will appear as they do in SharePoint.

 

Use SSO

Data Type

bool

Default Value

false

Remarks

When set to true, single sign-on (SSO) will be used to authenticate to SharePoint Online using the account specified via User and Password. The Active Directory Federation Services (AD FS), OneLogin, and OKTA SSO identity providers are supported.

SSODomain may be required to be set if the domain configured on the SSO domain is different than the domain of the User.

SSO is only applicable when using SharePoint Online. SSO is not supported for On-Premise versions of SharePoint.

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the request and the response.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Views

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Tables

  1. Announcements
  2. Attachments
  3. Calendar
  4. Contacts
  5. Documents
  6. Groups
  7. IssueTracking
  8. Links
  9. Pictures
  10. Roles
  11. Tasks
  12. Users
  13. Views

Announcements

Create, update, delete, and query items in Announcement lists.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The format of the ID is: List|ItemID.

List String False

The name of the list.

Title String False

The title of the item.

Body String False

The body of the item.

Expires Date False

The date the item expires on.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Attachments

Read or delete Attachments for the specified item on the specified list.

 

Table Specific Information
Select

 

List and ItemId are required to return Attachments.

Insert

 

Call the AddAttachments stored procedure to add new attachments to a list item.

Columns

 

 

 

   
Name Type ReadOnly Description
Url [KEY] String True

Description of the term set.

List String True

The list to retrieve attachments from.

ItemID String True

The ID of the item on the list to retrieve attachments from.

Name String True

The name of the attachment on the item.

 

 

 

Calendar

Create, update, query, and delete items in SharePoint Calendar lists.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the calendar entry. The format of the ID is: List|ItemID.

List String False

The name of the calendar list.

Title String False

The title of the entry.

ParticipantsPicker String False

The attendees of the calendar entry.

FreeBusy String False

A flag indicating the free or busy status during the event.

Facilities String False

The resources for this calendar entry.

Location String False

The location of the event.

EventDate Date False

The date the calendar entry starts.

EndDate Date False

The date the calendar entry ends.

Description String False

The description of the event.

Duration String False

The duration of the calendar entry.

EventType String False

The type of the event.

IsAllDayEvent String False

A flag indicating whether the entry is an all day event or not.

fRecurrence String False

A flag indicating whether this is a recurring event.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Contacts

Create, update, query, and delete items in SharePoint Contact lists.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The value of this field is of the format: List|ItemId

List String False

The name of the contacts list.

FirstName String False

The first name of the contact.

Title String False

The last name of the contact.

FullName String False

The full name of the contact.

Email String False

The email of the entry.

Company String False

The company the contact works for.

JobTitle String False

The job title of the contact.

WorkPhone String False

The business phone of the contact.

HomePhone String False

The home phone of the contact.

CellPhone String False

The mobile phone of the contact.

WorkFax String False

The fax number of the contact.

WorkAddress String False

The address of the contact.

WorkCity String False

City for the address of the contact.

WorkState String False

State for the address of the contact.

WorkZip String False

Postal code for the address of the contact.

WorkCountry String False

Country for the address of the contact.

WebPage String False

Web page for the contact.

Comments String False

Notes about the contact.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Documents

Create, update, delete, and query Documents from SharePoint libraries.

 

Table Specific Information

 

 

Select

 

To pull items in a folder, you need to use the either the Path or FileDirRef field (depending on whether UseDisplayNames is True or False respectively) in the WHERE clause. For example:

SELECT * FROM MyDocumentLibrary WHERE Path='MyDocumentLibrary/MyFolder'
Insert

 

The Title column is required to insert to this table.

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the document. The format of the ID is: List|ItemID.

List String False

The name of the document list.

LinkFileName String False

The title of the document.

CheckOutUser String False

The user that the document is checked out to.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Subfolder String

A subfolder to specify if you would like to list documents in subfolders as well. Use * to denote all subfolders.

The default value is *.

CAMLQuery String

The query to be used while listing the list items.

 

 

 

Groups

Create, update, delete, and query Groups from SharePoint.

 

Table Specific Information
Insert

 

The Name, DefaultLogin, and OwnerLogin columns are required to insert to this table.

To use the UserName pseudo column, you must set the value to the LoginName of the user. You can obtain the LoginName by querying the Users table.

Columns

 

 

 

   
Name Type ReadOnly Description
Name# [KEY] String False

The name of the group.

Description# String False

A description of the group.

OwnerLogin# String False

The user name of the owner of the group. This value should be in the format DOMAIN\\username.

OwnerType# String False

The type of owner. User or group.

DefaultLogin# String False

The user name of the default user for the group. This value should be in the format DOMAIN\\username.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
UserName String

The logical name of the user to return groups for. Specify this value on the SELECT statement to return only groups the specified User is in.

 

 

 

IssueTracking

Create, update, query, and delete items in SharePoint Issue Tracking lists.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the list entry. The format of the ID is: List|ItemID.

List String False

The name of the issue tracking list.

Title String False

The title of the entry.

AssignedTo String False

The user the issue is assigned to.

Status String False

The status of the issue.

Priority String False

The priority assigned to this issue.

Category String False

The category that the issue belongs to.

DueDate Date False

The due date of the issue.

RelatedIssues String False

A list of related issues.

Comments String False

Comments associated with this issue.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Links

Create, update, query, and delete items in SharePoint Link lists.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The format of the ID is: List|ItemID.

List String False

The name of the link list.

URL String False

The URL of the link entry.

Comments String False

The notes associated with the entry.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Pictures

Create, update, delete, and query documents in a picture library.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the document. The format of the ID is: List|ItemID.

List String False

The name of the list the document belongs to.

LinkFileName String False

The filename of the document on the server.

ImageCreateDate Date False

The date the picture was taken.

Description String False

The description associated with the document.

Keywords String False

The keywords associated with the document.

CheckedOutUser String False

The user the document is checked out to.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date that the document was modified.

Created Date False

The date that the document was created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Roles

Create, update, delete, and query Roles from SharePoint.

 

Table Specific Information
Select

 

To use the UserName pseudo column, you must set the value to the LoginName of the user. You can obtain the LoginName by querying the Users table.

Insert

 

To insert a Role, at least the Name is required:

INSERT INTO Roles (Name) VALUES ('My Role')
Columns

 

 

 

   
Name Type ReadOnly Description
Name# [KEY] String False

The name of the role.

Description# String False

A description of the role.

Permissions# Long False

A long representing the permissions for the role.

RoleType String True

The type of role.

IsHidden Boolean True

A boolean indicating if the role is hidden.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
UserName String

The login name of the user to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified user.

GroupName String

The name of the group to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified group.

 

 

 

Tasks

Create, update, query, and delete items in a SharePoint Tasks list.

 

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The ID of the item. The format of the ID is: List|ItemID.

List String False

The name of the issue tracking list.

Title String False

The title of the item.

Priority String False

The priority of the task.

Status String False

The status of the task.

PercentComplete String False

The completed progress of the task, expressed as a percentage.

AssignedTo String False

The SharePoint user the task is assigned to.

TaskGroup String False

The SharePoint group the task is assigned to.

Body String False

The description of the item.

StartDate Date False

The start date of the task.

DueDate Date False

The due date of the task.

WorkflowName String False

The name of the workflow associated with the task.

Author String False

The user that created the item.

Editor String False

The last user that modified the item.

Modified Date False

The date modified.

Created Date False

The date created.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
CAMLQuery String

The query to be used while listing the list items.

 

 

 

Users

Create, update, delete, and query Users from SharePoint.

 

Table Specific Information
Select

 

Retrieve all users created for the SharePoint Account:

Select * from Users

 

You can retrieve Users that belong to a specific Group. In this case specify the Group Name

Select * from Users where [Group]="GroupName"

 

Or you can retrieve Users that have a specific Role. In this case specify the Role Name

Select * from Users where [Role]="RoleName"
Insert

 

In order to add Users to SharePoint, the Group or Role the User is being added to must be specified. Additionally, specify the LoginName:

INSERT INTO Users (LoginName, Role) VALUES ('MYDOMAIN\MyUser', 'My Role')
Columns

 

 

 

   
Name Type ReadOnly Description
LoginName# [KEY] String False

The login name of the user.

Name# String False

The name of the user.

Email# String False

The email address of the user.

IsInDomainGroup Boolean True

A boolean indicating if the user is in the domain group.

IsSiteAdmin Boolean True

A boolean indicating if the user is a site admin.

Notes# String False

Optional notes concerning the user.

SecurityId String True

The security Id (SID) for the user.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
Group String

The group you are adding a user to or deleting the user from. This is an input-only value and either Group or Role must be specified for inserts, but may be optionally specified for deletions.

Role String

The role you are adding a user to or deleting the user from. This is an input-only value and either Group or Role must be specified for inserts, but may be optionally specified for deletions.

NewName String

The new name of the user. Specify this value when updating the user to change the name of the user.

 

 

 

Views

Create, update, delete, and query the available lists in SharePoint.

 

Table Specific Information

 

 

Views is a special table. It may be used to get, update, insert, and delete views from a specified List.

Select
In order to return results from Views, either the Id or List must be specified in the SELECT statement. For example:

 

 

SELECT * FROM Views WHERE List='MyListName'
Insert

 

The List, Name, Type, and Fields columns are required to insert to this table.

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The Id of the view.

List String True

The list the view is associated with. A list must be specified when performing SELECT statements if the Id is not specified.

ViewID String True

The Id of the view. May only be unique for the specific list.

Name String False

The name of the view.

Type String False

The type of view. This must have a value on inserts and updates.

The allowed values are CALENDAR, GRID, HTML.

The default value is HTML.

Fields String False

A comma separated list of the fields associated with the view. This is space-sensitive.

IsDefault Boolean False

A boolean indicating if the view is the default view for the list.

Query String False

A query for the view.

 

 




 

Views

  1. FileVersions
  2. GetValidTerms
  3. Lists
  4. Permissions
  5. Subsites

FileVersions

Lists the versions of files available on SharePoint.

 

View-Specific Information

 

Library and File must be specified to return results from this view.

Columns

 

 

 

   
Name Type Description
ID [KEY] String The ID of the version.
Comments String Comments about the particular version.
CreateBy String The username of the SharePoint user who modified this version of the file.
Date Datetime When the file was modified.
Size String The size of this version of the file.
Url String The URL to this version of the file.
Library String The library name on SharePoint you are listing versions from. A library must be specified to retrieve the versions for a file.

The default value is Shared Documents.

File String The name of the file on SharePoint to list versions for. A file must be specified to retrieve the versions for a file.

 

 

 

GetValidTerms

Gets a list of valid terms for the specified column on the specified table.

 

Table Specific Information

 

GetValidTerms is a special view. It may be used to get valid terms for a Taxonomy or Managed Metadata column of a given list. To use the view, supply both the name of the table and the column for which you are looking to get valid terms. For example:

 

SELECT * FROM GetValidTerms WHERE List='MyListName' AND ColumnName='MyManagedMetadataColumn'
Columns

 

 

 

   
Name Type Description
ID [KEY] String The identifier of the term.
TermLabelValue String The label of the term.
Description String Description of the term set.
NameInRequestedLang String The name of the term set in the language requested by the client.
IsOpen Boolean Boolean indicating if the term set is open.
Deprecated Boolean Boolean indicating if the term is deprecated.
InternalId String Internal identifier for the term.
TermSetContact String Term set contact.
ContainerDesc String Container node for the description.
SingleTermLabelDesc String This fully describes a single term label.
IsDefaultLabel Boolean True if the term label is the default term label.
BelongsTo String This item describes a term set to which a term belongs.
IsTaggingAvailable Boolean If the term set is available for tagging, this value is true.
TermPath String Term path of the term with term labels.
TermpathoftermwithIds String Term path of term with identifiers.
ChildTerms String A string value that indicates a custom sort order for the child terms of the term identified by PertainingToTerm.
HasChildTerms Boolean True if the term has child terms.
PertainingToTerm Boolean Identifier of the term that this term set information is pertaining to.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
List String The name of the list to get valid terms for.
ColumnName String The name of the column to get valid terms for.
LocaleId String The locale Id for the term. Defaults to 1033.

 

 

 

Lists

Lists the available lists in SharePoint.

 

Table Specific Information

 

Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the driver.

The following columns can be used in the WHERE clause: Title and BaseTemplate.

Columns

 

 

 

   
Name Type Description
ID [KEY] String The Id of the list.
Title String The title of the list. This column may be used in the WHERE clause and may be used with a wild card (*) character.
Description String A description for the list.
BaseTemplate String Indicates the type of template used to create the list. This column may be used in the WHERE clause.
Version Double The version of the list.
Url String The default URL of the list.
EmailAlias String The email alias of the list.
ImageUrl String The image URL of the list.
ItemCount Integer The number of items in the list.
Item_Deleted Datetime The last time an item was deleted from this list.
Item_Modified Datetime The last time an item was modified from this list.
SendToUrl String The send-to URL of the list.
Created Datetime The time when the list was created.
AllowDeletion String Whether items can be deleted.
AllowMultiResponses Boolean Boolean indicating if multiple responses are enabled for the survey.
Direction String A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left, or None.
EnableAssignedToEmail Boolean Boolean indicating if assigned-to emails are enabled. Only applies to issues lists.
EnableAttachments Boolean Boolean indicating if attachments may be added to items in the list. Does not apply to document libraries.
EnableModeration Boolean Boolean indicating if content approval is enabled for the list.
EnableVersioning Boolean Boolean indicating if versioning is enabled for the list.
Hidden Boolean Boolean indicating if the list is hidden so that it does not appear on the Documents and Lists page, Quick Launch bar, Modify Site Content page, or Add Column page as an option for lookup fields.
MultipleDataList Boolean Boolean indicating if a meeting-workspace site contains data for multiple meeting instances within the site.
Ordered Boolean Boolean indicating if items in the list can be sorted on the Edit View page.
Showuser Boolean Boolean indicating if the names of users are shown in the results of the survey.

 

 

 

Permissions

The permissions for a site or list.

 

Columns

 

 

 

   
Name Type Description
MemberID [KEY] String The ID of the permission.
Mask Long A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ('|') in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions.
MemberIsUser Bool Indicate whether it is the permission for user.
MemberGlobal Bool Indicate whether it is the permission for group.
RoleName String A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies.

 

Pseudo-Columns

 

 

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

 

 

   
Name Type Description
ObjectName String A string that contains the name of the list or site.
ObjectType String A string that specifies either List or Web.
ItemID String ID of the item.

 

 

 

Subsites

This lists the available subsites.

 

Columns

 

 

 

   
Name Type Description
Title String The name of the subsite.
Url String The url of the subsite.