Query MarkLogic Data in MySQL Workbench

Ready to get started?

Download a free trial of the MarkLogic ODBC Driver to get started:

 Download Now

Learn more:

MarkLogic Icon MarkLogic ODBC Driver

The MarkLogic ODBC Driver is a powerful tool that allows you to connect with live MarkLogic databases, directly from any applications that support ODBC connectivity.

Access MarkLogic like you would a standard RDBMS database - read, write, and update through an ODBC Driver.

Execute MySQL queries against live MarkLogic data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for MarkLogic to query MarkLogic data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live MarkLogic data in MySQL Workbench.

Connect to MarkLogic 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.

Set User, Password, and Server to the credentials for the MarkLogic account and the address of the server you want to connect to. You should also specify the REST API Port if you want to use a specific instance of a REST Server.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to MarkLogic 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)

Query MarkLogic from MySQL Workbench

The steps below outline connecting to the virtual MarkLogic database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live MarkLogic data.

Connect to MarkLogic through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for MarkLogic).
  3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
  4. Click Store in Vault to set and store the password.
  5. Click Test Connection to ensure the connection is configured properly and click OK.

Query MarkLogic Data

  1. Open the connection you just created (CData SQL Gateway for MarkLogic).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve MarkLogic data, like SELECT * FROM `CData MarkLogic Sys`.Customer;

With access to live MarkLogic data from MySQL Workbench, you can easily query and update MarkLogic, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for MarkLogic and the CData SQL Gateway.