Crelate
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 allows you to specify connection properties and login credentials for the Crelate REST service:
- 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 Methods for Crelate
API Token Authentication
Users can authenticate by providing their Crelate API endpoint URL along with their unique API Token to verify and authorize API access.
- Base URL
-
The Base URL of the Crelate instance that will be connected to.
- API Token
-
The API token for the account to be used to connect to your Crelate instance.
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.
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 Crelate 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 activities WHERE ids IN ('b5f7b8df-ae3c-487e-4210-b7acfe48dc08', 'ebf71795-4957-44f7-43b3-0c705844dc08')"; 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 companies (Name, Description) VALUES ('nameInsert', 'Insert Description Text')"; try { statement.executeUpdate(sql); LOGGER.info(statement.getResultSet().toString()); } catch (SQLException e) { LOGGER.severe(e.toString()); }
id,errorcode,errormessage,processdata,haserrors 9592ec16-9d4a-4991-5d6f-78aa330edd08,null,null,{"entity":{"Name":"nameInsert","Description":"Insert Description Text"}},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 activities SET Display = 'nameUpdate' WHERE Id = 'c7f903d8-2d58-40c9-56a8-a8c61d0bdd08'"; try { statement.executeUpdate(sql); LOGGER.info(statement.getResultSet().toString()); } catch (SQLException e) { LOGGER.severe(e.toString()); }
id,errorcode,errormessage,processdata,haserrors c7f903d8-2d58-40c9-56a8-a8c61d0bdd08,null,null,{"entity":{"Name":"nameUpdate"}},false
DELETE
Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.
Deleted records aren't deleted permanently from Crelate, but they are placed in the Recycle Bin for 15 days from where they can be restored.
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 activities WHERE Id = '7be93970-c7e3-4b40-2700-3d0a2a0edd08'"; try { statement.executeUpdate(sql); LOGGER.info(statement.getResultSet().toString()); } catch (SQLException e) { LOGGER.severe(e.toString()); }
id,errorcode,errormessage,processdata,haserrors 7be93970-c7e3-4b40-2700-3d0a2a0edd08,null,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 companies WHERE names IN (?, ?)"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "nameInsert"); ps.setString(2, "nameUpdate"); 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 companies (Name, Description) VALUES (?, ?)"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "nameInsert"); ps.setString(2, "Insert Description Text"); ps.executeUpdate(); LOGGER.info(ps.getResultSet().toString()); } catch (SQLException e) { LOGGER.error(e); }
id,errorcode,errormessage,processdata,haserrors 9592ec16-9d4a-4991-5d6f-78aa330edd08,null,null,{"entity":{"Name":"nameInsert","Description":"Insert Description Text"}},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 companies SET Name = ? WHERE Id = ?"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "nameUpdate"); ps.setString(2, "c7f903d8-2d58-40c9-56a8-a8c61d0bdd08"); ps.executeUpdate(); LOGGER.info(ps.getResultSet().toString()); } catch (SQLException e) { LOGGER.error(e); }
id,errorcode,errormessage,processdata,haserrors c7f903d8-2d58-40c9-56a8-a8c61d0bdd08,null,null,{"entity":{"Name":"nameUpdate"}},false
DELETE
Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.
After a record is deleted, it is placed in the Recycle Bin for 15 days, after which it will be unrestorable.
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 companies WHERE Id = ?"; try { PreparedStatement ps = connection.prepareStatement(sql); ps.setString(1, "7be93970-c7e3-4b40-2700-3d0a2a0edd08"); ps.executeUpdate(); LOGGER.info(ps.getResultSet().toString()); } catch (SQLException e) { LOGGER.error(e); }
id,errorcode,errormessage,processdata,haserrors 7be93970-c7e3-4b40-2700-3d0a2a0edd08,null,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 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,activities,Table, null,null,activitytypes,Table, null,null,applications,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, "companies", 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,companies,AccountBalance,3,java.lang.Object,0,null,0,0,null,null,null,3,null,null,null,null,null,null,DT_DECIMAL null,null,companies,AccountSourceId.EntityName,12,java.lang.String,255,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR null,null,companies,AccountSourceId.Id,12,java.lang.String,0,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_GUID
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 Crelate 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 Crelate.
try { Connection connection = buildRestConnectionFromDriverManager(); ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "countries"); LOGGER.info("\r\n" + resultSet.toString()); Assertions.assertNotNull(resultSet); } catch (SQLException e) { LOGGER.severe(e.getMessage()); }
TABLE_NAME,PRIMARY_COLUMN_NAME countries,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 | 10 | The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second. |
ApiToken | String | "" | The ApiToken is used to authenticate access to Crelate. |
BaseUrl | String | "" | The URL of the API endpoint for your Crelate instance. |
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 Crelate API. |
IgnoreCertificateErrors | Boolean | false | Specifies whether to verify the certificate when connecting to Crelate. If no certificate verification is required, you can set this value to 'true'. |
IgnoreError | Boolean | false | Determines if the program continues executing SQL statements after encountering an error. |
LogLevel | String | "INFO" | The logging level for the JDBC driver. |
LogPath | String | "./jdbcLogs" | The directory where log files are stored. |
LogFileSize | String | "10485760" | A string specifying the maximum size in bytes for a log file. |
OemKey | String | "" | The OEM License key. |
Password | String | "" | The password used to authenticate the user. |
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 Crelate in a single call. Crelate has a maximum ReadBatchSize of 100. |
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 Crelate. |
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 Crelate API. |
Ssl | Boolean | false | SSL indicates whether the connection is SSL-enabled or supports SSL encryption. |
TotalThreads | Integer | 0 | The number of threads for executing operations in parallel. A value of 0 will disable multi threading. |
WriteBatchSize | Integer | 20 | WriteBatchSize is used to set how many records can be written to Crelate in a single call. |