elasticsearch-river-subversion

Subversion River plugin for Elasticsearch

License	The Apache Software License, Version 2.0
Categories	Subversion Development Tools Version Controls Search Business Logic Libraries Elasticsearch
GroupId	com.github.plombard
ArtifactId	elasticsearch-river-subversion
Last Version	0.3.5
Release Date	Aug 15, 2013
Type	jar
Description	elasticsearch-river-subversion Subversion River plugin for Elasticsearch
Project URL	https://github.com/plombard/SubversionRiver
Source Code Management	https://github.com/plombard/SubversionRiver.git

Download elasticsearch-river-subversion

Filename	Size
elasticsearch-river-subversion-0.3.5.pom
elasticsearch-river-subversion-0.3.5.zip	7 MB
elasticsearch-river-subversion-0.3.5-sources.jar	16 KB
elasticsearch-river-subversion-0.3.5-javadoc.jar	90 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.plombard/elasticsearch-river-subversion/ -->
<dependency>
    <groupId>com.github.plombard</groupId>
    <artifactId>elasticsearch-river-subversion</artifactId>
    <version>0.3.5</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.plombard/elasticsearch-river-subversion/
implementation 'com.github.plombard:elasticsearch-river-subversion:0.3.5'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.plombard/elasticsearch-river-subversion/
implementation ("com.github.plombard:elasticsearch-river-subversion:0.3.5")

Apache Buildr

'com.github.plombard:elasticsearch-river-subversion:jar:0.3.5'

Apache Ivy

<dependency org="com.github.plombard" name="elasticsearch-river-subversion" rev="0.3.5">
  <artifact name="elasticsearch-river-subversion" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.plombard', module='elasticsearch-river-subversion', version='0.3.5')
)

Scala SBT

libraryDependencies += "com.github.plombard" % "elasticsearch-river-subversion" % "0.3.5"

Leiningen

[com.github.plombard/elasticsearch-river-subversion "0.3.5"]

Dependencies

compile (5)

Group / Artifact	Type	Version
org.elasticsearch : elasticsearch	jar	0.90.3
org.tmatesoft.svnkit : svnkit	jar	1.7.8
com.google.guava : guava	jar	14.0.1
com.google.code.gson : gson	jar	2.2.2
com.github.tlrx : elasticsearch-test	jar	0.0.9

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.11

Project Modules

There are no modules declared in this project.

Subversion River for ElasticSearch

Subversion River plugin for ElasticSearch

Getting Started

Installation

Use the elasticsearch plugin manager to install the plugin :

$ /path-to/elasticsearch/bin/plugin --install com.github.plombard/elasticsearch-river-subversion/0.3.5

Creating a Subversion river

Just create a new river of type "svn" and give it at least a repository and a path to index ("/" for the entire repos) :

curl -XPUT 'localhost:9200/_river/mysvnriver/_meta' -d '{
   "type": "svn",
   "svn": {
    "repos": "file:///myRepository",
    "path":  "mySvnModule/trunk"
   }
}'

River parameters

Except "repos" and "path", there are other parameters to the creation of the river :

"login", the user to use to connect to the repository (default "anonymous")

"password", the password to use to connect to the repository (default "password")

"update_rate", in ms, the time interval between every tick of the river (default 900000, so 15 mn)

"type", if you want your subversion information to use another type for the river (default "svn")

"bulk_size", the size of the bulks sent to the indexer (default 200)

"start_revision", in long format, the starting revision for the indexing (default "1L")

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

These sources borrows heavily from :

• SVNKit examples by the folks @TMate : http://wiki.svnkit.com/Managing_Repository_With_SVNKit

• ElasticSearch plugins how-to by @jfarrell : http://jfarrell.github.com/

• ElasticSearch RSS River by @dadoonet : https://github.com/dadoonet/rssriver

• ElasticSearch Confluence River by @obazoud : https://github.com/obazoud/elasticsearch-river-confluence

• ElasticSearch Tests Helpers by @tlrx : https://github.com/tlrx/elasticsearch-test

Copyright

I put most of the code under Apache 2.0 licence.

Versions

Version
0.3.5 Aug 15, 2013