Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Apache Lucene open-source search software
33,077 Commits 27 Branches 467 Tags 735 MiB
Java 97.7%
HTML 1%
Python 0.9%
Lex 0.3%
Go to file
Robert Muir 9dae566ee7
LUCENE-9160: add params/docs to override jvm params in gradle build, default C2 off in tests. 
Adds some build parameters to tune how tests run. There is an example
shown by "gradle helpLocalSettings"

Default C2 off in tests as it is wasteful locally and causes slowdown of
tests runs. You can override this by setting tests.jvmargs for gradle,
or args for ant.

Some crazy lucene stress tests may need to be toned down after the
change, as they may have been doing too many iterations by default...
but this is not a new problem.
 		2020-01-22 09:58:30 -05:00
.github LUCENE-8944: remove "I am authorized to contribute" wording in the Pull Request Template 2019-12-10 12:34:23 +00:00
buildSrc Move printing tests.verbose to error reporting test listener since we're already catching the output and handle it there anyway. 2020-01-08 11:38:34 +01:00
dev-tools LUCENE-8369: Remove obsolete spatial module 2020-01-16 11:22:05 -06:00
gradle LUCENE-9160: add params/docs to override jvm params in gradle build, default C2 off in tests. 2020-01-22 09:58:30 -05:00
help LUCENE-9160: add params/docs to override jvm params in gradle build, default C2 off in tests. 2020-01-22 09:58:30 -05:00
lucene LUCENE-9160: add params/docs to override jvm params in gradle build, default C2 off in tests. 2020-01-22 09:58:30 -05:00
solr SOLR-14130: Update CHANGES.txt 2020-01-22 09:52:20 -05:00
.asf.yaml LUCENE-8986: labels: remove dubious 'sql', add 'information-retrieval' 2019-10-28 10:19:13 -04:00
.gitattributes Initial gradle build layer. 2019-12-02 15:34:57 +01:00
.gitignore Generate hardware-specific defaults for gradle parallelism on the first build run (any task). Add some explanations on how to tweak local settings even further (gradlew :helpLocalSettings 2019-12-05 11:14:09 +01:00
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
README.md Add gradle-relevant readme sections. 2020-01-09 12:36:40 +01:00
build.gradle Add workaround for https://github.com/palantir/gradle-consistent-versions/issues/383 2020-01-15 11:44:21 +01:00
build.xml Update JGit for working copy checks and explicitely set nop-logging 2019-04-20 01:55:23 +02:00
gradlew Upgrade gradlew. Add environment sanity check. 2019-12-16 15:23:06 +01:00
gradlew.bat Upgrade gradlew. Add environment sanity check. 2019-12-16 15:23:06 +01:00
settings.gradle LUCENE-8369: Remove obsolete spatial module 2020-01-16 11:22:05 -06:00
versions.lock Update ICU licenses following master. 2020-01-13 08:41:40 +01:00
versions.props Add workaround for https://github.com/palantir/gradle-consistent-versions/issues/383 2020-01-15 11:44:21 +01:00

README.md

Apache Lucene and Solr

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.

Build Status Build Status

Online Documentation

This README file only contains basic setup instructions. For more comprehensive documentation, visit:

Building Lucene/Solr

(You do not need to do this if you downloaded a pre-built package)

Building with Ant

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

Building with Gradle

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.

Running Solr

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.

Development/IDEs

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.

  • Eclipse - ant eclipse (See this for details)
  • IntelliJ - ant idea (See this for details)
  • Netbeans - ant netbeans (See this for details)

Gradle build and IDE support

  • IntelliJ - IntelliJ idea can import the project out of the box. Code formatting conventions should be manually adjusted.
  • Eclipse - Not tested.
  • Netbeans - Not tested.

Running Tests

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

Gradle build and tests

Run the following command to display an extensive help for running tests with gradle:

./gradlew helpTests

Contributing

Please review the Contributing to Solr Guide for information on contributing.

Discussion and Support