Using the CData ODBC Driver for Carbone 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 Carbone 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 Carbone 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 Carbone

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.

Start by setting the Profile connection property to the location of the Carbone Profile on disk (e.g. C:\profiles\Carbone.apip). Next, set the ProfileSettings connection property to the connection string for Carbone (see below).

Carbone API Profile Settings

Carbone uses API key authentication via a Bearer token in the Authorization header. To obtain an API key:

1. Log in to your Carbone account at https://account.carbone.io
2. Copy the API key shown on the account home page

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Carbone API key (Bearer token).
• CarboneVersion: (Optional) The major version of the Carbone API to target via the carbone-version request header. Defaults to 5. Accepted values: 5, 4, 3, staging.

Below is the syntax for a DSN:

[CData API Source]
Driver = CData ODBC Driver for Carbone
Description = My Description
Profile = C:\profiles\Carbone.apip
AuthScheme = APIKey
APIKey = your_api_key

Execute SQL to Carbone

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 API};Profile = C:\profiles\Carbone.apip;AuthScheme = APIKey;APIKey = your_api_key;')
cursor = cnxn.cursor()
cursor.execute("SELECT Id, Name FROM Templates WHERE Category = 'Invoices'")
rows = cursor.fetchall()
for row in rows:
  print(row.Id, row.Name)

After connecting to Carbone in PyCharm using the CData ODBC Driver, you will be able to build Python apps with access to Carbone 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].