This document describes how to operate the Search Core software. The following topics can be found in this document:
Note: The command-line examples in this section have been broken into multiple lines for readability. The commands should be reassembled into a single line prior to execution.
Search Core can be executed in various ways. This section describes how to run the tool, as well as its behaviors and caveats.
The following table describes the command-line options available:
Command-Line Option | Description |
---|---|
-a, --all | Run Registry Extractor, Solr Indexer, and PDS Indexer. [default] |
-d, --debug | Turn on debugger. |
-e, --extractor | Run Registry Extractor. |
-h, --help | Display usage. |
-m,--query-max | Specify the maximum number of registry values to be returned from query. (Default: 999999999) |
-p, --pds-indexer | Run PDS Indexer |
-r, --registry | Specify Registry Service instance to query. (Default: http://pdsbeta.jpl.nasa.gov:8080/registry) |
-s, --solr-indexer | Run Solr Indexer |
-V, --version | Display the release number and copyright information. |
This section demonstrates execution of the tool using the command-line options. The examples below execute the tool via the batch/shell script.
The Search Core Tool requires a Search Service Home directory to be specified prior to running the tool. This path is the directory that contains the Apache Solr WAR file. The following is the format for commands:
% search-core <search-service-home-path> [options]
The following command demonstrates how to run the Search Core Tool with a SEARCH_SERVICE_HOME=/apps/search-service and the default execution to run all components:
% search-core /apps/service-service
By default, the command above will run all components of the Search Core software and produce a Solr index from the Registry Service data. To run each component separately, they must be completed in the following order:
The following command will run the Search Core Tool with a SEARCH_SERVICE_HOME=/apps/search-service and only run the Registry Extractor component:
% search-core /apps/service-service -e
The following command will run the Search Core Tool with a SEARCH_SERVICE_HOME=/apps/search-service and only run the Solr Indexer component:
% search-core /apps/service-service -s
The following command will run the Search Core Tool with a SEARCH_SERVICE_HOME=/apps/search-service and only run the PDS Indexer component:
% search-core /apps/service-service -p
The following command demonstrates how to test the Search Core Tool with a SEARCH_SERVICE_HOME=/apps/search-service and only query 1000 products for indexing:
% search-core /apps/service-service -m 1000
By default, the Search Core tool runs against the Registry Service at http://pdsbeta:8080/registry. The following command demonstrates how to run the Search Core Tool and all its components against a Registry Service installed at http://localhost:8080/registry
% search-core /apps/service-service -r http://localhost:8080/registry