Using the CData ODBC Driver for Raisers Edge NXT in PyCharm

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Raisers Edge NXT ODBC Driver

The Raisers Edge NXT ODBC Driver is a powerful tool that allows you to connect with live data from Raisers Edge NXT, directly from any applications that support ODBC connectivity.

Access Raisers Edge NXT data like you would a database, including Raisers Edge NXT Events, Gifts, Opportunities, etc. through a standard ODBC Driver interface.



Connect to Raisers Edge NXT as an ODBC data source in PyCharm using the CData ODBC Driver for Raisers Edge NXT.

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 Raisers Edge NXT 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 Raisers Edge NXT 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 Raisers Edge NXT

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.

Before establishing a connection, supply the SubscriptionKey, found in the Blackbaud Raiser's Edge NXT Profile.

Authenticating to Raiser's Edge NXT

Blackbaud Raiser's Edge NXT uses the OAuth authentication standard. You can connect to without setting any connection properties using the embedded OAuth credentials.

Alternatively, you can authenticate by creating a custom app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.

See the Help documentation for an authentication guide.

Below is the syntax for a DSN:

[CData RaiserEdgeNXT Source] Driver = CData ODBC Driver for Raisers Edge NXT Description = My Description SubscriptionKey = MySubscriptionKey OAuthClientId = MyOAuthClientId OAuthClientSecret = MyOAuthClientSecret CallbackURL = http://localhost:33333

Execute SQL to Raisers Edge NXT

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 RaiserEdgeNXT};SubscriptionKey = MySubscriptionKey;OAuthClientId = MyOAuthClientId;OAuthClientSecret = MyOAuthClientSecret;CallbackURL = http://localhost:33333;') cursor = cnxn.cursor() cursor.execute("SELECT Id, AddressLines FROM Constituents WHERE Type = 'Home'") rows = cursor.fetchall() for row in rows: print(row.Id, row.AddressLines)

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