https://github.com/metabrainz/mbsssss
MusicBrainz simple Solr search server schema
https://github.com/metabrainz/mbsssss
musicbrainz python schema solr
Last synced: 2 months ago
JSON representation
MusicBrainz simple Solr search server schema
- Host: GitHub
- URL: https://github.com/metabrainz/mbsssss
- Owner: metabrainz
- Created: 2014-03-15T15:46:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-18T20:24:01.000Z (5 months ago)
- Last Synced: 2025-05-18T21:22:49.846Z (5 months ago)
- Topics: musicbrainz, python, schema, solr
- Language: Python
- Size: 1.38 MB
- Stars: 4
- Watchers: 12
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MusicBrainz Simple Solr Search Server Schema #
This repository includes schema definitions for several Solr cores - 1 for each
entity type in MusicBrainz.
[The Solr Reference Guide](https://cwiki.apache.org/confluence/display/solr/Documents%2C+Fields%2C+and+Schema+Design)
contains more information about how these work.
Note that this repository uses the
[core discovery](https://cwiki.apache.org/confluence/display/solr/Solr+Cores+and+solr.xml)
mechanism of Solr 5. It will not work with all versions of Solr 4.
## Adding the MusicBrainz Query Response Writer
To run a Solr server with the cores definied in this repository, you first need
to install
[the MusicBrainz QueryResponseWriter](https://github.com/metabrainz/mb-solr)
and place the resulting file called
mb-solr-0.0.1-SNAPSHOT-jar-with-dependencies.jar into the `mbsssss/lib`
folder, which is configured as the Solr server's **sharedLib** folder.
## Running a Solr server with these cores
If you haven't already, download Solr from its
[website](https://lucene.apache.org/solr/mirrors-solr-latest-redir.html) and
extract the archive.
You will now have a solr-x.x.x folder (where x.x.x is Solrs version number).
Inside this folder, there's a `bin` folder containing scripts to start a Solr
server. You can use those to start a Solr server which knows the cores in this
repository with the following command:
> /path/to/solr-x.x.x/bin/solr -f -s /path/to/this/repository
## Defining a new core
Defining a new core requires following these steps:
1. Create a config directory for it, based on the template directory
(`cp -r _template $corename && mv $corename/_conf $corename/conf`)
2. Create an empty `core.properties` file in the cores directory
(`touch $corename/core.properties`).
3. Symlink the `fieldtypes.xml` file from the `common` folder into the new
configuration folder (`pushd $corename/conf && ln -s ../../common/fieldtypes.xml
. && popd`). This file includes the fieldtype definitions that all cores have
in common.
4. Edit the `solrconfig.xml` and `schema.xml` file in the configuration folder
according to your needs.
## Generating mediawiki tables for the documentation
The file `searchfields.py` is a script that generates Mediawiki tables to
document the cores and all their search fields. Simply running it like
> python searchfields.py
prints that markup to standard output. You can either redirect it to a file:
> python searchfields.py > searchfields.txt
or copy it directly to the clipboard:
> python searchfields.py | xclip
## Linting files
To insure that the XML files are properly indented, use tidy.
If you are on Ubuntu, simply install tidy via
> sudo apt-get install tidy
To use it, run
> tidy -xml -im -w 120 **xml