Giter VIP home page Giter VIP logo

elasticsearch-plugin-archetype's Introduction

Elasticsearch Plugin Archetype

Overview

This project (elasticsearch-plugin-archetype) provides Maven archetype for Elasticsearch plugin. You can easily create your elasticsearch plugin by this archetype.

Version

Version elasticsearch
master 6.6.X
6.6.0 6.6.1
2.3.0 2.3.3
1.5.0 1.5.2
1.4.0 1.4.0.Beta1
1.3.0 1.3.0
1.2.0 1.2.1
1.1.0 1.0.0.RC2
1.0.0 0.90.5

Issues/Questions

Please file an issue.

Usage

Using archetype:generate goal of Maven, run the following command:

$ mvn archetype:generate \
    -DarchetypeGroupId=org.codelibs \
    -DarchetypeArtifactId=elasticsearch-plugin-archetype \
    -DarchetypeVersion=6.6.0 \
    -DelasticsearchVersion=6.6.1 \
    -DgroupId=<Your groupId> \
    -DartifactId=<your artifactId> \
    -Dversion=<your version> \
    -DpluginName=<your plugin name> \
    -DrestName=<your rest API name>

Properties description is below:

Property Name Description Example
elasticsearchVersion Elasticsearch version 6.6.1
groupId Project's groupId com.example
artifactId Project's artifactid elasticsearch-hello
version Project's version 1.0-SNAPSHOT
pluginName Plugin class name Hello
restName Rest API name hello

elasticsearchVersion and restName are optional.

For example, the command is below:

$ mvn archetype:generate \
    -DarchetypeGroupId=org.codelibs \
    -DarchetypeArtifactId=elasticsearch-plugin-archetype \
    -DarchetypeVersion=6.6.0 \
    -DgroupId=com.example \
    -DartifactId=elasticsearch-hello \
    -Dversion=1.0-SNAPSHOT \
    -DpluginName=Hello 

Create Rest API

A class file for Rest API is Rest<pluginName>Action. You can put your code into Rest<pluginName>Action. The urls to access to Rest<pluginName>Action are:

http://localhost:9200/{index}/_<restName>

The definistion is in a constructor of Rest<pluginName>Action.

elasticsearch-plugin-archetype's People

Contributors

marevol avatar deka0106 avatar

Stargazers

X+ avatar Kealdish avatar Yasuhiro Kunimoto avatar Timothy Berkeley avatar  avatar Pavel Bekkerman avatar

Watchers

Ming-der Wang avatar Tetsuya Hasegawa avatar James Cloos avatar  avatar  avatar  avatar  avatar  avatar Matsutani Kenji avatar Koki I. avatar  avatar

elasticsearch-plugin-archetype's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.