Build Elasticsearch-Connected Web Apps with Axios and CData Connect Cloud



Use CData Connect Cloud to connect to live Elasticsearch data and build Elasticsearch-connected web apps with Axios.

Axios is a JavaScript library that allows developers to make HTTP requests to servers from a web browser or Node.js. When paired with CData Connect Cloud, you get access to live Elasticsearch data for your web apps. This article shows how to connect to Elasticsearch and build web apps in Axios with access to live Elasticsearch data.

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 from Axios

To work with Elasticsearch in Axios, we need to connect to Elasticsearch from Connect Cloud, provide user access to the connection, and create a Workspace for the Elasticsearch data.

Connect to Elasticsearch from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect Cloud, click Sources, and then click Add Connection
  2. Select "Elasticsearch" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Elasticsearch.

    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.

  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Elasticsearch Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect Cloud through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect Cloud. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect Cloud app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Elasticsearch Endpoints for Axios

After connecting to Elasticsearch, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
  2. Click Add to add new assets to the Workspace.
  3. Select the Elasticsearch connection (e.g. Elasticsearch1) and click Next.
  4. Select the table(s) you wish to work with and click Confirm.
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Elasticsearch data from Axios.

Connect to Elasticsearch Data in Axios Workflows

To establish a connection from Axios to CData Connect Cloud using the OData protocol, follow these steps.

  1. Create a project directory for your web app. For example: ~/connect_cloud/
  2. Open a terminal, navigate the the project directory and initialize a node project using the command:
    npm init -y
  3. Install the Axios dependency in the project using the following command:
    npm install axios
  4. In your project directory, create a file called server.js that contains the following code. Provide your CData Connect Cloud username (e.g. [email protected]) and PAT (the PAT you created in the prerequisites). You must also provide a query for your data, such as SELECT * FROM Elasticsearch1.SCHEMA.Orders.

    server.js code

          const axios = require('axios')
    
          const user = '[email protected]'
          const pat = '***********************************';
    
          //Your API endpoint
          const url = 'https://cloud.cdata.com/api/odata/{workspace_name}';
    
          //Your data to be sent in the POST request
          const data = {
          "query":"SELECT * FROM {workspace_name}.SCHEMA.Orders"
          };
    
          axios.post(url, data, {
          auth: {
          username: user,
          password: pat
          }
          })
          .then(response => {
          const rows = response.data.results[0].rows;
          const schema = response.data.results[0].schema;
    
          //Create an array of column names
          const columnNames = schema.map(col => col.columnName);
    
          //Loop through each row and log the column name with its value
          rows.forEach(row => {
          const rowObject = {};
          row.forEach((value, index) => {
          const columnName = columnNames[index];
          rowObject[columnName] = value;
          });
          console.log(rowObject);
          })
          })
          .catch(error => {
          console.error('Error:', error);
          });
        
  5. In the terminal, execute the following command to run the server:
    node server.js
    The query results will appear:
        { ID: 1, VALUE: -2 }
        { ID: 2, VALUE: 1 }
        { ID: 11, VALUE: null }
        { ID: 3, VALUE: 2 }
        { ID: 4, VALUE: 5 }
        ...

Simplified Access to Elasticsearch Data from Cloud Applications

At this point, you have a direct connection to live Elasticsearch data from Axios. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Axios, refer to our Connect Cloud page.

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial