Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
plombard committed Jul 8, 2013
1 parent 50adabb commit 2606d8f
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ After downloading the sources, run the task `mvn package`.

Use the elasticsearch plugin manager to install the plugin :

$ /path-to/elasticsearch/bin/plugin -url file:./target/release/elasticsearch-river-subversion-0.2.0.zip -install river-subversion
$ /path-to/elasticsearch/bin/plugin -url file:./target/release/elasticsearch-river-subversion-0.2.1.zip -install river-subversion

### Creating a Subversion river ###
Just create a new river of type "svn" and give it at least a repository (only local file at the moment) and a path to index ("/" for the entire repos) :
Expand All @@ -26,8 +26,13 @@ Just create a new river of type "svn" and give it at least a repository (only lo
### Data indexed ###
For the moment the river indexes only a few metadatas from svn, mainly the file content (I wrote it for full-text searches) :
**path**, **name**, **author**, **repository**, **revision**, **date**, **size**, **message** and **content**.

Fields **from** and **origin** are respectively the revision and path of origin of the change, like when a tag is created from the trunk.

Please be aware that the mapping did change from the previous version, as the indexing of revisions is now preferred to the indexing of single documents.

### Performance ###
Be very careful not to be too greedy with the bulk size and update rate parameters, as the retrieving of revisions can have a high memory consumption, and the indexing itself is very CPU-intensive.

## Credits ##

Expand Down

0 comments on commit 2606d8f

Please sign in to comment.