How to create HCL Domino federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for HCL Domino data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for HCL Domino: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with HCL Domino data just as you would local MySQL tables.

Connect to HCL Domino Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Prerequisites

The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.

Authenticating to Domino

• Server: The name or IP address of the server running Domino with the Proton service.
• Port: The port number that the Proton service is listening on.
• Database: The name of the database file, including the .nsf extension.
• SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
• SSLClientCert: The path to the certificate file.
• SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.

Additional Server Configuration

The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.

Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to HCL Domino data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Create a FEDERATED Server and Tables for HCL Domino Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for HCL Domino. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedDomino
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData Domino Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (ByName). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_byname (
  ...,
  name  TYPE(LEN),
  address  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedDomino/byname';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the HCL Domino FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from HCL Domino. Refer to the following example:

SELECT 
  fed_byname.name, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_byname 
ON 
  local_table.foreign_name = fed_byname.name;