Google Classroom

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.

connectionmanage

There are two ways to connect to Google Classroom:

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.

Service Account

A Google JSON token file can be used 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 Google Classroom 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 retrieve the results of a query, you would then call the getResultSet method of the Statement.

String sql = "SELECT * FROM courses";
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 courses (name, section,descriptionHeading,description,room,ownerId,courseState) "
		+ "VALUES ('Insert Test', 'Period 2', 'Introduction to JDBC', 'JDBC DESC', 'Room 207', 'me', 'PROVISIONED')";
try {
	statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata
735151836982,null,null,{"courseState":"PROVISIONED","name":"Insert Test","description":"JDBC DESC","section":"Period 2","ownerId":"me","room":"Room 207","descriptionHeading":"Introduction to JDBC"}

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 courses SET name = 'JdbcUpdateTest', description = 'update test' WHERE id = '735094436803'";
try {
	statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata
735094436803,null,null,{"name":"JdbcUpdateTest","description":"update test"}

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 courses_announcements WHERE id = '721840652215' AND courseId = '721840042580'";
try {
	statement.executeUpdate(sql);
	LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata
null,null,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:

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 sqlIn = "SELECT * FROM courses WHERE id = ?";
try {
	PreparedStatement ps = connection.prepareStatement(sqlIn);
	ps.setString(1, "735518507014");

	boolean ret = ps.execute(sqlIn);
	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 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 courses (name, section,descriptionHeading,description,room,ownerId,courseState) "
		+ "VALUES (?,?,?,?,?,?,?)";
try {
	Connection connection = buildRestConnectionFromDriverManager();
	PreparedStatement ps = connection.prepareStatement(sql);
	ps.setString(1, "Insert Test");
	ps.setString(2, "Period 2");
	ps.setString(3, "Introduction to JDBC");
	ps.setString(4, "JDBC DESC");
	ps.setString(5, "Room 207");
	ps.setString(6, "me");
	ps.setString(7, "PROVISIONED");
	ps.executeUpdate();

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

id,errorcode,errormessage,processdata
735518991710,null,null,{"courseState":"PROVISIONED","name":"Insert Test","description":"JDBC DESC","section":"Period 2","ownerId":"me","room":"Room 207","descriptionHeading":"Introduction to JDBC"}

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 courses SET description = ? WHERE id = ?";
try {
	Connection connection = buildRestConnectionFromDriverManager();
	PreparedStatement ps = connection.prepareStatement(sql);
	ps.setString(1, "override update");
	ps.setString(2, "735518991710");
	ps.executeUpdate();
	
	LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
	LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata
735518991710,null,null,{"description":"override update"}

DELETE

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

String deleteSql = "DELETE FROM courses_announcements WHERE id = ? and courseId = ?";
try {
	Connection connection = buildRestConnectionFromDriverManager();
	PreparedStatement ps = connection.prepareStatement(deleteSql);
	ps.setString(1, "721848826137");
	ps.setString(2, "721840042580");
	ps.executeUpdate();
	LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
	e.printStackTrace();
}

id,errorcode,errormessage,processdata
null,null,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 can be used 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,courses,Table,
null,null,courses_aliases,Table,
null,null,courses_announcements,Table,
null,null,courses_announcements_addOnAttachments,Table,
null,null,courses_courseWork,Table,
null,null,courses_courseWorkMaterials,Table,
null,null,courses_courseWorkMaterials_addOnAttachments,Table,
null,null,courses_courseWork_addOnAttachments,Table,
null,null,courses_courseWork_addOnAttachments_studentSubmissions,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, "courses", 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,courses,alternateLink,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,calendarId,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,courseGroupEmail,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,courseMaterialSets,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,courseState,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,creationTime,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,description,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,descriptionHeading,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,courses,enrollmentCode,12,java.lang.String,0,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 Google Classroom 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 Google Classroom.

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

TABLE_NAME,PRIMARY_COLUMN_NAME
courses,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.

Connection Settings

Connection Setting	Type	Default Value	Description
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	""	AuthenticationType specifies the method used to authenticate when connecting to Google Classroom API.
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.
ConnectionTimeout	Integer	30	ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the Google Classroom API.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to Google Classroom. 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.
PathToTokenFile	String	""	The TokenPath specifies the file path where the token for connecting to Google Classroom is located.
PathToJsonPrivateKeyFile	String	""	The JsonKeyPath specifies the file path where the JSON key for connecting to Google Classroom is located.
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	100	ReadBatchSize is used to set how many records can be read from Google Classroom in a single call.
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.
ServiceAccount	String	""	The ServiceAccount refers to the account used for accessing Google APIs.
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 Google Classroom API.
TokenPassword	String	""	The password used to read the token file.
TotalThreads	Integer	0	The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
WriteBatchSize	Integer	200	WriteBatchSize is used to set how many records can be written to Google Classroom in a single call.

Help Manual

Google Classroom Connectivity

Documentation for Google Classroom drivers found within JDBC Driver Pack

Google Classroom

Building the JDBC URL

OAuth Authorization Code

Service Account

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

Cookie Settings

Google Classroom

Building the JDBC URL

OAuth Authorization Code

Service Account

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