Zuora

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

General Settings

Instance Type

The Instance Type allows you to select the type of the instance being worked with.

Available options are:

• APAC Developer & Central Sandbox
• APAC Production
• EU API Sandbox
• EU Developer & Central Sandbox
• EU Production
• US API Sandbox (Cloud 1)
• US API Sandbox (Cloud 2)
• US Developer & Central Sandbox
• US Production (Cloud 1)
• US Production (Cloud 2)

API Base URL

The API Base URL uniquely identifies a Zuora base.

The value of API Base URL is set based upon the selected Instance Type

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.

Organization Ids

The Organization Ids can be set to specify the organization or organizations that should be targetted in API requests.

This is an optional field

Authentication Methods for Zuora

Advanced Settings Page

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 Zuora 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 object/product WHERE id = '8ad0982798180e20019819dbace41bf3'";
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 object/product (EffectiveEndDate, EffectiveStartDate, Name)"
       + " VALUES ('2034-01-01', '2024-01-01', 'name')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
8ad088639817fca501981f0028c240a6,null,null,{"EffectiveEndDate":"2034-01-01","EffectiveStartDate":"2024-01-01","Name":"name"},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 object/product SET Name = 'updated' WHERE id = '8ad088639817fca501981f0028c240a6'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserror
8ad088639817fca501981f0028c240a6,null,null,{"Name":"updated"},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 object/product WHERE id = '8ad088639817fca501981f0028c240a6'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
8ad088639817fca501981f0028c240a6,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 upserting.

String sql = "UPSERT INTO payment-profile (subscriptionId, paymentGatewayId, paymentMethodId)"
	+ " VALUES ('6cf2a1e07b9d3f45017b9e8dd3fc72ae', 'e47b2d90a3c6e81201a3c8f24d19b7c3', '1f83c5d702e4a9b601702e6b89a1d42e')"
	+ " ON DUPLICATE KEY UPDATE UPSERTFIELDS = (subscriptionId)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors,isnew
null,null,null,{"bulkPaymentOptionItems":[{"subscriptionId":"6cf2a1e07b9d3f45017b9e8dd3fc72ae","paymentGatewayId":"e47b2d90a3c6e81201a3c8f24d19b7c3","paymentMethodId":"1f83c5d702e4a9b601702e6b89a1d42e"}]},false,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 sql = "SELECT * FROM object/product WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "8ad0982798180e20019819dbace41bf3");
    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 object/product (EffectiveEndDate, EffectiveStartDate, Name) VALUES (?, ?, ?)";

try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "2034-01-01");
    ps.setString(2, "2024-01-01");
    ps.setString(3, "name");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
8ad088639817fca501981f0028c240a6,null,null,{"EffectiveEndDate":"2034-01-01","EffectiveStartDate":"2024-01-01","Name":"name"},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 object/product SET Name = ? WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "updated");
    ps.setString(2, "8ad088639817fca501981f0028c240a6");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserror
8ad088639817fca501981f0028c240a6,null,null,{"Name":"updated"},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 object/product WHERE id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "8ad088639817fca501981f0028c240a6");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors
8ad088639817fca501981f0028c240a6,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. Users 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 sql = "UPSERT INTO payment-profile (subscriptionId, paymentGatewayId, paymentMethodId) VALUES (?, ?, ?) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (subscriptionId)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "6cf2a1e07b9d3f45017b9e8dd3fc72ae");
    ps.setString(2, "e47b2d90a3c6e81201a3c8f24d19b7c3");
    ps.setString(3, "1f83c5d702e4a9b601702e6b89a1d42e");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors,isnew
null,null,null,{"bulkPaymentOptionItems":[{"subscriptionId":"6cf2a1e07b9d3f45017b9e8dd3fc72ae","paymentGatewayId":"e47b2d90a3c6e81201a3c8f24d19b7c3","paymentMethodId":"1f83c5d702e4a9b601702e6b89a1d42e"}]},false,false

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.

This method only retrieves tables that are not write-only.

To get a list of tables which include write-only tables, query the table [system.tables](/products/jdbc-driver-pack/help-manual/advancedfeatures#systemtables).

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,accounting-codes,Table,nullnull,null,accounting-periods,Table,nullnull,null,accounts,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 tables which are write-only, query the table [system.columns](/products/jdbc-driver-pack/help-manual/advancedfeatures#systemcolumns).

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "accounts", 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,accounts,Class__NS,12,VARCHAR,255,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,accounts,CpqBundleJsonId__QT,12,VARCHAR,255,null,0,0,null,null,null,12,null,null,null,null,null,null,DT_WSTR
null,null,accounts,CustomerType__NS,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:

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in Zuora.

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

TABLE_NAME,PRIMARY_COLUMN_NAME
accounts,id

The getPrimaryKeys method returns the following columns:

Connection Settings