Skip to main content

Elastic Search

Elasticsearch is a distributed, open-source search and analytics engine. You can store, search, and analyze huge volumes of data quickly. You can query Elasticsearch and in near real-time get back responses in a matter of a few milliseconds.

Prerequisites for Elasticsearch Integration

  1. Authentication Credentials: Obtain the necessary credentials to connect to your Elasticsearch instance. You will need the following credentials:

    • Elasticsearch username and password.
  2. Connection Details:

    • Hostname or IP address of the Elasticsearch server.
    • Port number for Elasticsearch access.
  3. Firewall and Network Configuration:

    • Configure your firewall to allow communication between your application and the Elasticsearch server.

Having these essential prerequisites in place will ensure a smooth integration of Elasticsearch with your applications, facilitating efficient data management and utilization.

Configuring Connector in DronaHQ

Configure your database category using the provided details. Validate connection with Test connection and Save settings for secure database setup.


DronaHQ can Auto fill crucial connection values like host, name, password, and more from the connector's connection string.


HostEnter the Host Domain or IP
PortEnter the Port number
Database NameEnter the Database name
UsernameEnter the Username
PasswordEnter the Password
Elastic Search with Sample details.


Advanced OptionDescription
Connection OptionsThe key and value connection options in database configuration refer to specific settings (keys) and their corresponding values that dictate how the application connects to the database
Use Dynamic Database HostDynamically determine the host for the database connection.
Use Dynamic Database Credentials Enable dynamic database credentials for secure and convenient management.
Whitelist IP Enhance security by restricting database access to specific whitelisted IP addresses.

Adding Queries

Once you have successfully configured the Elasticsearch connector, you can efficiently manage user-related operations. Follow these steps to create and manage user management queries for the Search action:

  1. Query Name: Assign a unique name to your user management query. This name will serve as an identifier within your Connector Library for easy access.

  2. Action - Search: Within the Elasticsearch connector options, select the Search action. This action empowers you to perform customized search queries on your Elasticsearch index, allowing you to retrieve user-related data.

  3. Body Configuration: Customize the search query by configuring the body parameter. Define the search terms, filters, sorting criteria, and aggregation options within the body to tailor the query according to your user management requirements.

By following these steps, you can effectively create and manage user management queries using the Elasticsearch connector's Search action. This enables you to seamlessly retrieve and work with user-related data, enhancing your application's user management capabilities.

Add query
Add query

Utilize double curly brackets for incorporating dynamic variables. Prior to saving, test with sample values. Associate dynamic variables with controls/actions for real-time utilization. :::

Your saved queries will be visible beneath your connector within the Connector Library.

Supported Actions

searchExecute a search query.
indexIndex a document.
createCreate a document.
updateUpdate a document.
deleteDelete a document.
bulkPerform bulk operations.
clearScrollClear a scroll search context.
countCount documents matching a query.
deleteByQueryDelete documents matching a query.
deleteByQueryRethrottleRethrottle a delete-by-query request.
deleteScriptDelete a stored script.
existsCheck if a document exists.
existsSourceCheck if a document with source exists.
explainExplain a query's score.
fieldCapsRetrieve field capabilities.
getGet a document by ID.
getScriptGet a stored script.
getSourceGet the source of a document.
infoGet cluster information.
mgetRetrieve multiple documents by ID.
msearchExecute multiple searches.
msearchTemplateExecute multiple template searches.
mtermvectorsRetrieve multiple term vectors.
pingPing the Elasticsearch cluster.
putScriptCreate or update a stored script.
rankEvalExecute the ranking evaluation API.
reindexReindex documents.
reindexRethrottleRethrottle a reindex request.
renderSearchTemplateRender a search template.
scriptsPainlessExecuteExecute a Painless script.
scrollScroll through search results.
searchShardsRetrieve search shard information.
searchTemplateExecute a search template.
termvectorsRetrieve term vectors.
updateByQueryUpdate documents matching a query.
updateByQueryRethrottleRethrottle an update-by-query request.
cat.aliasesShow index alias information.
cat.allocationShow shard allocation information.
cat.countShow count of indexed documents.
cat.fielddataShow field data statistics.
cat.healthShow cluster health information.
cat.helpShow help for the Cat APIs.
cat.indicesShow index information.
cat.masterShow master node information.
cat.nodeattrsShow node attributes.
cat.nodesShow node information.
cat.pendingTasksShow pending cluster tasks.
cat.pluginsShow installed plugins.
cat.recoveryShow shard recovery information.
cat.repositoriesShow snapshot repository information.
cat.segmentsShow segment information.
cat.shardsShow shard information.
cat.snapshotsShow snapshot information.
cat.tasksShow currently executing cluster tasks.
cat.templatesShow index templates.
cat.threadPoolShow thread pool information.
cluster.allocationExplainExplain shard allocation.
cluster.getSettingsGet cluster settings.
cluster.healthGet cluster health.
cluster.pendingTasksShow pending cluster tasks.
cluster.putSettingsUpdate cluster settings.
cluster.remoteInfoShow remote cluster information.
cluster.rerouteReroute cluster.
cluster.stateGet cluster state.
cluster.statsGet cluster statistics.
indices.analyzeAnalyze text.
indices.clearCacheClear cache.
indices.cloneClone index.
indices.closeClose index.
indices.createCreate index.
indices.deleteDelete index.
indices.deleteAliasDelete index alias.
indices.deleteTemplateDelete index template.
indices.existsCheck if index exists.
indices.existsAliasCheck if index alias exists.
indices.existsTemplateCheck if index template exists.
indices.existsTypeCheck if index type exists.
indices.flushFlush index.
indices.flushSyncedFlush sync.
indices.forcemergeForce merge.
indices.getGet index.
indices.getAliasGet index alias.

Using Elastic Search Connector

Search and Retrieve Data

  1. Access Data Management Section or Control Action:

    • Navigate to the data management section or the control action where you want to retrieve data using the Elastic Search Connector.
  2. Select Elastic Search Connector:

    • Choose the Elastic Search Connector from your available options.

    • Opt for the "Search" action to query and retrieve data from your Elasticsearch index.

      Elastic Search Search action
      Elastic Search Search action
  3. Configure Search Query:

    • Define your search query using the Elasticsearch Query DSL (Domain Specific Language).
    • Customize filters, sorting, aggregations, and other query parameters as needed.
  4. Execute the Action Flow:

    • Configure the Connector within the Action Flow or Server Side actions.
    • Trigger the search action based on user interaction or automation triggers.
  5. Process and Display Results:

    • Upon receiving the search results, process the data using scripting or transformations if required.
    • Display the retrieved data in a table, list, or other visualizations as per your application's design.