Ready to get started?

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

Download Now

Manage Alfresco Data in DBArtisan as a JDBC Source

Use wizards in DBArtisan to create a JDBC data source for Alfresco.

The CData JDBC Driver for Alfresco seamlessly integrates Alfresco data into database management tools like DBArtisan by enabling you to access Alfresco data as a database. This article shows how to create a JDBC source for Alfresco in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Alfresco Data into DBArtisan Projects

Follow the steps below to register Alfresco data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic JDBC.
  3. Click Manage.
  4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
  5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

    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.

    Below is a typical connection string:

    jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;
  6. Finish the wizard to connect to Alfresco data. Alfresco entities are displayed in the Datasource Explorer.

You can now work with Alfresco data as you work with any other database. See the driver help documentation for more information on the queries supported by the Alfresco API.