Using the CData ODBC Driver for Confluence in PyCharm

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 Confluence 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 Confluence 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 Confluence

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.

Obtaining an API Token

An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Connect Using a Confluence Cloud Account

To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

• User: The user which will be used to authenticate with the Confluence server.
• APIToken: The API Token associated with the currently authenticated user.
• Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Connect Using a Confluence Server Instance

To connect to a Server instance, provide the following:

• User: The user which will be used to authenticate with the Confluence instance.
• Password: The password which will be used to authenticate with the Confluence server.
• Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Below is the syntax for a DSN:

[CData Confluence Source]
Driver = CData ODBC Driver for Confluence
Description = My Description
User = admin
APIToken = myApiToken
Url = https://yoursitename.atlassian.net
Timezone = America/New_York

Execute SQL to Confluence

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 Confluence};User = admin;APIToken = myApiToken;Url = https://yoursitename.atlassian.net;Timezone = America/New_York;')
cursor = cnxn.cursor()
cursor.execute("SELECT Key, Name FROM Pages WHERE Id = '10000'")
rows = cursor.fetchall()
for row in rows:
 print(row.Key, row.Name)

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