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

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.

Using API Key Authentication

Mocean uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Mocean account at https://dashboard.moceanapi.com
2. Navigate to your account settings or API credentials section
3. Copy your API Key

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

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

Example Connection String

Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Connecting to Mocean

Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

Below is the syntax for a DSN:

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

Execute SQL to Mocean

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\Mocean.apip;AuthScheme = APIKey;ProfileSettings = 'APIKey = your_api_key';')
cursor = cnxn.cursor()
cursor.execute("SELECT ,  FROM AccountBalance WHERE  = ''")
rows = cursor.fetchall()
for row in rows:
  print(row., row.)

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