commit | 22b151c624aaab18b6a2c12e6c382ff773fd5b1e | [log] [tgz] |
---|---|---|
author | Adrien Grand <jpountz@gmail.com> | Tue Jun 09 09:59:14 2020 +0200 |
committer | Ishan Chattopadhyaya <ishan@apache.org> | Fri Sep 04 13:36:40 2020 +0530 |
tree | 84cadddb293881fe37de53d98f79f176056b845e | |
parent | 6039a0e504b1a9feca3e66e38ecedc2be968d39f [diff] |
LUCENE-9148: Move the BKD index to its own file. (#1475) Conflicts: lucene/backward-codecs/src/java/org/apache/lucene/codecs/lucene84/package-info.java lucene/backward-codecs/src/test/org/apache/lucene/codecs/lucene60/Lucene60RWPointsFormat.java solr/solrj/src/java/org/apache/solr/common/params/QoSParams.java
Apache Lucene is a high-performance, full featured text search engine library written in Java.
Apache Solr is an enterprise search platform written using Apache Lucene. Major features include full-text search, index replication and sharding, and result faceting and highlighting.
This README file only contains basic setup instructions. For more comprehensive documentation, visit:
(You do not need to do this if you downloaded a pre-built package)
Lucene and Solr are built using Apache Ant. To build Lucene and Solr, run:
ant compile
If you see an error about Ivy missing while invoking Ant (e.g., .ant/lib does not exist
), run ant ivy-bootstrap
and retry.
Sometimes you may face issues with Ivy (e.g., an incompletely downloaded artifact). Cleaning up the Ivy cache and retrying is a workaround for most of such issues:
rm -rf ~/.ivy2/cache
The Solr server can then be packaged and prepared for startup by running the following command from the solr/
directory:
ant server
There is ongoing work (see LUCENE-9077) to switch the legacy ant-based build system to gradle. Please give it a try!
At the moment of writing, the gradle build requires precisely Java 11 (it may or may not work with newer Java versions).
To build Lucene and Solr, run (./
can be omitted on Windows):
./gradlew assemble
The command above also packages a full distribution of Solr server; the package can be located at:
solr/packaging/build/solr-*
Note that the gradle build does not create or copy binaries throughout the source repository (like ant build does) so you need to switch to the packaging output folder above; the rest of the instructions below remain identical.
After building Solr, the server can be started using the bin/solr
control scripts. Solr can be run in either standalone or distributed (SolrCloud mode).
To run Solr in standalone mode, run the following command from the solr/
directory:
bin/solr start
To run Solr in SolrCloud mode, run the following command from the solr/
directory:
bin/solr start -c
The bin/solr
control script allows heavy modification of the started Solr. Common options are described in some detail in solr/README.txt. For an exhaustive treatment of options, run bin/solr start -h
from the solr/
directory.
Ant can be used to generate project files compatible with most common IDEs. Run the ant command corresponding to your IDE of choice before attempting to import Lucene/Solr.
ant eclipse
(See this for details)ant idea
(See this for details)ant netbeans
(See this for details)The standard test suite can be run with the command:
ant test
Like Solr itself, the test-running can be customized or tailored in a number or ways. For an exhaustive discussion of the options available, run:
ant test-help
Run the following command to display an extensive help for running tests with gradle:
./gradlew helpTests
Please review the Contributing to Solr Guide for information on contributing.
#solr
and #solr-dev
on freenode.net