Console enables you to interact with the REST API of Elasticsearch. Console has two main areas:
- Editor, where you compose requests to send to Elasticsearch.
- Response pane, which displays the responses to the request. See Response View.
There are three ways to open console:
Double-click item in Elasticsearch tool window. The console will be opened with the request and cluster connection associated with this item. In this case, the console doesn’t save the state. After IDE restart it will be closed and requests in the editor will be lost.
Select the cluster and click the Jump to Query Console button or press ⇧ ⌘ F10. In the popup select what console to open.
In this case the opened console is persistent, the requests in the editor will be saved after IDE restart or closing console.
The list of all saved consoles can be viewed in Project -> Scratches and Consoles -> Elasticsearch Consoles
Each console of this type is associated with one cluster connection that cannot be changed.
From the main menu, select File | New | Scratch File or press ⇧ ⌘ N. Select Elasticsearch file type.
In this case the opened console is also persistent. Scratch files are automatically numbered and saved to the Project -> Scratches and Consoles.
Scratch file console has no associated cluster connection. It must be selected on the console toolbar.
To be able to execute request console must be connected to Elasticsearch. You can see connection associated to this console and its status on the toolbar.
For scratch Elasticsearch files you must select the connection from the popup list.
Press Refresh button to reconnect to Elasticsearch.
Console editor can have many requests. To select the request that you want to execute put the cursor at the request path or body. The color frame shows the selected request. If there is only one request you don’t need to select it. To execute request click or press ⌃ ⏎.
Controls on the toolbar
|⌃ ⏎||Execute the selected request.|
|⌘ P||Switch between showing Only Editor / Only Response View.|
|⌥ ⌘ P||Switch between vertical / horizontal orientation of editor and response view.|
|F3||Open Add to Favorites dialog. See Favorite requests.|
|⌥ ⌘ E||Open Requests History dialog. See Requests history.|
|Connection associated with this console.|