SharePoint

Building the JDBC URL

After installing the license, access the connection management page by executing the command java -jar kingswaysoft.jdbc.jar. Enter the necessary details, and the program will automatically generate the JDBC connection URL. Users can click Test Connection to test the generated URL and Copy to Clipboard to copy the connection string for use within the application where the JDBC driver is being used.

Note: If the license is not installed, you can still use the connection manager to generate a JDBC URL; however, the 'Test Connection' feature will be disabled.

General Page

The General page allows you to specify connection properties and login credentials for the SharePoint REST service.

connectionmanage

Connection Settings

Authentication Type

The Authentication Type specifies the authentication type to be used when authenticating to your SharePoint instance.

The available options are:

OAuth

Used for Office 365 and SharePoint Online instances

Active Directory

Used for On-Premise and SharePoint 2016 or later instances

Service URL

The Service URL specifies the URL of the API endpoint for your SharePoint instance.

API Throttling Rate

The API Throttling Rate will limit the number of requests that can be sent per second. Set this value to 0 to disable API throttling.

Source List/Library

The Source List/Library specifies the source of the API for your SharePoint instance. Leave this value empty to access all available Lists and Libraries.

Authentication Methods for SharePoint

Active Directory

Users can choose to use their instance url along with their username, password and domain to establish a connection.

Authentication

Use Integrated Authentication: The Use Integrated Authentication checkbox allows the system to authenticate users automatically using their windows credentials.
UserName: The UserName field allows you to specify the user account that you want to use to connect to your Active Directory. Depending on how you want to manipulate your data, the user account needs to have proper privileges to do so.
Password: The Password field allows you to specify the password for the above user account in order to authenticate with SharePoint.
Domain: The Domain field lets you specify the domain name of the directory to connect to. The domain name should be a fully qualified name.

OAuth

Authorization Code

A saved token file and token password can be used to establish a connection. If you wish to generate a new token file, click Generate Token File to go through the token generation process, save the token file locally, and use the set token password to connect.

Authentication

Authentication Server (URL)

The URL of the authentication server. This is an endpoint provided by Microsoft Entra ID where your application sends a user to sign in and grant permissions.

If your instance uses a custom authentication server, check the box for 'Use a custom URL' to allow modifications to the authentication server URL.

Path To Token File

The path to the token file on the file system.

Token File Password

The password to the token file.

Generate Token File

This button completes the OAuth authentication process in order to generate a new token.

Client Id: The Client Id option allows you to specify the unique ID which identifies the application making the request.
Client Secret: The Client Secret option allows you to specify the client secret belonging to your app.
Azure AD Tenant: The Azure AD Tenant ID identifies the Azure Active Directory tenant that owns your application and is used during the authentication process.
Scope: The Scope option allows you to specify the scope of the token file being generated.
Redirect URL: The Redirect URL option allows you to specify the Redirect URL to complete the authentication process.
PKCE (Enhanced Security): The PKCE (Proof Key for Code Exchange) option may be enabled for PKCE App Type. Ensures that the client that initiates the OAuth flow is the same client that completes the flow.

Certificate

A saved certificate file and certificate password can be used to establish a connection. Set the path to the certificate file, as well as the certificate password, the tenant ID and the client ID to authenticate and connect.

NOTE: The certificate file only supports the PFX format. For newly generated certificates, a PEM file is also generated. This PEM file needs to be configured in the portal.

Authentication

Authentication Server (URL)

The URL of the authentication server. This is an endpoint provided by Microsoft Entra ID where your application sends a user to sign in and grant permissions.

If your instance uses a custom authentication server, check the box for 'Use a custom URL' to allow modifications to the authentication server URL.

Tenant Id

Specify the Tenant Id to be used when establishing the connection to the SharePoint API.

Client App Id

Specify the Client App Id to be used when establishing the connection to the SharePoint API.

Path To Certificate

The path to an existing certificate file.

Certificate Password

The password for the specified certificate file.

Test Connection

After all the connection information has been provided, click the "Test Connection" button to test if the user credentials entered can successfully connect to the selected service.

Advanced Settings Page

The Advanced Settings page allows you to specify advanced settings for the connection.

connectionmanage

Proxy Server Settings

Proxy Server Settings

Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.

No Proxy
Auto-detect (Use system configured proxy)
Manual

Proxy Server

Using the Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Miscellaneous Settings

Miscellaneous Settings

Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds. Specify 0 for an infinite timeout.

Retry on Intermittent Errors

The retry on intermittent errors determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to the target server.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Note: When this option is enabled, it applies to all HTTP-based SSL connections in the same job process.

Concurrent Writing Threads

This option can be used to set the number of threads to be used during write operations. This can improve performance during large-volume write operations.

API Settings

Show Hidden Source: The Show Hidden Source checkbox, when checked, allows you to see hidden SharePoint lists and document libraries.
Include Hidden Fields: SharePoint uses a number of hidden fields. The Include Hidden Fields option allows you to specify whether the hidden fields are read and returned.
Download Version History: You can enable this option in order to retrieve the available versions for each document in your SharePoint Document Library. This feature currently only supports SharePoint Document Libraries but not Lists.
Max Files per List Item: If you wish to upload attachments to the SharePoint list items that you create, you can specify the maximum number of attachments per list item to create. Based on the value set for this option, a number of metadata fields for attachment input will be created. Each attachment will have 2 fields designated for it in the format of Attachment_[Number]\_BinaryContent and Attachment_[Number]\_FileName.
Use Recycle Bin (Soft Delete): By enabling this option, delete moves deleted files, folders, or list items to a recycle bin where they are retained for 93 days, allowing for restoration before permanent deletion. Items can be restored from the recycle bin by administrators or users with edit rights.
Remove Invalid Characters: When enabled, the Remove Invalid Characters option will remove any invalid characters that may cause an error response from the SharePoint API.

Using the JDBC Driver

Explore detailed examples in this section that demonstrate the application of JDBC classes such as Connection, Statement, and ResultSet to effectively manage interactions with SharePoint data. This section covers the use of regular statements and prepared statements for executing complex or frequently executed queries.

Executing Statements

Once you've connected from your code (see Connecting with DriverManager and Connecting with DataSource), you can execute SQL statements using the Statement class. Refer to the Executing Prepared Statements section for information on how to execute parameterized statements.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data.

To set the Recursive mode of a query, add USING OPTIONS (DocumentScope='x') to the end of the query, replacing x with a valid value.

Valid values include Root Level (Files and Folders), Root Level (Files), Recursive (Files Only), Recursive (Files and Folders). When not provided the default recursive mode is 'Recursive'.

To retrieve the results of a query, you would then call the getResultSet method of the Statement.

String sql = "SELECT * FROM Events LIMIT 1";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

String sql = "SELECT ID,BaseName FROM sourceLibraryName WHERE BaseName = 'testBaseName' "
           + "USING OPTIONS (DocumentScope='Root Level (Files and Folders)')";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

In SharePoint, when writing multiple values to a field, you can provide the values with a comma delimited format. However, when writing multiple string values the delimiter character should be \, instead of just ,

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the inserted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "INSERT INTO Events (Title) VALUES ('title')";

try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{"Title":"title"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

In SharePoint, you can also utilize the Update by Query API. This allows you to update documents within an index or data stream that match a specified query. This allows you to perform powerful update queries more effectively while also reducing network overhead. An example is shown below.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the updated data's ID, exceptions raised during execution, and details of the affected data.

String sql = "UPDATE Events SET Title = 'updatedTitle' WHERE ID = '1'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{"Title":"updatedTitle"},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

In SharePoint, you can also utilize the Delete by Query API. This allows you to delete documents within an index or data stream that match a specified query. This allows you to perform powerful delete queries more effectively while also reducing network overhead. An example is shown below.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM Events WHERE ID = '1'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{},false

Executing Prepared Statements

Using a PreparedStatement can improve performance when you need to execute a SQL statement multiple times with different parameters. Unlike a Statement object, a PreparedStatement object is provided with a SQL statement when it is created, which can then be executed with different values each time. This special type of statement is derived from the more general class, Statement.

Below are the steps outlining how to execute a prepared statement:

Creating and Executing a Prepared Statement

Create a PreparedStatement

Use the prepareStatement method of the Connection class to instantiate a PreparedStatement.

Refer to Connecting with DriverManager or Connecting with DataSource for information related to establishing connections.

Set Parameters

Declare parameters by calling the corresponding setter method of the PreparedStatement.
NOTE: The parameter indices start at 1.

Execute the PreparedStatement

Use the generic execute or executeUpdate method of the PreparedStatement.

Retrieve Results

Call the getResultSet method of the PreparedStatement to obtain the query results, which will be returned as a ResultSet.

Iterate Over the Result Set

Use the next method of the ResultSet to iterate through the results. To obtain column information, utilize the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

SELECT

Use the PreparedStatement class's generic execute method or the executeQuery method to execute SQL statements that return data.

To set the Recursive mode of a query, add USING OPTIONS (DocumentScope='x') to the end of the query, replacing x with a valid value.

Valid values include Root Level (Files and Folders), Root Level (Files), Recursive (Files Only), Recursive (Files and Folders). When not provided the default recursive mode is 'Recursive'.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the retrieved data.

String sql = "SELECT * FROM Events WHERE GUID = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "2df8af9e-e7a5-4e00-843c-ad18c22239ae");
    boolean ret = ps.execute(sql);
    if (ret) {
        ResultSet rs = ps.getResultSet();
        LOGGER.info(rs.toString());
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

String sql = "SELECT ID,BaseName FROM sourceLibraryName WHERE BaseName = ? "
           + "USING OPTIONS (DocumentScope='Root Level (Files and Folders)')";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "testBaseName");
    boolean ret = ps.execute(sql);
    if (ret) {
        ResultSet rs = ps.getResultSet();
        LOGGER.info(rs.toString());
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String sql = "INSERT INTO Events (Title) VALUES (?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "title");
    ps.executeUpdate();

    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{"Title":"title"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of updated data, exceptions raised during execution, and the data affected by the update.

String sql = "UPDATE Events SET Title = ? WHERE ID = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "updatedTitle");
    ps.setString(2, "1");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{"Title":"updatedTitle"},false

DELETE

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute a DELETE operation.

String sql = "DELETE FROM Events WHERE ID = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "1");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{},false

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables, getColumns, and getPrimaryKeys methods from the DatabaseMetaData interface. These are essential for discovering database structures.

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

This method only retrieves tables that are not write-only.

To get a list of tables which include write-only tables, query the table system.tables.

try {
    ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
    LOGGER.info("\r\n" + rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,Documents,Table,null
null,null,Documents/All_Documents,Table,null
null,null,Documents/Attachment,Table,null
null,null,Documents/Merge_Documents,Table,null
null,null,Documents/Relink_Documents,Table,null
null,null,Documents/assetLibTemp,Table,null
null,null,Events,Table,null
null,null,Events/All_Events,Table,null
null,null,Events/Attachment,Table,null
null,null,Events/Calendar,Table,null
......

The getTables method returns the following metadata columns:

Column Name	Data Type	Description
TABLE_CAT	String	The catalog that contains the table.
TABLE_SCHEM	String	The schema of the table.
TABLE_NAME	String	The name of the table.
TABLE_TYPE	String	The type of the table (e.g., TABLE or VIEW).
REMARKS	String	An optional description of the table.

Columns

Use the getColumns method of the DatabaseMetaData interface to retrieve detailed information about database columns. To narrow the results to a specific table, specify the table name using the parameter table_name.

This method returns columns only for tables that are not write-only.

To get columns for tables which are write-only, query the table system.columns.

try {
    ResultSet rs = connection.getMetaData().getColumns(null, null, "Events", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    e.printStackTrace();
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,REMARKS,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,SCOPE_CATALOG,SCOPE_SCHEMA,SCOPE_TABLE,SOURCE_DATA_TYPE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,Events,AccessPolicy,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,AppAuthor,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,AppEditor,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,Attachments,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,Author,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,BannerImageUrl,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,BannerUrl,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,BaseName,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,Category,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,Events,ComplianceAssetId,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
......

The getColumns method returns the following columns:

Column Name	Data Type	Description
TABLE_CAT	String	The database name.
TABLE_SCHEM	String	The table schema.
TABLE_NAME	String	The table name.
COLUMN_NAME	String	The column name.
DATA_TYPE	Integer	The data type represented by a constant value from java.sql.Types.
TYPE_NAME	String	The data type name used by the driver.
COLUMN_SIZE	Integer	The length in characters of the column or the numeric precision.
BUFFER_LENGTH	Integer	The buffer length.
DECIMAL_DIGITS	Integer	The column scale or number of digits to the right of the decimal point.
NUM_PREC_RADIX	Integer	The radix, or base.
NULLABLE	Integer	Whether the column can contain null as defined by the following JDBC DatabaseMetaData constants: columnNoNulls (0) or columnNullable (1).
REMARKS	String	The comment or note associated with the object.
COLUMN_DEF	String	The default value for the column.
SQL_DATA_TYPE	Integer	Reserved by the specification.
SQL_DATETIME_SUB	Integer	Reserved by the specification.
CHAR_OCTET_LENGTH	Integer	The maximum length of binary and character-based columns.
ORDINAL_POSITION	Integer	The position of the column in the table, starting at 1.
IS_NULLABLE	String	Whether a null value is allowed: YES or NO.
SCOPE_CATALOG	String	The catalog of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SCOPE_SCHEMA	String	The schema of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SCOPE_TABLE	String	The name of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SOURCE_DATA_TYPE	Short	The source type of a distinct type or user-defined `REF` type (null if `DATA_TYPE` is neither `DISTINCT` nor a user-defined `REF`).
IS_AUTOINCREMENT	String	Whether the column value is assigned by SharePoint in fixed increments.
IS_GENERATEDCOLUMN	String	Whether the column is generated: YES or NO.
DTS_TYPE	String	Object DTS attribute type.

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in SharePoint.

try {
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "Events");
    LOGGER.info("\r\n" + resultSet.toString());
    Assertions.assertNotNull(resultSet);
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,KEY_SEQ,PK_NAME
null,null,Events,ID,1,null

The getPrimaryKeys method returns the following columns:

Column Name	Data Type	Description
TABLE_CAT	String	The catalog name.
TABLE_SCHEM	String	The schema name.
TABLE_NAME	String	The name of the table that contains the primary key.
COLUMN_NAME	String	The name of the column that serves as the primary key for the table.
KEY_SEQ	Short	The sequence number within the primary key.
PK_NAME	String	The primary key name.

Connection Settings

Connection Setting	Type	Default Value	Description
ApiThrottleRate	Integer	10	The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second.
AuthenticationType	String	"OAuth"	The current authentication method being used. Refer to the Authentication section for more details.
AuthorizationServerUrl	String	""	The url used for authorization requests.
BaseUrl	string	"https://login.microsoftonline.com"	The URL to be used for the Authentication server. Enable "Use a custom URL" to specify your own authentication server.
CacheExpirationTime	Integer	30	Defines the expiration time for cache. A value of 0 disables caching.
CertificatePassword	String	""	The password used to access the keystore file.
ClientId	String	""	The ClientId used to access SharePoint.
ConcurrentWritingThreads	Integer	1	The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
ConnectionTimeout	Integer	30	ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the SharePoint API.
Domain	String	""	The domain of the SharePoint account that will be used to authenticate requests to the SharePoint API.
DownloadVersionHistory	Boolean	false	You can enable this option in order to retrieve the available versions for each document in your SharePoint Document Library. This feature currently only supports SharePoint Document Libraries but not Lists.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to SharePoint. If certificate verification is not required, you can set this value to 'true'.
IgnoreError	Boolean	false	Determines if the program continues executing SQL statements after encountering an error.
IncludeHiddenFields	Boolean	true	SharePoint uses a number of hidden fields. The IncludeHiddenFields option allows you to specify whether the hidden fields are read and returned.
LogFileSize	String	"10485760"	A string specifying the maximum size in bytes for a log file.
LogLevel	String	"INFO"	The logging level for the JDBC driver.
LogPath	String	"./jdbcLogs"	The directory where log files are stored.
MaxFilesPerListItem	Integer	1	Because a SharePoint list item can contain multiple attachments, the MaxFilesPerListItem option is provided to regulate the maximum number of files to download per list item. If you wish to upload attachments to the SharePoint list items that you create, you can specify the maximum number of attachments per list item to create. Based on the value set for this option, a number of metadata fields for attachment input will be created. Each attachment will have 2 fields designated for it in the format of `Attachment_[Number]_BinaryContent` and `Attachment_[Number]_FileName`.
OAuthType	String	""	The current oauth method being used. Refer to the Authentication section for more details.
OemKey	String	""	The OEM license key.
OAuthType	String	"AuthorizationCode"	The type of OAuth authentication to be used when authenticating requests to the API.
Password	String	""	The Password of the SharePoint account used to authenticate requests to the SharePoint API.
PathToCertificate	String	""	The file path where a certificate is stored.
PathToTokenFile	String	""	The path to the token file.
ProxyMode	String	NoProxy	This setting configures the proxy. Allowed values are "NoProxy", "AutoDetect" and "Manual".
ProxyPassword	String	""	The password to be used to authenticate to the proxy.
ProxyServer	String	""	The host of the proxy server.
ProxyServerPort	Integer	0	The port of the proxy server.
ProxyUsername	String	""	The username to be used to authenticate to the proxy.
ReadBatchSize	Integer	500	ReadBatchSize is used to set how many records can be read from SharePoint in a single call.
RemoveInvalidCharacters	Boolean	false	When enabled, the RemoveInvalidCharacters option will remove any invalid characters that may cause an error response from the SharePoint API.
ResultPath	String	""	The path where the execution result files are saved.
RetryOnIntermittentErrors	Boolean	true	The RetryOnIntermittentErrors parameter indicates whether to retry the connection when it might occasionally fail due to temporary issues.
SaveResult	Boolean	false	The SaveResult parameter indicates whether to save the execution results to a file.
ServerUrl	String	""	The root endpoint of your SharePoint API.
ServiceName	String	""	The ServiceName refers to the name of the service API selected by the user.
ServiceTimeout	Integer	120	The ServiceTimeout is the timeout to receive the full response from SharePoint API.
SessionToken	String	""	Temporary AWS session token.
ShowHiddenSource	Boolean	false	The ShowHiddenSource option, when enabled, allows you to see hidden SharePoint lists and document libraries.
SourceListLibrary	String	""	The SharePoint List or document Library from which data or files will be accessed.
Suppress404NotFoundError	Boolean	true	When set to true, if a query results in an HTTP 404 error, a result set will still be created. When set to false, an error is logged instead and no result set is created.
TenantId	String	""	The Tenant ID used to access SharePoint.
ThrottleRateUnit	String	"PerMinute"	The unit of time for limiting API requests to avoid being throttled. Valid values include, "PerSecond", "PerMinute" and "PerHour".
TokenPassword	String	""	The password used to read the token file.
UseIntegratedAuth	Boolean	false	Whether to authenticate users automatically using their Windows credentials.
UseRecycleBin	Boolean	false	When disabled, deleted items are permanently deleted. If enabled, deleted items are sent to the SharePoint recycle bin.
UserName	String	""	The user name of the SharePoint account that will be used to authenticate requests to the SharePoint API.
WriteBatchSize	Integer	200	WriteBatchSize is used to set how many records can be written to SharePoint in a single call.

SharePoint JDBC Driver

Documentation for Microsoft SharePoint drivers found within JDBC Driver Pack

SharePoint

Building the JDBC URL

General Page

Authentication Methods for SharePoint

Advanced Settings Page

Using the JDBC Driver

Executing Statements

SELECT

INSERT

UPDATE

DELETE

Executing Prepared Statements

SELECT

INSERT

UPDATE

DELETE

Metadata Discovery

Tables

Columns

Primary Keys

Connection Settings