バックアップと復元

バックアップが作成されるパス。パスが絶対パスでない場合、バックアップパスはSolrのインスタンスディレクトリからの相対パスになります。

スナップショットはsnapshot.<name>という名前のディレクトリに作成されます。名前が指定されていない場合、ディレクトリ名はsnapshot.<_yyyyMMddHHmmssSSS_>という形式になります。

保持するバックアップの数。solrconfig.xmlのレプリケーションハンドラーでmaxNumberOfBackupsが指定されている場合、常にmaxNumberOfBackupsが使用され、numberToKeepを使用しようとするとエラーが発生します。また、バックアップ名が指定されている場合、このパラメータは考慮されません。maxNumberOfBackupsの詳細については、レプリケーションハンドラーの設定のセクションを参照してください。

バックアップに使用するリポジトリの名前。リポジトリが指定されていない場合、ローカルファイルシステムリポジトリが自動的に使用されます。

CREATESNAPSHOTコマンドを使用してスナップショットを作成したときに使用されたコミットの名前。

バックアップスナップショットファイルの場所。指定されていない場合は、Solrのデータディレクトリでバックアップを探します。

リストアするバックアップインデックススナップショットの名前。名前が提供されていない場合、snapshot.<タイムスタンプ>形式のバックアップが場所ディレクトリ内で検索されます。その場合は、最新のタイムスタンプのバックアップが選択されます。

バックアップに使用するリポジトリの名前。リポジトリが指定されていない場合、ローカルファイルシステムリポジトリが自動的に使用されます。

非同期で処理されるこのアクションを追跡するためのリクエストID。

非同期で処理されるこのアクションを追跡するためのリクエストID。

非同期で処理されるこのアクションを追跡するためのリクエストID。

バックアップの保存と取得に使用する（Solrからローカルでアクセス可能な）有効なファイルパス。ユーザーがバックアップまたはリストアAPIコマンドでlocationパラメータを提供しない場合のフォールバックとして使用されます。

HDFSとの間でデータを転送するために使用されるバッファのサイズ（バイト単位）。メモリが許容される範囲で、より大きなバッファを使用すると、スループットが向上する場合があります。

hdfs://<ホスト>:<ポート>/<hdfsBaseFilePath>形式のHDFS URI。これにより、Solrはバックアップファイルを保存（または取得）するHDFSクラスターを指します。

HDFSにファイルを作成するときに使用されるパーミッションumask。

バックアップの保存と取得に使用する、HDFSクラスター上の有効なディレクトリパス。ユーザーがバックアップまたはリストアAPIコマンドでlocationパラメータを提供しない場合のフォールバックとして使用されます。

すべてのバックアップファイルの読み書きに使用するGCSバケット。指定されていない場合、GCSBackupRepositoryはGCS_BUCKET環境変数の値を使用します。両方の値がない場合、デフォルトとして値solrBackupsBucketが使用されます。

ローカルファイルシステム上のパスで、Solr からアクセス可能なGoogle Cloud サービスアカウントキーファイルへのパスです。指定しない場合、GCSBackupRepository は GCS_CREDENTIAL_PATH 環境変数の値を使用します。両方の値がなく、Solr が GCP 内で実行されている場合、GCS クライアントは GCP の「Compute Engine メタデータサーバー」またはWorkload Identity機能を使用して認証を試みます。両方の値がなく、Solr が GCP の外部で実行されている場合、認証できず、バックアップまたは復元操作は失敗します。

バックアップの保存と取得に使用する、指定された GCS バケット内の有効な「ディレクトリ」パスです。（GCS はフラットなストレージモデルを使用しますが、Solr のバックアップ機能は、階層的なディレクトリストレージを近似する方法で BLOB に名前を付けます。）ユーザーが Backup または Restore API コマンドで location パラメータを指定しない場合のフォールバックとして使用されます。

GCS にデータを送信するときに使用するバッファサイズ（バイト単位）。

GCS からデータをコピーするときに使用するバッファサイズ（バイト単位）。

GCS クライアントによって行われるすべての HTTP リクエストの接続タイムアウト（ミリ秒単位）。0 を使用して無限タイムアウトを要求できます。負の整数または値をまったく指定しない場合、デフォルト値が使用されます。

確立された接続でデータを読み取るための読み取りタイムアウト（ミリ秒単位）。0 を使用して無限タイムアウトを要求できます。負の整数または値をまったく指定しない場合、デフォルト値が使用されます。

操作が失敗した場合に再試行する最大回数。GCS クライアントは、この値に達するか、すべてのアテンプトで費やされた時間が gcsClientMaxRequestTimeoutMillis を超えるまで操作を再試行します。0 を使用して、再試行しないように指定できます。

失敗した操作のすべての再試行に費やす最大時間。GCS クライアントは、このタイムアウトに達するか、gcsClientMaxRetries の試行が失敗するまで操作を再試行します。

失敗した HTTP リクエストの最初の再試行までの遅延時間（ミリ秒単位）。この値は、後続の再試行にも影響します。詳細については、以下の gcsClientHttpRetryDelayMultiplier の説明を参照してください。gcsClientMaxRetries が 0 の場合、再試行は試行されないため、このプロパティは無視されます。

失敗した HTTP リクエストの連続する各再試行間の遅延をスケーリングするために使用される浮動小数点乗数。この数値が大きいほど、再試行遅延がより迅速に複合化およびスケーリングされます。

Under the covers, the GSC client uses an exponential backoff strategy between retries, governed by the formula: . The first retry will have a delay of , the second a delay of , the third a delay of , and so on.

指定しない場合、デフォルトで値 1.0 が使用され、各再試行試行の間で gcsClientHttpInitialRetryDelayMillis が使用されることが保証されます。

失敗した HTTP リクエストの再試行試行間の最大遅延時間（ミリ秒単位）。これは、多くの場合、複数回試行すると発生する再試行遅延の指数関数的な増加を制限するために使用されます。この最大値が適用されない場合の各遅延の計算方法の詳細については、上記の gcsClientHttpRetryDelayMultiplier の説明を参照してください。

タイムアウトする前に RPC リクエストを待機する時間（ミリ秒単位）。この値は、後続の再試行にも影響します。詳細については、以下の gcsClientRpcTimeoutMultiplier の説明を参照してください。gcsClientMaxRetries が 0 の場合、再試行は試行されないため、このプロパティは無視されます。

失敗した RPC リクエストの連続する各アテンプトでのタイムアウトをスケーリングするために使用される浮動小数点乗数。この数値が大きいほど、タイムアウトがより迅速に複合化およびスケーリングされます。

Under the covers, the GSC client uses an exponential backoff strategy for RPC timeouts, governed by the formula: . The first retry will have a delay of , the second a delay of , the third a delay of , and so on.

指定しない場合、デフォルトで値 1.0 が使用され、各 RPC アテンプトで gcsClientRpcInitialTimeoutMillis が使用されることが保証されます。

失敗した RPC リクエストの再試行アテンプトの最大タイムアウト（ミリ秒単位）。これは、多くの場合、複数回試行すると発生するタイムアウトの指数関数的な増加を制限するために使用されます。この最大値が適用されない場合の各タイムアウトの計算方法の詳細については、上記の gcsClientRpcTimeoutMultiplier の説明を参照してください。

すべてのバックアップファイルを読み書きする S3 バケット。S3_BUCKET_NAME 環境変数を設定することで上書きできます。

構成ファイルから AWS 設定をロードするプロファイル。プロファイルを使用すると、複数の S3 リポジトリに対して独立した設定が可能になります。AWS_PROFILE 環境変数または -Daws.profile システムプロパティを設定することで上書きできます。プロファイルごとの構成設定の詳細については、AWS Java SDK ドキュメントを参照してください。

バケットがプロビジョニングされている有効な Amazon S3 リージョン文字列。このバケットに対する読み取りおよび書き込み権限が必要です。リージョンの完全なリストについては、S3 ドキュメントを参照してください。S3_REGION 環境変数を設定するか、AWS 構成ファイルでリージョンを設定することで上書きできます。

明示的な S3 エンドポイント。AWS S3 を使用する通常の操作では必要ありません（S3 クライアントは s3.region からエンドポイントを推測できます）。このパラメータは、モック S3 フレームワークを使用し、S3Mock を使用する場合など、S3 リクエストがルーティングされる場所を明示的にオーバーライドする場合に役立ちます。S3_ENDPOINT 環境変数を設定することで上書きできます。

必要に応じて、S3 クライアントがリクエストをルーティングするプロキシ URL。URL には <スキーム>://<ホスト名>:<ポート> を含める必要があります。ただし、ポートとスキームは、存在しない場合は*推測される可能性があります*。

使用する場合、これは設定されているシステムプロキシ設定を上書きします。s3.proxy.useSystemSettings オプションを無効にする必要はありません。プロキシの username、password、または nonProxyHosts を使用する必要がある場合は、以下に示すシステムプロパティを使用してください。

デフォルトでは、S3 サーバーと通信するときにシステムプロキシ設定が設定されている場合は、それを使用します。サポートされているプロキシシステムプロパティは次のとおりです。

すべての S3 操作の再試行を無効にします。これは推奨されません。