We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Query Elasticsearch Data as a MySQL Database in Node.js
Execute MySQL queries against Elasticsearch data from Node.js.
You can use the SQL Gateway from the ODBC Driver for Elasticsearch to query Elasticsearch data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.
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
Connect to Elasticsearch Data
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
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.
Configure the SQL Gateway
See the SQL Gateway Overview to set up connectivity to Elasticsearch data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.
Query Elasticsearch from Node.js
The following example shows how to define a connection and execute queries to Elasticsearch with the mysql module. You will need the following information:
- Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
- Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
- Database name: The DSN you configured for the MySQL remoting service.
Connect to Elasticsearch data and start executing queries with the code below:
var mysql = require('mysql'); var connection = mysql.createConnection({ host : 'localhost', database : 'CData Elasticsearch Sys', port : '3306', user : 'mysql_user', password : 'test' }); connection.connect(); connection.query('SELECT * FROM Orders', function(err, rows, fields) { if (err) throw err; console.log(rows); }); connection.end();