Copper

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 of the Copper Connection Manager allows you to specify the general settings of the connection:

Authentication Methods for Copper

Advanced Settings Page

The Advanced Settings page allows you to specify advanced settings for the connection.

Using the JDBC Driver

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

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 projects WHERE id = 1654453";
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.

User can pass driver-specific write options by appending a USING OPTIONS (...) clause at the end of the INSERT statement, and it will override the WriteBatchSize defined in the properties.

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 projects (name) VALUES ('ProjectName')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1654639,null,null,{"name":"ProjectName"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

User can pass driver-specific write options by appending a USING OPTIONS (...) clause at the end of the UPDATE statement, and it will override the WriteBatchSize defined in the properties.

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 projects SET name = 'ProjectUpdateName' WHERE id = 1654639";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1654639,null,null,{"name":"ProjectUpdateName"},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 projects WHERE id = 1654639";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1654639,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

If the key isn't matched, then a new object record is created.

If the specified key is matched, the action taken will depend on if there were multiple matches or not.

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

The Upsert SQL statement must 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 upsert.

String sql = "UPSERT INTO leads (name, email.email, email.category) VALUES ('My Lead', '[email protected]', 'work') ON DUPLICATE KEY UPDATE UPSERTFIELDS = (name)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
8982702,null,null,{"match":{"field_name":"name","field_value":"My Lead"},"properties":{"name":"My Lead","email":{"email":"[email protected]","category":"work"}}},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:

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 projects WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setInt(1, 1654453);
    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 PreparedStatement class to execute an INSERT operation.

User can pass driver-specific write options by appending a USING OPTIONS (...) clause at the end of the INSERT statement, and it will override the WriteBatchSize defined in the properties.

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 projects (name) VALUES (?)";

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

d,errorcode,errormessage,processdata,haserrors
1654639,null,null,{"name":"ProjectName"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute an UPDATE operation.

User can pass driver-specific write options by appending a USING OPTIONS (...) clause at the end of the UPDATE statement, and it will override the WriteBatchSize defined in the properties.

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 projects SET name = ? WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "ProjectUpdateName");
    ps.setInt(2, 1654639);
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
1654639,null,null,{"name":"ProjectUpdateName"},false

DELETE

Use either the generic execute method or the executeUpdate method of the PreparedStatement 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 projects WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setInt(1, 1654639);
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
1654639,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

If the key isn't matched, then a new object record is created.

If the specified key is matched, the action taken will depend on if there were multiple matches or not.

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

The Upsert SQL statement must 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 upsert.

String sql = "UPSERT INTO leads (name, email.email, email.category) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (name)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "My Lead");
    ps.setString(2, "[email protected]");
    ps.setString(3, "work");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
8982702,null,null,{"match":{"field_name":"name","field_value":"My Lead"},"properties":{"name":"My Lead","email":{"email":"[email protected]","category":"work"}}},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.

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,account,Table,null
null,null,activities,Table,null
null,null,activity_types,Table,null
null,null,companies,Table,null
null,null,companies/activities,Table,null
null,null,contact_types,Table,null
null,null,custom_activity_types,Table,null
null,null,custom_field_definitions,Table,null
null,null,customer_sources,Table,null
null,null,files,Table,null
......

The getTables method returns the following metadata columns:

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, "projects", 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,projects,assignee_id,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,DT_I8
null,null,projects,date_created,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,projects,date_modified,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,projects,details,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,projects,id,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,DT_I8
null,null,projects,name,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,projects,related_resource.id,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,DT_I8
null,null,projects,related_resource.type,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,projects,status,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,projects,tags,12,VARCHAR,null,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 Copper.

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

TABLE_NAME,PRIMARY_COLUMN_NAME
projects,id

The getPrimaryKeys method returns the following columns:

Connection Settings