RingCentral

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 allows you to specify connection properties and login credentials for the RingCentral REST service:

connectionmanage

General Settings

InstanceType

The InstanceType option allows you to choose the environment to connect to.

Production
Sandbox

API Throttling Rate: The API Throttling Rate option 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 choose the method used to authenticate with the API. Available options are:

Authorization Code
JWT

Account ID: The Account ID is the unique identifier of your RingCentral account. Set this value to "~" to refer to the current authenticated user.

Extension ID: The Extension ID is the specific user/extension within the account. Set this value to "~" to refer to the current authenticated user.

Authentication Methods for RingCentral

Authorization Code

A pre-existing token can be used to establish a connection. If you wish to generate a new authentication token, click Generate Token to go through the token generation process. You can use the generated access token to connect.

Authentication

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.

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 for the token file.

Generate Token File

This button completes the OAuth authentication process 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.
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.

JWT

Use a JWT (JSON Web Token) together with ClientId and ClientSecret to authenticate using the JWT OAuth flow to establish a connection.

Authentication

Client ID: The application's public identifier used by RingCentral.
Client Secret: The application's private credential issued by RingCentral.
JWT: The Password for the token 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 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.

Bulk Polling Interval (secs)

This value controls how often (in seconds) the driver polls RingCentral to check the status of bulk operations.

Using the JDBC Driver

This section provides examples that use JDBC classes such as Connection, Statement, and ResultSet to manage interactions with RingCentral 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.

To improve performance when executing multiple write queries, use the batch feature. For more information, see Batch Writing with PreparedStatement.

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 chats/posts WHERE chatId = '158277918726'";
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 chats/posts (chatId, text) VALUES ('158277918726', 'Jdbc Text Insert')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
78196036403204,null,null,{"text":"Jdbc Text Insert"},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 chats/posts SET text = 'Jdbc Text Update' WHERE chatId = '158277918726' AND postId = '78196036403204'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
78196036403204,null,null,{"text":"Jdbc Text Update"},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 chats/posts WHERE chatId = '158277918726' AND postId = '78196036403204'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
null,null,null,{chatId=158277918726, postId=78196036403204},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 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 chats/posts WHERE chatId = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "158277918726");
    ps.execute(sql);
    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 chats/posts (chatId, text) VALUES (?, ?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "158277918726");
    ps.setString(2, "Jdbc Text Insert");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
78196036403204,null,null,{"text":"Jdbc Text Insert"},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 chats/posts SET text = ? WHERE chatId = ? AND postId = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "Jdbc Text Update");
    ps.setString(2, "158277918726");
    ps.setString(3, "78196036403204");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
78196036403204,null,null,{"text":"Jdbc Text Update"},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 chats/posts WHERE chatId = ? AND postId = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "158277918726");
    ps.setString(2, "78196036403204");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
null,null,null,{chatId=158277918726, postId=78196036403204},false

Query Options

The driver provides a query-level option that let you fine-tune execution for better performance and accuracy.

Append USING OPTIONS (...) to your SQL statement to enable the specified option.

The following options are available for use:

Option Name	Description
ReturnNextSyncToken	A sync token is a piece of data exchanged between the server and the client, and has a critical role in the synchronization process. When included as a query option, the response will contain a syncToken which can be output in the result set.

ReturnNextSyncToken Example

When ReturnNextSyncToken is used, the driver returns the query data in the first result set and the syncToken in an additional result set. Use statement.execute(...) to run the query, then call statement.getMoreResults() to read the next result set.

String sql = "SELECT id, email FROM account/extension/address-book-sync USING OPTIONS ('ReturnNextSyncToken')";
try {
    boolean hasResults = statement.execute(sql);
    int resultSetIndex = 0;

    while (hasResults) {
        ResultSet resultSet = statement.getResultSet();
        LOGGER.info("Result set #" + (++resultSetIndex));

        while (resultSet.next()) {
            for (int i = 1; i <= resultSet.getMetaData().getColumnCount(); i++) {
                LOGGER.info(resultSet.getMetaData().getColumnLabel(i) + "="
                + resultSet.getString(i));
            }
        }

        hasResults = statement.getMoreResults();
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

The first result set contains the requested account/extension/address-book-sync records. If RingCentral returns a sync token, the next result set contains a single column named syncToken.

The same pattern applies when using a PreparedStatement.

String sql = "SELECT id, email FROM account/extension/address-book-sync USING OPTIONS ('ReturnNextSyncToken')";
try {
    PreparedStatement ps = connection.prepareStatement(sql);

    boolean hasResults = ps.execute();
    int resultSetIndex = 0;

    while (hasResults) {
        ResultSet resultSet = ps.getResultSet();
        LOGGER.info("Result set #" + (++resultSetIndex));

        while (resultSet.next()) {
            for (int i = 1; i <= resultSet.getMetaData().getColumnCount(); i++) {
                LOGGER.info(resultSet.getMetaData().getColumnLabel(i) + "="
                + resultSet.getString(i));
            }
        }

        hasResults = ps.getMoreResults();
    }
} 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,.well-known/openid-configuration,Table,null
null,null,account,Table,null
null,null,account/a2p-sms/batches,Table,null
null,null,account/a2p-sms/messages,Table,null
null,null,account/a2p-sms/statuses,Table,null
null,null,account/active-calls,Table,null
null,null,account/address-book-bulk-upload/tasks,Table,null
null,null,account/answering-rule,Table,null
null,null,account/assigned-role,Table,null
null,null,account/business-address,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 write-only tables, query the table system.columns.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "chats", 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,chats,creationTime,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,chats,description,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,chats,id,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,chats,lastModifiedTime,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,chats,members,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,chats,name,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,chats,public,16,BOOLEAN,null,null,0,0,null,null,null,16,null,null,null,null,null,null,DT_BOOL
null,null,chats,status,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,chats,type,12,VARCHAR,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 RingCentral 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 RingCentral.

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

TABLE_NAME,PRIMARY_COLUMN_NAME
chats,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
AccountId	String	"`~`"	The unique identifier of your RingCentral account. Default value of "`~`" to automatically use the authenticated account.
ApiThrottleRate	Integer	10	The maximum number of API requests a client can make to the server within a specific time period, defined in the ThrottleRateUnit setting.
AuthenticationMode	String	"AuthorizationCode"	AuthenticationMode specifies the method used to authenticate when connecting to RingCentral API.
BulkPollingInterval	Integer	5	Controls how often (in seconds) the driver polls RingCentral to check bulk operation status.
CacheExpirationTime	Integer	30	Defines the expiration time for cache. A value of 0 disables caching.
ClientId	String	""	A unique identifier for the application or client making requests to an API.
ClientSecret	String	""	A secret key used with the ClientId to authenticate a client in OAuth.
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 RingCentral API.
ExtensionId	String	"currentId (`~`)"	The specific user/extension within the account. Default value of "`~`" to refer to the current authenticated user.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to RingCentral. If certificate verification is not required, you can set this value to 'true'.
ContinueOnErrors	Boolean	false	Determines if the program continues executing SQL statements after encountering an error.
InstanceType	String	"Production"	Specifies which RingCentral environment to connect to.
Jwt	String	""	A JSON Web Token used together with ClientId and ClientSecret to authenticate using the JWT OAuth flow.
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 file path where a token is stored.
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	1000	ReadBatchSize is used to set how many records can be read from RingCentral 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.
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 RingCentral API.
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.
ThrottleRateUnit	String	"PerSecond"	The unit of time for limiting API requests to avoid being throttled. Valid values include, "PerSecond", "PerMinute" and "PerHour".
TokenPassword	String	""	A password associated with the token used for encryption and decryption.
WriteBatchSize	Integer	1	WriteBatchSize is used to set how many records can be written to RingCentral in a single call.

RingCentral JDBC Driver

Documentation for RingCentral drivers found within JDBC Driver Pack

RingCentral

Building the JDBC URL

General Page

Authentication Methods for RingCentral

Advanced Settings Page

Using the JDBC Driver

Executing Statements

SELECT

INSERT

UPDATE

DELETE

Executing Prepared Statements

SELECT

INSERT

UPDATE

DELETE

Query Options

ReturnNextSyncToken Example

Metadata Discovery

Tables

Columns

Primary Keys

Connection Settings