Ready to get started?

Learn more about the CData ODBC Driver for Alfresco or download a free trial:

Download Now

Query Alfresco Data in MySQL Workbench

Execute MySQL queries against live Alfresco data from MySQL Workbench.

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

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

To connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

Configure the SQL Gateway

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

Query Alfresco from MySQL Workbench

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

Connect to Alfresco through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Alfresco).
  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 Alfresco Data

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

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