Salesforce

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.

The driver can connect to Salesforce using SOAP and RESTful methods.

SOAP

Enter User Name, Password, Security Token, and Server URL to establish a connection.

RESTful

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

Users can choose to use a saved certificate file and certificate password to establish a connection. Alternatively, they can click "Generate New Certificate" to go through the certificate generation process, generate a keystore, save it locally, and use the set certificate password to connect. (Note: The certificate file only supports the PFX format. For newly generated certificates, the simultaneously generated PEM file needs to be configured in the portal.)

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 Salesforce 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 Data Sources), you can execute SQL statements using the Statement class. Refer to "Executing Prepared Statements" 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.

Statement statement = connection.createStatement();	

String query = "SELECT * FROM Account";
		
ResultSet resultSet = statement.executeQuery(query);

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

Note: Currently, SELECT queries only support SOQL.

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.

try {	
    Statement statement = connection.createStatement();	
    String query = "INSERT INTO Account (Name,type) VALUES ('test', 'test type')";		
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata
0016T00003BuPrPQAV,null,null,{"attributes":{"type":"Account"},"Type":"test type","Name":"test"}

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.

try {	
    Statement statement = connection.createStatement();	
    String query = "UPDATE Account SET AccountNumber = '12345' WHERE type IN ('test type');";		
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata
0016T00003BuPrPQAV,null,null,{"attributes":{"type":"Account"},"Id":"0016T00003BuPrPQAV","AccountNumber":"12345"}

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 Salesforce, 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.

try {
    Statement statement = connection.createStatement();	
    String query = "DELETE FROM Account WHERE Name = 'test1'";			
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata
0016T00003BvAZZQA3,null,null,null

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. To determine whether a record already exists, the UPSERT statement or Database method uses the record's ID as the key to match records, a custom external ID field, or a standard field with the idLookup attribute set to true. If the key isn't matched, then a new object record is created.

• If the key is matched once, the existing object record is updated.
• If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

In the Upsert SQL statement, it needs to end with 'ON DUPLICATE KEY UPDATE UPSERTFIELDS = key', where 'key' refers to the field specified by the user as the upsert key.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String query = "UPSERT INTO Account (Name, AccountNumber, type, id) "
    + "VALUES ('test1', '123456', 'test type', null), "
    + "('test2', '123456', 'test type', '0016T00003Bv8vjQAB') "
    + "ON DUPLICATE KEY UPDATE UPSERTFIELDS = id";

try {	
    Statement statement = connection.createStatement();			
    statement.executeUpdate(query);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,isNew
0016T00003BvAZZQA3,null,null,SOAP Object=[Type=test type;Id=null;Name=test1;AccountNumber=123456;],true
0016T00003Bv8vjQAB,null,null,SOAP Object=[Type=test type;Id=0016T00003Bv8vjQAB;Name=test2;AccountNumber=123456;],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:

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 query = "SELECT Accountnumber, Name, CreatedByid, CreatedDate FROM Account WHERE name = ?";
try {	
    PreparedStatement ps = connection.prepareStatement(query);
    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);
}	

Note: Currently, SELECT queries only support SOQL.

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 query = "INSERT INTO Account (Name, AccountNumber, type) VALUES (?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(query);			
    ps.setString(1, "test2");
    ps.setString(2, "123456");
    ps.setString(3, "test type");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata
0016T00003BvS9uQAF,null,null,SOAP Object=[Type=test type;Name=test2;AccountNumber=123456;]

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 query = "UPDATE Account SET AccountNumber = ? WHERE type IN (?)";

try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "654321");
    ps.setString(2, "test type");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata
0016T00003BvSJpQAN,null,null,SOAP Object=[AccountNumber=654321;]

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 Salesforce, 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 query = "DELETE FROM Account WHERE Name = ?";

try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "test1");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata
0016T00003BvSMFQA3,null,null,null

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call. To determine whether a record already exists, the UPSERT statement or Database method uses the record's ID as the key to match records, a custom external ID field, or a standard field with the idLookup attribute set to true. If the key isn't matched, then a new object record is created.

• If the key is matched once, the existing object record is updated.
• If the key is matched multiple times, an error is generated and the object record is not inserted or updated.

In the Upsert SQL statement, it needs to end with 'ON DUPLICATE KEY UPDATE UPSERTFIELDS = key', where 'key' refers to the field specified by the user as the upsert key.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the ID of upserted data, exceptions raised during execution, and the data affected by the upserting.

String query = "UPSERT INTO Account (Name, AccountNumber, type, id) "
    + "VALUES (?, ?, ?, ?)"
    + "ON DUPLICATE KEY UPDATE UPSERTFIELDS = id";

try {	
    PreparedStatement ps = connection.prepareStatement(query);
    ps.setString(1, "test3");
    ps.setString(2, "654321");
    ps.setString(3, "test type");			
    ps.setNull(4, Types.VARCHAR);
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}	

id,errorcode,errormessage,processdata,isNew
null,null,SOAP Errors:[[StatusCode=DUPLICATES_DETECTED;Message=Use one of these records?];],SOAP Object=[Type="test type";Id="0016T000033urGHQAY";Name="test3";AccountNumber="654321";],false

Metadata Discovery

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");
connectionProps.put("securityToken", "token");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://login.salesforce.com/services/Soap/u/58.0;serviceEndpoint=SOAP;", connectionProps);

ResultSet resultSet = connection.getMetaData().getTables(null, null, null, null);
LOGGER.info(resultSet.toString());

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,AcceptedEventRelation,Table,
null,null,Account,Table,
null,null,AccountContactRole,Table,
null,null,AccountFeed,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.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");
connectionProps.put("securityToken", "token");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://login.salesforce.com/services/Soap/u/58.0;serviceEndpoint=SOAP;", connectionProps);

ResultSet resultSet = connection.getMetaData().getColumns(null, null, "Contact", null);
LOGGER.info(resultSet.toString());

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,SALES_FORCE_TYPE
null,null,Contact,AccountId,1,java.lang.Character,18,null,0,0,null,null,null,1,null,null,null,null,null,null,reference
null,null,Contact,AssistantName,12,java.lang.String,40,null,0,0,null,null,null,12,null,null,null,null,null,null,stringnull,null,Contact,AssistantPhone,12,java.lang.String,40,null,0,0,null,null,null,12,null,null,null,null,null,null,phone

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 Salesforce.

Class.forName("com.kingswaysoft.jdbc.Drivers");

Properties connectionProps = new Properties();
connectionProps.put("user", "username");
connectionProps.put("password", "password");
connectionProps.put("securityToken", "token");

Connection connection = DriverManager.getConnection("jdbc:kingswaysoft:url=https://login.salesforce.com/services/Soap/u/58.0;serviceEndpoint=SOAP;", connectionProps);

ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "Contact");
LOGGER.info(resultSet.toString());

TABLE_NAME,PRIMARY_COLUMN_NAME
Contact,Id

The getPrimaryKeys method returns the following columns:

Connection Settings