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

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.

To authenticate requests, set the , , and properties to valid Splunk credentials. The port on which the requests are made to Splunk is port 8089.

The data provider uses plain-text authentication by default, since the data provider attempts to negotiate TLS/SSL with the server.

If you need to manually configure TLS/SSL, see Getting Started -> Advanced Settings in the data provider help documentation.

Below is the syntax for a DSN:

[CData Splunk Source]
Driver = CData ODBC Driver for Splunk
Description = My Description
user = MyUserName
password = MyPassword
URL = MyURL
InitiateOAuth = GETANDREFRESH

Execute SQL to Splunk

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 Splunk};user = MyUserName;password = MyPassword;URL = MyURL;InitiateOAuth = GETANDREFRESH;')
cursor = cnxn.cursor()
cursor.execute("SELECT Name, Owner FROM DataModels WHERE Id = 'SampleDataset'")
rows = cursor.fetchall()
for row in rows:
 print(row.Name, row.Owner)

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