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

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.

Set User, Password, and Server to the credentials for the MarkLogic account and the address of the server you want to connect to. You should also specify the REST API Port if you want to use a specific instance of a REST Server.

Below is the syntax for a DSN:

[CData MarkLogic Source]
Driver = CData ODBC Driver for MarkLogic
Description = My Description
User = 'myusername'
Password = 'mypassword'
Server = 'http://marklogic'

Execute SQL to MarkLogic

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 MarkLogic};User = 'myusername';Password = 'mypassword';Server = 'http://marklogic';')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, TotalDue FROM Customer WHERE Id = '1'")
rows = cursor.fetchall()
for row in rows:
 print(row.Name, row.TotalDue)

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