Configure ODBC access

You can connect to your MarkLogic Server Service databases using ODBC. This allows SQL-based tools and applications to query data stored in MarkLogic.

Prerequisites

Before you configure ODBC access, make sure the following requirements are met:

• You have the MarkLogic Administrator role in Progress Data Cloud.
• Your tenancy has been enabled for ODBC access by the Progress Data Cloud Operations Team. To request ODBC access, contact the Progress Data Cloud Operations Team or raise a support ticket.
• The MarkLogic ODBC driver is installed on the machine that requires access. You can download the driver from the Progress website.

Step 1: Create an ODBC app server in MarkLogic Server

Create and configure an ODBC app server using the MarkLogic Server Admin Interface:

1. Log in to the MarkLogic Server Admin Interface.
2. Navigate to Groups > Default > App Servers.
3. Click the Create ODBC tab.
4. Configure the ODBC server:
   • ODBC Server Name — Enter a name for the server.
   • Root — Enter the root directory for your data.
   • Port — Enter a port number. The default PostgreSQL listening port is 5432. The port must be unique and not assigned to any other app server.
   • Database — Select the database to be accessed. The database should be set up with the range indexes and schema views to support SQL applications.
   • Authentication — Select an authentication scheme (the default is digest).
5. Click OK to create the server.

Step 2: Create a MarkLogic user for ODBC access

Create a user in MarkLogic for ODBC connections:

1. In the MarkLogic Server Admin Interface, navigate to Security > Users.
2. Click Create to add a new user.
3. Enter a username and password for the ODBC user.
4. Assign the appropriate roles for the user. At a minimum, the user needs a role that grants access to the database configured in the ODBC app server.
5. Click OK to create the user.

Step 3: Expose the ODBC endpoint in Progress Data Cloud

After creating the ODBC app server, expose it through the Progress Data Cloud Interface so it is accessible outside the cluster:

1. In Progress Data Cloud, on the Services page, find the card for the MarkLogic Server Service instance containing your ODBC app server.
2. Click on the service card.
3. Click Configure ODBC Endpoints.
4. Click + to add a new endpoint.
5. Configure the endpoint to map to the ODBC app server port you created in Step 1.
6. Click Add, then click Save Changes.

For more details on exposing app servers, see Expose an app server.

Step 4: Configure the ODBC data source

On the machine where you installed the MarkLogic ODBC driver, configure an ODBC data source with the following settings:

Configuring SSL for ODBC

To use SSL encryption for ODBC connections:

1. In the MarkLogic Server Service Admin Interface, create a certificate template for the ODBC app server.
2. Configure the SSL Configuration settings on the ODBC app server to use the certificate template.

For more information on SSL configuration, see Configuring SSL on App Servers in the MarkLogic Server Service security documentation.