Microsoft Teams

Building the JDBC URL

After installing the license, open the connection management page by running java -jar kingswaysoft.jdbc.jar. Enter the required details to generate the JDBC connection URL. Click Test Connection to test the generated URL, or Copy to Clipboard to copy the connection string for use in your application.

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 of the Microsoft Teams Connection Manager allows you to specify general settings for the connection.

connectionmanage

General Settings

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

Authentication

Authentication Mode

The Authentication Mode option allows you to specify the authentication mode when working with the Microsoft Teams service. Available options are:

Authorization Code
Client Credentials
Certificate

Authentication Methods for Microsoft Teams

Select the authentication method you would like to use and enter valid details for required fields.

You may also specify a custom Authentication Server(URL) to use. Generally this is not needed, but in the event your online instance is using some special authentication flow, you can enter a custom URL. This is stored as the connection property BaseUrl.

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 specified token password to connect.

Path To Token File

The path to the token file on the file system.

Token File Password

The Password for the token file.

Generate Token File

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

Tenant ID: The Tenant ID is a unique identifier for a specific customer or organization within a multi-tenant software system.
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.
Redirect URL: The Redirect URL option allows you to specify the Redirect URL to complete the authentication process.
Scope: The Scope option allows you to specify the scope of the token file being generated.
PKCE (Enhanced Security): The PKCE (Proof Key for Code Exchange) option can be enabled for a PKCE app type. It ensures that the client that initiates the OAuth flow is the same client that completes the flow.

Client Credentials

Use your Tenant ID, Client ID and Client Secret to establish a connection when using Client Credentials authentication.

Tenant ID: The Tenant ID is the unique identifier representing your Azure Active Directory tenant.
Client ID: The Client ID is a unique identifier assigned to your app, it identifies the application itself when requesting access to the Microsoft Teams API.
Client Secret: The Client Secret allows you to specify the client secret that will be used along with the client id to establish a connection to Microsoft Teams using Microsoft Graph API.

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.

Tenant ID: Specify the Tenant ID representing your Azure Active Directory tenant to be used when establishing the connection to the Microsoft Teams API.
Client ID: The Client ID is a unique identifier assigned to your app, it identifies the application itself when requesting access to the Microsoft Teams API.
Path To Certificate: The path to an existing certificate file.
Certificate Password: The password for the specified certificate file.

Test Connection

After completing the configuration for all required connection and authentication settings in the JDBC Connection Manager, you can use the Test Connection button to validate your configuration and verify API requests will authenticate successfully.

Advanced Settings Page

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

connectionmanage

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

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 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.

Max Metadata Depth

This options specifies the depth to which object type fields should be broken down to. A value of 0 causes objects not to be broken down to their child fields. For example, for the object type field calendar, a value of 0 will not break down this object to its child fields. A value of 1 will break it down 1 level, causing calendar to be broken down into its child fields like calendar.id and calendar.allowedOnlineMeetingProviders. Larger values have a potential to cause performance impacts, based on the table being queried.

API Settings

Omit $select Parameter: When 'Omit $select Parameter' is enabled, the requests sent by the driver will not include the query parameter $select, causing all fields to be included in the response from the API. Note that the fields that are output in the result set will still only include the fields you've input into your query.

Using the JDBC Driver

This section provides examples that use JDBC classes such as Connection, Statement, and ResultSet to manage interactions with Microsoft Teams data. It covers regular statements and prepared statements for complex or frequently executed queries.

Executing Statements

After you have connected from your code, you can execute SQL statements using the Statement class. For connection details, see Connecting with DriverManager or Connecting with DataSource. For parameterized statements, see Executing Prepared Statements. Refer to the Additional Bindings section for information on how to execute SQL statements for additional binding entities.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data. To retrieve the results of a query, call the getResultSet method of the Statement.

String sql = "SELECT * FROM groups WHERE id = 'c2e43671-f154-461e-a8f0-2e06eed68bec'";
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.

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 groups (displayName, mailNickname, mailEnabled, securityEnabled) VALUES ('Group 1', 'user', false, true)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
c2e43671-f154-461e-a8f0-2e06eed68bec,null,null,{"displayName":"Group 1","mailNickname":"user","mailEnabled":false,"securityEnabled":true},false

UPDATE

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

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 groups SET description = 'Update Description' WHERE id = 'c2e43671-f154-461e-a8f0-2e06eed68bec'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
c2e43671-f154-461e-a8f0-2e06eed68bec,null,null,{"description":"Update Description"},false

DELETE

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

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 groups WHERE id = 'c2e43671-f154-461e-a8f0-2e06eed68bec'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
c2e43671-f154-461e-a8f0-2e06eed68bec,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

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

String sql = "UPSERT INTO groups (uniqueName, displayName, mailEnabled, mailNickname, securityEnabled, description) VALUES "
           + "('NewGroup1', 'NewGroup_1', false, 'NewGroup', true, 'Group_Description')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors,isnew
bc64f51a-549a-47f8-8a94-e09a57f2518f,null,null,{"displayName":"NewGroup_1","mailEnabled":false,"mailNickname":"NewGroup","securityEnabled":true,"description":"Group_Description"},false,true

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 Statement class.

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.

For connection details, see Connecting with DriverManager or Connecting with DataSource.

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 are 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, use 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.

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 groups WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "c2e43671-f154-461e-a8f0-2e06eed68bec");
    ps.execute();
    while (ps.getResultSet().next()) {
        for (int i = 1; i <= ps.getResultSet().getMetaData().getColumnCount(); i++) {
            LOGGER.info(ps.getResultSet().getMetaData().getColumnLabel(i) + "="
            + ps.getResultSet().getString(i));
        }
    }
} catch (SQLException e) {
    LOGGER.error(e);
}

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. You 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 groups (displayName, mailNickname, mailEnabled, securityEnabled) VALUES (?, ?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "Group 1");
    ps.setString(2, "user");
    ps.setBoolean(3, false);
    ps.setBoolean(4, true);
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
c2e43671-f154-461e-a8f0-2e06eed68bec,null,null,{"displayName":"Group 1","mailNickname":"user","mailEnabled":false,"securityEnabled":true},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. You 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 groups SET description = ? WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "Update Description");
    ps.setString(2, "c2e43671-f154-461e-a8f0-2e06eed68bec");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
c2e43671-f154-461e-a8f0-2e06eed68bec,null,null,{"description":"Update Description"},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 groups WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "c2e43671-f154-461e-a8f0-2e06eed68bec");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
c2e43671-f154-461e-a8f0-2e06eed68bec,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

String sql = "UPSERT INTO groups (uniqueName, displayName, mailEnabled, mailNickname, securityEnabled, description) VALUES "
           + "(?, ?, ?, ?, ?, ?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "NewGroup1");
	ps.setString(2, "NewGroup_1");
    ps.setBoolean(3, false);
    ps.setString(4, "NewGroup");
	ps.setBoolean(5, true);
	ps.setString(6, "Group_Description");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors,isnew
bc64f51a-549a-47f8-8a94-e09a57f2518f,null,null,{"displayName":"NewGroup_1","mailEnabled":false,"mailNickname":"NewGroup","securityEnabled":true,"description":"Group_Description"},false,true

Expanding Response fields

When performing a SELECT query that does not specify the columns to select, some tables will output NULL for certain fields, unless those fields were explicitly defined in the query.

This is expected API behavior. The API expects an $expand parameter to be sent with the request which specifies which fields to expand (to include) in the response.

For example, the below query specifies the memberOf column in the query. By default this field is not included in the response, however when defined in the query, it will automatically be added to the $expand parameter of the request, ensuring it is returned in the response.

Note that adding numerous expand fields could have a performance impact as the API will return more data.

String sql = "SELECT id, displayName, memberOf FROM groups";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

USING OPTIONS Support

The Excel driver supports query-level USING OPTIONS (...) clauses for both read and write scenarios. These options affect only the current SQL statement.

SELECT USING OPTIONS

Use query-level read options to adjust how the driver interprets the source file.

The same clause can also be used with a PreparedStatement. Bind your parameters first, then call executeQuery() without passing the SQL string again.

Optionally, you can also override connection properties in queries by adding USING OPTIONS({optionName}={value})

For example, to override the property OmitSelectParameter for a specific query when it is set to true in the connection string.

Option	Type	Default	Description
OmitExpandParameter	Boolean	false	Whether or not to omit the $expand parameter from the query.
OmitTopParameter	Boolean	false	Whether or not to omit the $top parameter from the query.

String sql = "SELECT id, name FROM groups WHERE id = 'c2e43671-f154-461e-a8f0-2e06eed68bec' "
           + "USING OPTIONS(OmitExpandParameter=true)";
try (ResultSet resultSet = statement.executeQuery(sql)) {
    while (resultSet.next()) {
        LOGGER.info(resultSet.getString("id") + "," + resultSet.getString("name"));
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

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 that includes write-only tables, query the table system.tables.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    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,chats/messages,TABLE,null,null,null,null,null,null
null,null,chats/messages/hostedImages,TABLE,null,null,null,null,null,null
null,null,groups,TABLE,null,null,null,null,null,null
null,null,groups/checkMemberGroups,TABLE,null,null,null,null,null,null
null,null,groups/getMemberGroups,TABLE,null,null,null,null,null,null
null,null,groups/getMemberObjects,TABLE,null,null,null,null,null,null
null,null,groups/members,TABLE,null,null,null,null,null,null
null,null,groups/owners,TABLE,null,null,null,null,null,null
null,null,me/chats/messages,TABLE,null,null,null,null,null,null
null,null,me/joinedTeams,TABLE,null,null,null,null,null,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.

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

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

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "groups", 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,groups,allowExternalSenders,16,BOOLEAN,null,null,0,0,null,null,null,16,null,null,null,null,null,null,null,null,null,null,DT_BOOL
null,null,groups,assignedLabels,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,groups,assignedLicense,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,groups,autoSubscribeNewMembers,16,BOOLEAN,null,null,0,0,null,null,null,16,null,null,null,null,null,null,null,null,null,null,DT_BOOL
null,null,groups,classification,12,VARCHAR,255,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,groups,createdDateTime,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,groups,description,12,VARCHAR,255,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,groups,displayName,12,VARCHAR,255,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,groups,expirationDateTime,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,groups,groupTypes,12,VARCHAR,255,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 Microsoft Teams in fixed increments.
IS_GENERATEDCOLUMN	String	Whether the column is generated: YES or NO.
DTS_TYPE	String	Microsoft Teams attribute type.

Primary Keys

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

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

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,KEY_SEQ,PK_NAME
null,null,groups,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
AccessToken	String	""	The AccessToken is used to authenticate access to Microsoft Teams.
ApiThrottleRate	Integer	0	The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second.
AuthenticationMode	String	"AuthorizationCode"	AuthenticationType specifies the method used to authenticate when connecting to Microsoft Teams RESTful API.
BaseUrl	String	"https://login.microsoftonline.com"	Specify the authorization server to be used when authenticating.
BatchSizeForReading	Integer	100	BatchSizeForReading is used to set how many records can be read from Microsoft Teams in a single call. In Microsoft Teams, a value of 0 will result in the $top parameter not to be included in requests.
BatchSizeForWriting	Integer	20	BatchSizeForWriting is used to set how many records can be written to Microsoft Teams in a single call.
BulkPollingInterval	Integer	5	How often the component checks the job status until the job status is COMPLETE.
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 Microsoft Teams.
ClientSecret	String	""	The ClientSecret used to access Microsoft Teams.
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 Microsoft Teams API.
ContinueOnErrors	Boolean	false	Determines if the program continues executing SQL statements after encountering an error.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to Microsoft Teams. If certificate verification is not required, you can set this value to 'true'.
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.
MaxMetadataDepth	Integer	1	This options specifies the depth to which object type fields should be broken down to. A value of 0 causes objects not to be broken down to their child fields. For more information, see the Miscellaneous Settings of the Advanced Settings page section.
OemKey	String	""	The OEM license key.
OmitSelectParameter	Boolean	false	OmitSelectParameter specifies whether to include the $select parameter when reading from Microsoft Teams.
Password	String	""	The password used to authenticate the user.
PathToCertificate	String	""	PathToCertificate specifies the file path where the keystore file for connecting to Microsoft Teams RESTful API is located.
PathToTokenFile	String	""	The path to the token file.
ProxyMode	String	NoProxy	The strategy employed to address proxy usage. Strategies are case-sensitive and include "NoProxy" which will not use a proxy, "AutoDetect" which will attempt to use the system configured proxy, and "Manual" which will use the proxy set through ProxyServer and ProxyServerPort. By default, it is set to 'NoProxy'.
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.
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 URL for connecting to Microsoft Teams.
ServiceEndpoint	String	""	The ServiceEndpoint is where clients can send requests to interact with the service, retrieve data, or perform operations.
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 Microsoft Teams API. The default timeout is 120 seconds.
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 Azure Tenant ID used to access Microsoft Teams.
TokenPassword	String	""	The password used to read the token file.
UserName	String	""	The user account used to connect to the server.

Microsoft Teams JDBC Driver

Documentation for Microsoft Teams drivers found within JDBC Driver Pack

Microsoft Teams

Building the JDBC URL

General Page

Authentication Methods for Microsoft Teams

Advanced Settings Page

Using the JDBC Driver

Executing Statements

SELECT

INSERT

UPDATE

DELETE

UPSERT

Executing Prepared Statements

SELECT

INSERT

UPDATE

DELETE

UPSERT

Expanding Response fields

USING OPTIONS Support

SELECT USING OPTIONS

Metadata Discovery

Tables

Columns

Primary Keys

Connection Settings