Ready to get started?

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

Download Now

Using the CData ODBC Driver for Square in PyCharm

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

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

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.

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

Below is the syntax for a DSN:

[CData Square Source] Driver = CData ODBC Driver for Square Description = My Description OAuthClientId = MyAppId OAuthClientSecret = MyAppSecret CallbackURL = http://localhost:33333 LocationId = MyDefaultLocation

Execute SQL to Square

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 Square};OAuthClientId = MyAppId;OAuthClientSecret = MyAppSecret;CallbackURL = http://localhost:33333;LocationId = MyDefaultLocation;') cursor = cnxn.cursor() cursor.execute("SELECT Reason, RefundedMoneyAmount FROM Refunds WHERE Type = 'FULL'") rows = cursor.fetchall() for row in rows: print(row.Reason, row.RefundedMoneyAmount)

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