Solr制御スクリプトのリファレンス

`-X` で始まるパラメータなど、追加のJVMパラメータを使用してSolrを起動します。たとえば、Solr JVMに接続するJavaデバッガーを設定するには、 `-a "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=18983"` を渡すことができます。ほとんどの場合、追加のパラメータは二重引用符で囲む必要があります。

`-D` で始まるJVMパラメータを渡す場合は、 `-a` オプションを省略できます。

例:

Solrの起動時にJettyに渡す追加パラメータ。たとえば、Jettyが読み取る設定フォルダを追加するには、 `-j "--include-jetty-dir=/etc/jetty/custom/server/"` を渡すことができます。ほとんどの場合、追加のパラメータは二重引用符で囲む必要があります。

SolrをSolrCloudモードで起動します。これにより、Solrに含まれる組み込みZooKeeperインスタンスも起動されます。組み込みZooKeeperインスタンスは、Solrのポート+1000で起動されます。Solrが8983にバインドされている場合は9983になります。

組み込みの（シングルノード）ZooKeeperの代わりに使用したいZooKeeperアンサンブルが既に実行されている場合は、solr.in.sh/solr.in.cmdでZK_HOSTを指定するか（Solrインクルードファイルの更新を参照）、-zパラメーターを渡す必要があります。

詳細については、以下のSolrCloudモードセクションを参照してください。

例： bin/solr start -c

サーバーディレクトリを定義します。デフォルトはserverです（$SOLR_TIP/serverなど）。このオプションをオーバーライドすることはまれです。同じホストでSolrの複数のインスタンスを実行する場合、各インスタンスで同じサーバーディレクトリを使用し、-sオプションを使用して一意のSolrホームディレクトリを使用するのが一般的です。

例： bin/solr start -d newServerDir

Solrをサンプル設定で起動します。これらのサンプルは、Solrをより早く使い始めるため、または特定の機能を試すために提供されています。

使用可能なオプションは次のとおりです。

Solrをフォアグラウンドで起動し、stdout / stderrをsolr-PORT-console.logに送信します。 -eオプションでサンプルを実行する場合、このオプションは使用できません。

例： bin/solr start -f

このSolrインスタンスのホスト名を指定します。指定しない場合は、localhostと見なされます。

例： bin/solr start -h search.mysolr.com

Solrを実行するJVMの最小（-Xms）および最大（-Xmx）ヒープサイズを設定します。

例： bin/solr start -m 4g は、-Xms4g -Xmx4g 設定になります。

入力を求めません。ユーザー入力を許可するサンプルを実行するときは、すべてのデフォルトを受け入れます。

たとえば、「cloud」サンプルを使用する場合、インタラクティブセッションでは、SolrCloudクラスタのいくつかのオプションを選択するようにガイドされます。すべてのデフォルトを受け入れる場合は、リクエストに-nopromptオプションを追加するだけです。

例： bin/solr start -e cloud -noprompt

Solr HTTPリスナーを起動するポートを指定します。Solrの従来のデフォルトポートは8983です。指定されたポート（SOLR_PORT）は、停止ポートの決定にも使用されます。停止ポートはSTOP_PORT=($SOLR_PORT-1000)として定義され、JMX RMIリスンポートはRMI_PORT=($SOLR_PORT+10000)として定義されます。たとえば、-p 8985を設定すると、STOP_PORT=7985、RMI_PORT=18985になります。指定しない場合は、8983が使用されます。

例： bin/solr start -p 8655

solr.solr.homeシステムプロパティを設定します。Solrはこのディレクトリの下にコアディレクトリを作成します。これにより、-dパラメーターを使用して設定された同じサーバーディレクトリを再利用しながら、同じホストで複数のSolrインスタンスを実行できます。設定されている場合、指定されたディレクトリには、solr.xmlがZookeeperに存在しない限り、solr.xmlファイルが含まれている必要があります。

サンプル（-e）を実行する場合、solr.solr.homeは実行されるサンプルによって異なるため、このパラメーターは無視されます。

デフォルト値はserver/solrです。相対ディレクトリを渡すと、デフォルトのserver/<dir>を試す前に、現在のディレクトリで検証が行われます。

例： bin/solr start -s newHome

solr.data.homeシステムプロパティを設定します。Solrは、<instance_dir>/dataサブディレクトリにインデックスデータを格納します。設定されていない場合、Solrは設定とデータにsolr.solr.homeを使用します。

より詳細な情報を表示します。これは、SolrのLog4jのログレベルをINFOからDEBUGに変更します。これは、log4j2.xmlを編集した場合と同じ効果があります。

例： bin/solr start -f -v

より静かにします。これは、SolrのLog4jのログレベルをINFOからWARNに変更します。これは、log4j2.xmlを編集した場合と同じ効果があります。これは、ログを警告とエラーに限定したい本番環境で役立ちます。

例： bin/solr start -f -q

このスクリプトからの詳細メッセージ。

例： bin/solr start -V

Zookeeper接続文字列。このオプションは、-cオプションと組み合わせてSolrをSolrCloudモードで起動する場合にのみ使用されます。 solr.in.sh/solr.in.cmdでZK_HOSTが指定されておらず、このオプションが提供されていない場合、Solrは組み込みZooKeeperインスタンスを起動し、SolrCloud操作にそのインスタンスを使用します。

ZKホストにchrootパスがあり、それを自動的に作成する場合は、ZK_CREATE_CHROOT環境変数をtrueに設定します。

例： bin/solr start -c -z server1:2181,server2:2181

rootユーザーとしてSolrを起動しようとすると、スクリプトは「root」としてSolrを実行すると問題が発生する可能性があるという警告を出して終了します。 -forceパラメーターを使用してこの警告をオーバーライドすることができます。

例： sudo bin/solr start -force

指定されたポートで実行されているSolrを停止します。複数のインスタンスを実行している場合、またはSolrCloudモードで実行している場合は、個別のリクエストでポートを指定するか、-allオプションを使用する必要があります。

例: bin/solr stop -p 8983

このホスト上で実行中で、有効なPIDを持つすべてのSolrサーバーを検索して停止します。

例: bin/solr stop -all

Solrの意図しない停止を防ぐために使用される停止キー。デフォルトは「solrrocks」です。

例: bin/solr stop -k solrrocks

このスクリプトからの詳細なメッセージと共にSolrを停止します。

例: bin/solr stop -V

ヘルスチェックを実行するコレクションの名前。

例: bin/solr healthcheck -c gettingstarted

ベースSolr URL。SolrCloudモードで、ZooKeeper接続文字列が不明な場合に、ZooKeeper接続文字列を決定するために使用できます。

ZooKeeper接続文字列。8983以外のポートでSolrを実行している場合は、ZooKeeper接続文字列を指定する必要があります。デフォルトでは、Solrポート+ 1000になります。 solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合、このパラメータは不要です。

例: bin/solr healthcheck -z localhost:2181

作成するコアまたはコレクションの名前。

例: bin/solr create -c mycollection

設定ディレクトリ。

SolrCloudモードで実行する場合のこのオプションの詳細については、以下の設定ディレクトリとSolrCloudセクションを参照してください。

例: bin/solr create -d _default

設定名。デフォルトはコアまたはコレクションと同じ名前です。

例: bin/solr create -n basic

作成コマンドを送信するローカルSolrインスタンスのポート。デフォルトでは、スクリプトは実行中のSolrインスタンスを検索してポートを検出しようとします。

このオプションは、同じホストで複数のSolrインスタンスを実行している場合に、コアを作成するインスタンスを指定する必要がある場合に役立ちます。

例: bin/solr create -p 8983

コレクションを分割するシャードの数。SolrがSolrCloudモードで実行されている場合にのみ適用されます。

例: bin/solr create -s 2

コレクション内の各ドキュメントのコピー数。デフォルトは1（レプリケーションなし）です。

例: bin/solr create -rf 2

「root」ユーザーとしてcreateを実行しようとすると、スクリプトは、「root」としてSolrを実行したり、Solrに対してアクションを実行したりすると問題が発生する可能性があるという警告を出して終了します。 -forceパラメータを使用して、この警告をオーバーライドできます。

例: bin/solr create -c foo -force

作成するコレクションの名前。

例: bin/solr create_collection -c mycollection

新しいコレクションを作成するときにコピーする設定ディレクトリ。

SolrCloudモードで実行する場合のこのオプションの詳細（組み込みの構成例を含む）については、以下の設定ディレクトリとSolrCloudセクションを参照してください。

_defaultは、スキーマレスモードとしても知られています。

例: bin/solr create_collection -d _default

または、組み込みの構成のいずれかを使用する代わりに、独自の構成ディレクトリへのパスを渡すこともできます。

例: bin/solr create_collection -c mycoll -d /tmp/myconfig

デフォルトでは、スクリプトは、コレクション(-c)オプションと同じ名前を使用して、指定されたconfdirディレクトリをZookeeperにアップロードします。代わりに、既存のディレクトリを再利用したり、複数のコレクションで共有できるZookeeperにconfdirを作成したりする場合は、-nオプションを使用します

Zookeeperの設定ディレクトリに名前を付けます。デフォルトでは、設定はコレクション名(-c)を使用してZookeeperにアップロードされますが、既存のディレクトリを使用するか、Zookeeperの設定の名前をオーバーライドする場合は、-cオプションを使用します。うーん…​上記の行をbin / solr create_collection -h出力からコピーしましたが、わかりません。そしてbin / solr create_collection -n basic -c mycollは動作し、「basic」configsetとして_defaultのコピーを作成します…​うーん？

例: bin/solr create_collection -n basic -c mycoll

新しいコレクションを作成するローカルSolrインスタンスのポート。指定しない場合、スクリプトはローカルシステムで実行中のSolrインスタンスを検索し、最初に見つかったサーバーのポートを使用します。

このオプションは、同じホストで複数のSolrインスタンスを実行している場合に、コアを作成するインスタンスを指定する必要がある場合に役立ちます。

例: bin/solr create -p 8983

コレクションを分割するシャードの数。

例: bin/solr create_collection -s 2

コレクション内の各ドキュメントのコピー数。デフォルトは1（レプリケーションなし）です。

例: bin/solr create_collection -rf 2

「root」ユーザーとしてcreateを実行しようとすると、スクリプトは、「root」としてSolrを実行したり、Solrに対してアクションを実行したりすると問題が発生する可能性があるという警告を出して終了します。 -forceパラメータを使用して、この警告をオーバーライドできます。

例: bin/solr create_collection -c foo -force

作成するコアの名前。

例: bin/solr create -c mycore

新しいコアを作成するときに使用する設定ディレクトリ。

例: bin/solr create -d _default

または、組み込みの構成のいずれかを使用する代わりに、独自の構成ディレクトリへのパスを渡すこともできます。

例: bin/solr create_collection -c mycore -d /tmp/myconfig

新しいコアを作成するローカルSolrインスタンスのポート。デフォルトでは、スクリプトは実行中のSolrインスタンスを検索してポートを検出しようとします。

このオプションは、同じホストで複数のSolrインスタンスを実行している場合に、コアを作成するインスタンスを指定する必要がある場合に役立ちます。

例: bin/solr create -p 8983

「root」ユーザーとしてcreateを実行しようとすると、スクリプトは、「root」としてSolrを実行したり、Solrに対してアクションを実行したりすると問題が発生する可能性があるという警告を出して終了します。 -forceパラメータを使用して、この警告をオーバーライドできます。

例: bin/solr create -c foo -force

削除するコアまたはコレクションの名前。

例: bin/solr delete -c mycoll

設定ディレクトリも ZooKeeper から削除するかどうか。

設定ディレクトリが他のコレクションで使用されている場合、-deleteConfig を true として渡しても削除されません。

例: bin/solr delete -deleteConfig false

削除コマンドを送信するローカル Solr インスタンスのポート。指定しない場合、スクリプトはローカルシステムで実行中の Solr インスタンスを検索し、最初に見つかったサーバーのポートを使用します。

このオプションは、同じホストで複数の Solr インスタンスを実行している場合に、コアを削除するインスタンスを指定する必要がある場合に役立ちます。

例: bin/solr delete -p 8983

ZooKeeper内の設定セットの名前。このコマンドは、指定された名前を付けて設定セットを「configs」ZooKeeperノードにアップロードします。

アップロードされたすべての設定セットは、管理UIのクラウド画面で確認できます。クラウド → ツリー → configs を選択して表示します。

既存の設定セットが指定されている場合、ZooKeeperで上書きされます。

例: -n myconfig

アップロードする設定セットのローカルディレクトリ。その直下にconfディレクトリがあり、その中にsolrconfig.xmlなどが含まれている必要があります。

名前のみが指定されている場合、$SOLR_TIP/server/solr/configsets でこの名前がチェックされます。代わりに絶対パスを指定することもできます。

例:

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合は不要です。

例: -z 123.321.23.43:2181

ダウンロードするZooKeeper内の設定セットの名前。管理UIのクラウド → ツリー → configs ノードには、使用可能なすべての設定セットが一覧表示されます。

例: -n myconfig

ダウンロードした設定セットを書き込むパス。名前のみが指定されている場合、$SOLR_TIP/server/solr/configsets が親になります。絶対パスも指定できます。

いずれの場合も、*宛先に既存の設定がある場合は上書きされます*！

例:

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合は不要です。

例: -z 123.321.23.43:2181

<src> を <dst> に再帰的にコピーします。 <src> に子がいて、-r が指定されていない場合、コマンドは失敗します。

例: -r

コピー元のファイルまたはパス。zk: が前に付いている場合、ソースはZooKeeperであると見なされます。プレフィックスがないか、プレフィックスがfile: の場合、ローカルドライブであると見なされます。<src> または <dest> の少なくとも一方に zk: が付いていないと、コマンドは失敗します。

例:

コピー先のファイルまたはパス。zk: が前に付いている場合、ソースはZooKeeperであると見なされます。プレフィックスがないか、プレフィックスがfile: の場合、ローカルドライブであると見なされます。

<src> または <dest> の少なくとも一方に zk: が付いていないと、コマンドは失敗します。<dest> がスラッシュ文字で終わる場合、ディレクトリを指定します。

例:

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合はオプションです。

例: -z 123.321.23.43:2181

<path> がディレクトリの場合、再帰的に削除します。 <path> に子がいて、-r が指定されていない場合、コマンドは失敗します。

例: -r

ZooKeeperから削除するパス。親ノードまたはリーフノードです。

安全チェックは限られています。/ または /zookeeper ノードを削除することはできません。

パスはZooKeeperノードであると見なされます。zk:プレフィックスは必要ありません。

例:

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合はオプションです。

例: -z 123.321.23.43:2181

名前を変更するznode。zk: プレフィックスが想定されています。

例: /configs/oldconfigset

znodeの新しい名前。zk: プレフィックスが想定されています。

例: /configs/newconfigset

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合は不要です。

例: -z 123.321.23.43:2181

znodeのすべての子孫を再帰的に一覧表示します。データではなく、ノード名のみが一覧表示されます。

例: -r

一覧表示するZooKeeperのパス。

例: /collections/mycollection

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合はオプションです。

例: -z 123.321.23.43:2181

作成するZooKeeperのパス。必要に応じて、中間znodeが作成されます。存在しない場合は、先頭にスラッシュが想定されます。

例: /solr

ZooKeeper接続文字列。solr.in.shまたはsolr.in.cmdでZK_HOSTが定義されている場合はオプションです。

例: -z 123.321.23.43:2181