https://github.com/hsen-dev/vscode-elastic

Elasticsearch for VSCode
https://github.com/hsen-dev/vscode-elastic

elasticsearch elasticsearch-client visual-studio-code vscode vscode-extension

Last synced: 26 days ago
JSON representation

Elasticsearch for VSCode

• Host: GitHub
• URL: https://github.com/hsen-dev/vscode-elastic
• Owner: hsen-dev
• License: unlicense
• Created: 2017-10-11T02:49:30.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-23T17:02:38.000Z (almost 2 years ago)
• Last Synced: 2024-06-26T11:35:21.107Z (6 months ago)
• Topics: elasticsearch, elasticsearch-client, visual-studio-code, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=ria.elastic
• Size: 1.77 MB
• Stars: 164
• Watchers: 14
• Forks: 26
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-elasticsearch - Elastic for Visual Studio Code
• elasticsearch-collection - Elastic for Visual Studio Code

README

        
## Elasticsearch for VSCode

[![.github/workflows/runTests.yaml](/../../actions/workflows/runTests.yaml/badge.svg)](/../../actions/workflows/runTests.yaml)

[![.github/workflows/publish.yaml](/../../actions/workflows/publish.yaml/badge.svg)](/../../actions/workflows/publish.yaml)

Welcome to Elasticsearch for VSCode! An extension for developing elasticsearch queries.

![shot](shots/all.gif)

## Using

-   Open an existing file with a `.es` file extenion or open a new text file (`ctrl+n`) and change the language mode to `Elasticsearch (es)` by pressing `ctrl+k,m` and select `es`. Elasticsearch queries and funtionalities are enabled in the es language mode in Visual Studio Code editor.

-   For https endpoints, just add protocol type in url : `https://host`

-   For auth protected clusters, you can use `http://user:pass@host:9200` as the endpoint url to have it auth.

### Submit requests

Simple way:

```text

GET /my-index/_search

{

    "size":7,

    "query": {

        "match" : {

            "message" : {

                "query" : "this is a test"

            }

        }

    }

}

```

Get payload from file [[#4](https://github.com/hsen-dev/vscode-elastic/issues/4)]:

```text

PUT /my-index

!./opt/elasticsearch/mapping.json

```

## Commands

-   **Elasticsearch: Set Host** to create connection profile and connect.

## Keymaps

-   **Alt + Enter** / **Ctrl + Enter** to execute selected query.

## Roadmap

-   Work with multi host

-   User Authentication

-   IntelliSense like kibana autocomplete