The first place to start when learning syntax and the purpose of
commands within the Solr script is by appending
-help after the command. See below for
The solr help command has two purposes. It can be used to find general
help on the
solr script itself and
also to find usage, syntax and options for each of the commands within
solr script. There are 12 commands
solr script; however, you
can access help for 10 of the 12 commands.
There are two ways to find help with the
solr script for general help and for
command-specific help. This assumes your current working directory is
the $SOLR_HOME directory for Solr, which for version 7
would be in
standalone mode for a local installation. When running in a production
environment the directory locations may differ.
So the path to the location of the solr script is:
solr script can be run using the
./solr from within
When using a Solr Windows installation the solr script is called using
To find general help on the
script, including a list of the 12 commands, append
help after a space from the
Output from this general help lists all 12 commands. (The * notes where command-specific help is not available).
To find command-specific help append
-help after the command name.
Where COMMAND is one of 10 commands. See below.
For each of the following 10 commands within the
bin/solr script append
-help after each command. The
bin/solr status and
bin/solr version commands do not
||Start Solr with settings such as foreground or background, cloud or standalone mode, ports, directories, example data sets and memory allocations.|
||Stop Solr instances by key, port or all.|
||Restart Solr with settings similar to the start command.|
||Report health measures on collections or hosts.|
||Create a core in standalone mode or a collection in SolrCloud mode with settings for name, directory, configurations, shards, replication and ports.|
||Create a core in standalone mode with settings for naming the core, configurations and ports.|
||Create a collection in SolrCloud mode with settings for naming the collection and setting configurations, shards, replicas and ports.|
||Delete a core or collection with settings for configurations and ports.|
||Manage the zookeeper with options for copying, removing, moving, listing and creating directories and managing nodes.|
||Set the authentication type to use basic authentication or Kerberos including configurations and prompts.|
To print syntax and help for the
bin/solr command append
help without a dash.
Under Usage is the syntax for entering commands using
solr COMMAND OPTIONS format.
To print options for the
To print help and syntax for the
bin/solr healthcheck command append
FactorPad offers Apache Solr Search content in both tutorials and reference.
Subscribe here for more free learning content on our YouTube Channel.