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.

There are three ways to connect to 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.

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.

Client Credentials

Users can choose to use their Tenant ID, Client ID and Client Secret to establish a connection.

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
3a9ad36c-5b93-460b-90fb-d5140c8fe4fc,null,null,{"displayName":"CreateTest","accountEnabled":false,"passwordProfile":{"password":"****"},"mailNickname":"user","userPrincipalName":"[email protected]"}

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
3a9ad36c-5b93-460b-90fb-d5140c8fe4fc,null,null,{"displayName":"UpdateTest"}

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
aea68135-8b59-4ad9-8979-74d8ea673f59,null,null,{}

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:

1. 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.
2. Set Parameters: Declare parameters by calling the corresponding setter method of the PreparedStatement. Note: The parameter indices start at 1.
3. Execute the Statement: Use the generic execute or executeUpdate method of the PreparedStatement.
4. Retrieve Results: Call the getResultSet method of the Prepared Statement to obtain the query results, which will be returned as a ResultSet.
5. 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
17c77bb2-f827-4991-92b9-d50334bb9313,null,null,{"displayName":"test1","accountEnabled":true,"passwordProfile":{"password":"****"},"mailNickname":"user","userPrincipalName":"[email protected]"}

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
17c77bb2-f827-4991-92b9-d50334bb9313,null,null,{"displayName":"test1"}

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
17c77bb2-f827-4991-92b9-d50334bb9313,null,null,{}

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables and getColumns 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:

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:

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:

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