Using the CData ODBC Driver for Elasticsearch 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 Elasticsearch 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 Elasticsearch as well as PyCharm.

Getting Started

---

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 Elasticsearch

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 the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

Below is the syntax for a DSN:

[CData Elasticsearch Source]
Driver = CData ODBC Driver for Elasticsearch
Description = My Description
Server = 127.0.0.1
Port = 9200
User = admin
Password = 123456

Execute SQL to Elasticsearch

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 Elasticsearch};Server = 127.0.0.1;Port = 9200;User = admin;Password = 123456;')
cursor = cnxn.cursor()
cursor.execute("SELECT OrderName, Freight FROM Orders WHERE ShipCity = 'New York'")
rows = cursor.fetchall()
for row in rows:
  print(row.OrderName, row.Freight)

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