Skip to content

Commit

Permalink
Build for ES v2.0.1
Browse files Browse the repository at this point in the history
- update documentation;
  • Loading branch information
mrgambal committed Dec 4, 2015
1 parent da2aea9 commit ee4c6ae
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,26 @@ The plugin provides a capability to search across documents, written in ukrainia
The thing is, it makes you able to index not the source's words but their lemmas (lemma – canonical form of word) and also perform a lookup using different forms of the same word which will return you what you're looking for. Needless to say, the magic is being done under the hood! No more doubts like: "What if I put this word in plural? Maybe it'll finally find something?".
Each term before settling in the storage will be passed through ```UkrainianAnalyzer``` which looks in ```UkrainianLemmatizer``` if it has a lemma for the term and, in case of success, this lemma must get into index. The same sequence of actions has the place when you start a lookup over documents stored using the analyzer: it will convert your search terms according to dictionary and return results if there is any match.

## Installation
## Build the plugin

Installation of the plugin consists of only 4 steps:
Manual building of the plugin consists of only 4 steps:

### For ES version 1.7+
* Clone this repository
* Get inside the root dir of cloned repo and run ```gradle release```
* Find built artifact in ```build/distributions/```
* Import it into your ES installation with ```<path_to_es_bin_dir>/plugin --url <path_to_distribution>/elasticsearch-ukrainian-lemmatizer-1.0-SNAPSHOT.zip --install ukrainian-lemmatizer```

**Example**: ```./plugin --url file:///home/mrgambal/projects/elasticsearch-ukrainian-lemmagen/build/distributions/elasticsearch-ukrainian-lemmatizer-1.0-SNAPSHOT.zip --install ukrainian-lemmatizer```

### For ES version 2.0.0-2.0.1
* Clone this repository
* Get inside the root dir of cloned repo and run ```gradle release```
* Find built artifact in ```build/distributions/```
* Import it into your ES installation with ```<path_to_es_bin_dir>/plugin install <path_to_distribution>/elasticsearch-ukrainian-lemmatizer-<plugin_version>.zip```

**Example**: ```./plugin install file:/home/tenshi/projects/elasticsearch-ukrainian-lemmagen/build/distributions/elasticsearch-ukrainian-lemmatizer-1.1.0.zip```


## Usage

Expand Down Expand Up @@ -143,6 +152,9 @@ And here is what you'll receive:

## Requirements

* ES 1.7+
* ES
- 1.7+ (release v1.0)
- 2.0.0 (release v1.1.0)
- 2.0.1 (release v1.1.1)
* Java 8
* Gradle 2.6+
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apply plugin: 'groovy'
apply plugin: 'maven'

group = 'org.sotnya'
version = '1.1.0'
version = '1.1.1'
sourceCompatibility = '1.8'
targetCompatibility = '1.8'
String propertiesFile = './plugin-descriptor.properties'
Expand All @@ -20,11 +20,11 @@ repositories {
}

dependencies {
compile 'org.elasticsearch:elasticsearch:2.0.0'
compile 'org.elasticsearch:elasticsearch:2.0.1'
compile 'junit:junit:4.12'

testCompile 'org.apache.lucene:lucene-test-framework:5.2.1'
testCompile 'org.elasticsearch:elasticsearch:2.0.0:tests'
testCompile 'org.elasticsearch:elasticsearch:2.0.1:tests'
testCompile 'com.google.guava:guava:18.0'
testCompile 'com.carrotsearch.randomizedtesting:randomizedtesting-runner:2.3.1'
testCompile 'org.hamcrest:hamcrest-library:1.3'
Expand Down
4 changes: 2 additions & 2 deletions plugin-descriptor.properties
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name=ukrainian-lemmatizer
description=ukrainian-lemmatizer - search across documents, written in ukrainian
version=1.1.0
version=1.1.1
classname=org.elasticsearch.plugin.analysis.ukrainian_lemmatizer.UkrainianLemmatizerPlugin

jvm=true
site=false

elasticsearch.version=2.0.0
elasticsearch.version=2.0.1
java.version=1.8

0 comments on commit ee4c6ae

Please sign in to comment.