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.

Connecting to Domino

To connect to Domino data, set the following properties:

• URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
• DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

Authenticating with Domino

Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

Login Credentials

To authenticate with login credentials, set the following properties:

• AuthScheme: Set this to "OAuthPassword"
• User: The username of the authenticating Domino user
• Password: The password associated with the authenticating Domino user

The driver uses the login credentials to automatically perform an OAuth token exchange.

EntraID (formerly AzureAD)

This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

• AuthScheme: Set this to "EntraID (formerly AzureAD)"
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
• OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
• CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
• AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

  The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

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.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

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;