Emarsys

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

connectionmanage

General Settings

API Throttling Rate: The API Throttling Rate will limit the number of requests that can be sent per minute. Set this value to 0 to disable API throttling.

Authentication Methods for Emarsys

OAuth Client Credentials

Emarsys uses the OAuth Client Credentials flow. Enter the Client ID and Client Secret issued for your Emarsys API integration. The driver obtains and refreshes the access token automatically.

Client ID: The Client ID option allows you to specify the unique ID that identifies the application making the request.
Client Secret: The Client Secret option allows you to specify the client secret belonging to your Emarsys API integration.

Test Connection

After completing the configuration for all required connection and authentication settings in the JDBC Connection Manager, you can use the Test Connection button to validate your configuration and verify API requests will authenticate successfully.

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.

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 Emarsys 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 contactlist/contactIds WHERE contactlistId = '739404148'"";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

For contact/query, the driver converts the selected and filtered field names to their Emarsys field identifiers. The table supports queries without a WHERE condition, such as SELECT email FROM contact/query, or one contact identifier condition using = or IS NULL, with optional query parameters such as excludeempty. Multiple selected contact columns and SELECT * are supported. The driver generates the API return parameter from the selected columns; do not specify it as a WHERE condition.

For contact/getdata, exactly one WHERE condition on a contact identifier field, such as id or email, is required. Use = to look up one value or IN (...) to look up multiple values of the same field. The API return parameter is not a contact identifier. To read contacts without a WHERE condition, use contact/query.

String sql = "SELECT id, first_name FROM contact/getdata "
           + "WHERE email IN ('[email protected]', '[email protected]')";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

Note: The contact columns available through metadata depend on the fields configured in the connected Emarsys account. Refresh the connection metadata after adding or changing Emarsys contact fields.

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 contact (key_id, email) VALUES (3, '[email protected]')";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INFO: id,errorcode,errormessage,processdata,haserrors
1097738402,null,null,{"key_id":"3","contacts":[{"email":"[email protected]"}]},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 contact SET last_name = 'UpdateLastName' WHERE email = '[email protected]'";
try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1097738402,null,null,{"contacts":[{"last_name":"UpdateLastName","email":"[email protected]"}],"key_id":"email"},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 contact/delete WHERE email IN ('[email protected]')";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INFO: id,errorcode,errormessage,processdata,haserrors
null,null,null,{"email":["[email protected]"],"key_id":"email"},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:

Creating and Executing 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 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 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 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 email FROM contact/query WHERE email = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, '[email protected]');
    boolean ret = ps.execute();
    if (ret) {
        ResultSet rs = ps.getResultSet();
        LOGGER.info(rs.toString());
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

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. 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 contact (key_id, email) VALUES (3, ?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "[email protected]");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INFO: id,errorcode,errormessage,processdata,haserrors
1097738402,null,null,{"key_id":"3","contacts":[{"email":"[email protected]"}]},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. 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 contact SET last_name = 'UpdateLastName' "
           + "WHERE email = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "[email protected]");
    ps.executeUpdate();

    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INFO: id,errorcode,errormessage,processdata,haserrors
167322368,null,null,{"contacts":[{"last_name":"UpdateLastName","email":"[email protected]"}],"key_id":"email"},false

DELETE

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute a DELETE operation.

String deleteSql = "DELETE FROM contact/delete WHERE email IN (?)";
try {
    PreparedStatement ps = connection.prepareStatement(deleteSql);
    ps.setString(1, "[email protected]");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

INFO: id,errorcode,errormessage,processdata,haserrors
null,null,null,{"email":["[email protected]"],"key_id":"email"},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 which include 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,TYPE_CAT,TYPE_SCHEM,TYPE_NAME,SELF_REFERENCING_COL_NAME,REF_GENERATION
null,null,ac/programs,TABLE,null,null,null,null,null,null
null,null,administrator,TABLE,null,null,null,null,null,null
null,null,administrator/getaccesslevels,TABLE,null,null,null,null,null,null
null,null,administrator/getinterfacelanguages,TABLE,null,null,null,null,null,null
null,null,administrator/getstartpages,TABLE,null,null,null,null,null,null
null,null,condition,TABLE,null,null,null,null,null,null
null,null,contact/getdata,TABLE,null,null,null,null,null,null
null,null,contact/last_change,TABLE,null,null,null,null,null,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.

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.

try {
    Connection connection = buildRestConnectionFromDriverManager();
    ResultSet rs = connection.getMetaData().getColumns(null, null, "contact/getdata", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    e.printStackTrace();
}

INFO: 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,SCOPE_CATALOG,SCOPE_SCHEMA,SCOPE_TABLE,SOURCE_DATA_TYPE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,contact/getdata,3rd_party_consent,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,address,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,anniversary,91,DATE,null,null,0,0,null,null,null,91,null,null,null,null,null,null,null,null,null,null,DT_DBDATE
null,null,contact/getdata,available_amount,8,DOUBLE,null,null,0,0,null,null,null,8,null,null,null,null,null,null,null,null,null,null,DT_DOUBLE
null,null,contact/getdata,average_visit_duration,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,birth_date,91,DATE,null,null,0,0,null,null,null,91,null,null,null,null,null,null,null,null,null,null,DT_DBDATE
null,null,contact/getdata,bounced,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,children,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,city,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,city_interests,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,cl_cooking_skills,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,cl_disliked_ingreditents,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,contact/getdata,cl_favourite_dishes,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR

For contact resources, the returned columns include the account's dynamically discovered Emarsys contact fields. The driver maps date fields to JDBC DATE, numeric fields to DOUBLE, and other contact fields to VARCHAR.

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.
SCOPE_CATALOG	String	The catalog of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SCOPE_SCHEMA	String	The schema of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SCOPE_TABLE	String	The name of the table referenced by a reference attribute (null if `DATA_TYPE` is not `REF`).
SOURCE_DATA_TYPE	Short	The source type of a distinct type or user-defined `REF` type (null if `DATA_TYPE` is neither `DISTINCT` nor a user-defined `REF`).
IS_AUTOINCREMENT	String	Whether the column value is assigned by Emarsys 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 Emarsys.

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

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,KEY_SEQ,PK_NAME
null,null,contactlist,id,1,null

The getPrimaryKeys method returns the following columns:

Column Name	Data Type	Description
TABLE_CAT	String	The catalog name.
TABLE_SCHEM	String	The schema name.
TABLE_NAME	String	The name of the table that contains the primary key.
COLUMN_NAME	String	The name of the column that serves as the primary key for the table.
KEY_SEQ	Short	The sequence number within the primary key.
PK_NAME	String	The primary key name.

Connection Settings

Connection Setting	Type	Default Value	Description
ApiThrottleRate	Integer	0	The maximum number of API requests a client can make to the server within a specific time period, defined in requests per minute.
AuthenticationMode	String	"OAuth"	The authentication mode used to connect to Emarsys.
BatchSizeForReading	Integer	100	BatchSizeForReading is used to set how many records can be read from Emarsys in a single call when the endpoint supports paging.
BatchSizeForWriting	Integer	1	BatchSizeForWriting is used to set how many records can be written to Emarsys in a single call. Actual batch behavior depends on the selected endpoint.
CacheExpirationTime	Integer	30	Defines the expiration time for cache. A value of 0 disables caching.
ClientId	String	""	The Client ID used to authenticate to the Emarsys API.
ClientSecret	String	""	The Client Secret used to authenticate to the Emarsys API.
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 Emarsys API.
ContinueOnErrors	Boolean	false	Determines if the program continues executing SQL statements after encountering an error.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to Emarsys. If certificate verification is not required, you can set this value to 'true'.
LogFileSize	String	"10000000"	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.
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	-1	The port of the proxy server.
ProxyUsername	String	""	The username to be used to authenticate to the proxy.
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 Emarsys 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.

Emarsys JDBC Driver

Documentation for Emarsys drivers found within JDBC Driver Pack

Emarsys

Building the JDBC URL

General Page

Authentication Methods for Emarsys

Advanced Settings Page

Using the JDBC Driver

Executing Statements

SELECT

INSERT

UPDATE

DELETE

Executing Prepared Statements

SELECT

INSERT

UPDATE

DELETE

Metadata Discovery

Tables

Columns

Primary Keys

Connection Settings