Ready to get started?

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

Download Now

Using the CData ODBC Driver for Alfresco in PyCharm

Connect to Alfresco as an ODBC data source in PyCharm using the CData ODBC Driver for Alfresco.

The CData ODBC Drivers can be used in any environment that supports loading an ODBC Driver. In this tutorial we will explore using the CData ODBC Driver for Alfresco from within PyCharm. Included are steps for adding the CData ODBC Driver as a data source, as well as basic PyCharm code to query the data source and display results.

To begin, this tutorial will assume that you have already installed the CData ODBC Driver for Alfresco as well as PyCharm.

Add Pyodbc to the Project

Follow the steps below to add the pyodbc module to your project.

  1. Click File -> Settings to open the project settings window.
  2. Click Project Interpreter from the Project: YourProjectName menu.
  3. To add pyodbc, click the + button and enter pyodbc.
  4. Click Install Package to install pyodbc.

Connect to Alfresco

You can now connect with an ODBC connection string or a DSN. See the Getting Started section in the CData driver documentation for a guide to creating a DSN on your OS.

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.

Below is the syntax for a DSN:

[CData Alfresco Source] Driver = CData ODBC Driver for Alfresco Description = My Description User = MyUsername Password = MyPassword Format = Solr InstanceUrl = api-explorer.alfresco.com

Execute SQL to Alfresco

Instantiate a Cursor and use the execute method of the Cursor class to execute any SQL statement.

import pyodbc cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for Alfresco};User = MyUsername; Password = MyPassword; Format = Solr; InstanceUrl = api-explorer.alfresco.com;') cursor = cnxn.cursor() cursor.execute("SELECT DBID, Column1 FROM Alfresco WHERE Column2 = 'MyFilter'") rows = cursor.fetchall() for row in rows: print(row.DBID, row.Column1)

After connecting to Alfresco in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Alfresco data as if it were a standard database. If you have any questions, comments, or feedback regarding this tutorial, please contact us at support@cdata.com.