Microsoft Graph
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 a license is not installed, you can still use the connection manager to generate a JDBC URL, but the 'Test Connection' feature will be disabled.
General Page
The General Page of the Microsoft Graph Connection Manager allows you to specify general settings for the connection.
- General Settings
-
- 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.
- Authentication
-
- Authentication Mode
-
The Authentication Mode option allows you to specify the authentication mode when working with the Microsoft Graph service. Available options are:
- Authorization Code
- Certificate
- Client Credentials
Authentication Methods for Microsoft Graph
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.
- 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.
- 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 may be enabled for PKCE App Type. Ensures that the client that initiates the OAuth flow is the same client that completes 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.
- Tenant Id
-
Specify the Tenant Id to be used when establishing the connection to the Microsoft Graph API.
- Client Id
-
Specify the Client Id to be used when establishing the connection to the Microsoft Graph API.
- Path To Certificate
-
The path to an existing certificate file.
- Certificate Password
-
The password for the specified certificate file.
Client Credentials
Users can choose to use their Tenant ID, Client ID and Client Secret to establish a connection.
- Tenant Id
-
Specify the Tenant Id to be used when establishing the connection to the Microsoft Graph API.
- Client Id
-
Specify the Client Id to be used when establishing the connection to the Microsoft Graph API.
- Client Secret
-
The Client Secret option allows you to specify the client secret that will be used when establishing a connection to the Microsoft Graph API.
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.
- 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.
- 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.
- 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.
- Use Beta API
-
When 'Use Beta API' is enabled, requests will be sent to the beta version of the API. Note that the beta API may introduce breaking changes.
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 Microsoft Graph 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. 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, you would then call the getResultSet method of the Statement.
String sql = "SELECT * FROM users WHERE displayName = 'KingswaySoft'"; 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 users (displayName, accountEnabled, passwordProfile-password, mailNickname, userPrincipalName) VALUES ('CreateTest', false, 'password', 'user', '[email protected]')"; try { statement.executeUpdate(sql); LOGGER.info(statement.getResultSet().toString()); } catch (SQLException e) { LOGGER.severe(e.toString()); }
id,errorcode,errormessage,processdata,haserrors 3a9ad36c-5b93-460b-90fb-d5140c8fe4fc,null,null,{"displayName":"CreateTest","accountEnabled":false,"passwordProfile":{"password":"****"},"mailNickname":"user","userPrincipalName":"[email protected]"},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 users SET displayName = 'UpdateTest' WHERE mailNickname = 'user'"; try { statement.executeUpdate(sql); LOGGER.info(statement.getResultSet().toString()); } catch (SQLException e) { LOGGER.severe(e.toString()); }
id,errorcode,errormessage,processdata,haserrors 3a9ad36c-5b93-460b-90fb-d5140c8fe4fc,null,null,{"displayName":"UpdateTest"},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 users WHERE id = 'aea68135-8b59-4ad9-8979-74d8ea673f59'"; try { statement.executeUpdate(sql); LOGGER.info(statement.getResultSet().toString()); } catch (SQLException e) { LOGGER.severe(e.toString()); }
id,errorcode,errormessage,processdata,haserrors aea68135-8b59-4ad9-8979-74d8ea673f59,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:
- 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 Statement: Use the generic execute or executeUpdate method of the PreparedStatement.
- Retrieve Results: Call the getResultSet method of the Prepared Statement 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 Statement 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 users WHERE displayName = ?"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "test1"); ps.execute(query); 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 Statement 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 users (displayName, accountEnabled, passwordProfile-password," + "mailNickname, userPrincipalName) VALUES (?, ?, ?, ?, ?)"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "test1"); ps.setBoolean(2, true); ps.setString(3, "Password1!"); ps.setString(4, "user"); ps.setString(5, "[email protected]"); ps.executeUpdate(); LOGGER.info(ps.getResultSet().toString()); } catch (SQLException e) { LOGGER.error(e); }
id,errorcode,errormessage,processdata,haserrors 17c77bb2-f827-4991-92b9-d50334bb9313,null,null,{"displayName":"test1","accountEnabled":true,"passwordProfile":{"password":"****"},"mailNickname":"user","userPrincipalName":"[email protected]"},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. 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 users SET displayName = ? WHERE mailNickname = ?"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "test1"); ps.setString(2, "user"); ps.executeUpdate(); LOGGER.info(ps.getResultSet().toString()); } catch (SQLException e) { LOGGER.error(e); }
id,errorcode,errormessage,processdata,haserrors 17c77bb2-f827-4991-92b9-d50334bb9313,null,null,{"displayName":"test1"},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 users WHERE displayName = ? AND mailNickname = ?"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "test1"); ps.setString(2, "user"); ps.executeUpdate(); LOGGER.info(ps.getResultSet().toString()); } catch (SQLException e) { LOGGER.error(e); }
id,errorcode,errormessage,processdata,haserrors 17c77bb2-f827-4991-92b9-d50334bb9313,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 to retrieve a list of 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,admin/edge,Table, null,null,admin/microsoft365Apps,Table, null,null,admin/people,Table, ......
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 name. |
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 the columns in the database. To narrow your search to a specific table, specify the table name as a parameter.
try { Connection connection = buildRestConnectionFromDriverManager(); ResultSet rs = connection.getMetaData().getColumns(null, null, "users", 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,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE null,null,users,aboutMe,12,java.lang.String,4000,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR null,null,users,accountEnabled,16,java.lang.Boolean,0,null,0,0,null,null,null,16,null,null,null,null,null,null,DT_BOOL null,null,users,ageGroup,12,java.lang.String,4000,null,0,0,null,null,null,12,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. |
IS_AUTOINCREMENT | String | Whether the column value is assigned by Microsoft Graph in fixed increments. |
IS_GENERATEDCOLUMN | String | Whether the column is generated: YES or NO. |
DTS_TYPE | String | Microsoft Graph 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 Graph.
try { Connection connection = buildRestConnectionFromDriverManager(); ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "users"); LOGGER.info("\r\n" + resultSet.toString()); Assertions.assertNotNull(resultSet); } catch (SQLException e) { LOGGER.severe(e.getMessage()); }
TABLE_NAME,PRIMARY_COLUMN_NAME users,id
The getPrimaryKeys method returns the following columns:
Column Name | Data Type | Description |
---|---|---|
TABLE_NAME | String | The name of the table that contains the primary key. |
PRIMARY_COLUMN_NAME | String | The name of the column that serves as the primary key for the table. |
Advanced Features
Additional Bindings
The Statement class's generic execute method and the executeQuery method can both be used to retrieve additional binding entity data. Additional binding entity names are delimited by a slash '/' whereas field names are delimited by a hyphen '-'.
SELECT
To retrieve the results of a query with additional bindings replace the table name with the format entity/binding. To retrieve the results of the additional binding of a specific entity, include a condition with entity-id.
String sql = "SELECT * FROM users/activities WHERE users-id = '12718fb4-a96c-4b39-a9d4-300698b5e11b'";
INSERT
To insert data to an entities additional binding, replace the table name with the format entity/binding. 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 employeeExperience/communities (displayName, description, privacy) VALUES ('Financial Advice', 'A community', 'public')";
UPDATE
To update data of an additional binding, replace the table name with the format entity/binding. 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 users/activities SET appDisplayName = 'displayName' WHERE id = '8b63a512-0f3f-490a-b8ae-5573707b317f' AND users-id = '12718fb4-a96c-4b39-a9d4-300698b5e11b'";
DELETE
To delete data of an additional binding, replace the table name with the format entity/binding. 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 me/events WHERE id = 'AAMkADcwYzYzN2E0LWE3ZDAtNDZkNC1iMTgzLTBiYjZkZjRlMjA4MQBGAAAAAABGl4gUpQOyRK_OOmJeGiQvBwDyuqrqs_18T6TNXsk_yJmJAAAAAAENAADyuqrqs_18T6TNXsk_yJmJAABbDNTuAAA='";
Connection Settings
Connection Setting | Type | Default Value | Description |
---|---|---|---|
AccessToken | String | "" | The AccessToken is used to authenticate access to Microsoft Graph. |
AuthenticationMode | String | "AuthorizationCode" | AuthenticationType specifies the method used to authenticate when connecting to Microsoft Graph RESTful API. |
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. |
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 Graph. |
ClientSecret | String | "" | The ClientSecret used to access Microsoft Graph. |
ConnectionTimeout | Integer | 30 | ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the Microsoft Graph API. |
IgnoreCertificateErrors | Boolean | false | Specifies whether to verify the certificate when connecting to Microsoft Graph. 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. |
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. |
OemKey | String | "" | The OEM License key. |
OmitSelectParameter | Boolean | false | OmitSelectParameter specifies whether to include the $select parameter when reading from Microsoft Graph. |
Password | String | "" | The password used to authenticate the user. |
PathToCertificate | String | "" | PathToCertificate specifies the file path where the keystore file for connecting to Microsoft Graph RESTful API is located. |
PathToTokenFile | String | "" | The path to the token file. |
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. |
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'. |
ReadBatchSize | Integer | 100 | ReadBatchSize is used to set how many records can be read from Microsoft Graph in a single call. In Microsoft Graph, a value of 0 will result in the $top parameter not to be included in requests. |
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 Graph. |
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 Graph API. The default timeout is 120 seconds. |
Ssl | Boolean | false | SSL indicates whether the connection is SSL-enabled or supports SSL encryption. |
TenantId | String | "" | The Azure Tenant ID used to access Microsoft Graph. |
TotalThreads | Integer | 0 | The number of threads for executing operations in parallel. A value of 0 will disable multi threading. |
UseBetaApi | Boolean | false | The UseBetaApi parameters indicates whether to use /beta or /v1.0. By default, it is set to 'false', meaning that connections use the v1.0 API. |
UserName | String | "" | The user account used to connect to the server. |
WriteBatchSize | Integer | 20 | WriteBatchSize is used to set how many records can be written to Microsoft Graph in a single call. |