Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Connect to Elasticsearch Data in Ruby
Connect to Elasticsearch data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.
The CData ODBC Driver for Elasticsearch makes it easy to integrate connectivity to live Elasticsearch data in Ruby. This article shows how to create a simple Ruby app that connects to Elasticsearch data, executes a query, and displays the results.
About Elasticsearch Data Integration
Accessing and integrating live data from Elasticsearch has never been easier with CData. Customers rely on CData connectivity to:
- Access both the SQL endpoints and REST endpoints, optimizing connectivity and offering more options when it comes to reading and writing Elasticsearch data.
- Connect to virtually every Elasticsearch instance starting with v2.2 and Open Source Elasticsearch subscriptions.
- Always receive a relevance score for the query results without explicitly requiring the SCORE() function, simplifying access from 3rd party tools and easily seeing how the query results rank in text relevance.
- Search through multiple indices, relying on Elasticsearch to manage and process the query and results instead of the client machine.
Users frequently integrate Elasticsearch data with analytics tools such as Crystal Reports, Power BI, and Excel, and leverage our tools to enable a single, federated access layer to all of their data sources, including Elasticsearch.
For more information on CData's Elasticsearch solutions, check out our Knowledge Base article: CData Elasticsearch Driver Features & Differentiators.
Getting Started
Create an ODBC Connection to Elasticsearch Data
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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.
Installing Ruby and Necessary Gems
If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:
gem install dbi
gem install dbd-odbc
gem install ruby-odbc
Create a Ruby App with Connectivity to Elasticsearch Data
Create a new Ruby file (for example: ElasticsearchSelect.rb) and open it in a text editor. Copy the following code into your file:
#connect to the DSN
require 'DBI'
cnxn = DBI.connect('DBI:ODBC:CData Elasticsearch Source','','')
#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Orders.Freight, Customers.ContactName FROM Customers INNER JOIN Orders ON Customers.CustomerId=Orders.CustomerId")
#display the names of the columns
resultSet.column_names.each do |name|
print name, "\t"
end
puts
#display the results
while row = resultSet.fetch do
(0..resultSet.column_names.size - 1).each do |n|
print row[n], "\t"
end
puts
end
resultSet.finish
#close the connection
cnxn.disconnect if cnxn
With the file completed, you are ready to display your Elasticsearch data with Ruby. To do so, simply run your file from the command line:
ruby ElasticsearchSelect.rb
Writing SQL-92 queries to Elasticsearch allows you to quickly and easily incorporate Elasticsearch data into your own Ruby applications. Download a free trial today!