Ready to get started?

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

Download Now

Connect to Alfresco Data in Aqua Data Studio

Access Alfresco data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Alfresco integrates Alfresco data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Alfresco data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Alfresco data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Alfresco.
    • Driver Location: Click the Browse button and select the cdata.jdbc.alfresco.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.alfresco.AlfrescoDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:alfresco: and is followed by a semicolon-separated list of connection properties.

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Alfresco JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.alfresco.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;

Query Alfresco Data

You can now query the tables exposed.