Skip to content

Commit

Permalink
Add notice to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rzezeski committed Jul 24, 2012
1 parent 50ff481 commit 8c1a606
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 26 deletions.
8 changes: 8 additions & 0 deletions IMPLEMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,12 @@ returned. Thus a `{P, [IFP1, IFP2]}` pair will be converted to
Index Mapping & Cores
----------

Solr has the notion of a [core] [solr_core] which allows multiple
indexes to live under the same Solr/JVM instance. This is useful
because it allows isolation of index files as well as schemas and
configuration. Yokozuna exposes the notion of cores as _indexes_.
Each index has a unique name and maps to **one** core.

* Set `persistent` to `true` in `solr.xml` so that changes during
runtime will persist on restart.

Expand Down Expand Up @@ -208,3 +214,5 @@ Index Mapping & Cores


[rdd]: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html

[solr_core]: http://wiki.apache.org/solr/CoreAdmin
32 changes: 6 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,15 @@
Yokozuna
==========

**NOTICE:** This is an experiment and prototype. The copyright is
owned by Basho but is not an official repository. Currently, this is
a side project of the author and not supported in any way by Basho.

**USE AT YOUR OWN RISK**

_Yokozuna_ - Horizontal rope. The top rank in sumo, usually
translated _Grand Champion_. The name comes from the rope a yokozuna
wears.

The goal of the yokozuna application is to integrate Apache Solr with
Riak in order to find the "top rank" documents for a given query.


Index Mappings & Cores
----------

Solr has the notion of a [core] [solr_core] which allows multiple
indexes to live under the same Solr/JVM instance. This is useful
because it allows isolation of index files as well as schemas and
configuration. Yokozuna exposes the notion of cores as _indexes_.

Each index has a unique name and maps to **one** core. However, there
is a second mapping from alias to index name. Many aliases may exist
for a given index. This allows a decoupling of external names and
index names. For example, when integrating with Riak this allows the
index name to be separate from the bucket name and thus allows many
buckets to map to the same index.

<TODO: insert diagram here of mapping from external app name, to
unique index name, to Solr core>

### Riak Integration

When indexing a Riak object yokozuna will use the bucket name to
look-up the index name.

[solr_core]: http://wiki.apache.org/solr/CoreAdmin

0 comments on commit 8c1a606

Please sign in to comment.