Connect to Alfresco Data in IntelliJ

The CData JDBC Driver for Alfresco enables you to access Alfresco as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Alfresco data in IntelliJ.

Create a JBDC Data Source for Alfresco

Follow the steps below to add the driver JAR and define connection properties required to connect to Alfresco data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.alfresco.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.alfresco.AlfrescoDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:alfresco: and includes connection properties separated with semicolons.

     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 the following:

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

Edit and Save Alfresco Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.