forked from basho/yokozuna
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
14 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |